SimpleITK  2.0.0rc2.post21
sitkLabelMapOverlayImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18 #ifndef sitkLabelMapOverlayImageFilter_h
19 #define sitkLabelMapOverlayImageFilter_h
20 
21 /*
22  * WARNING: DO NOT EDIT THIS FILE!
23  * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24  * Please look at sitkDualImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkImageFilter.h"
31 #include "sitkBasicFilters.h"
32 
33 namespace itk {
34  namespace simple {
35 
56  public:
58 
60  virtual ~LabelMapOverlayImageFilter();
61 
65 
68 
69 \
70 
74  SITK_RETURN_SELF_TYPE_HEADER SetOpacity ( double Opacity ) { this->m_Opacity = Opacity; return *this; }
75 
79  double GetOpacity() const { return this->m_Opacity; }\
80 
83  SITK_RETURN_SELF_TYPE_HEADER SetColormap ( std::vector<unsigned char> Colormap ) { this->m_Colormap = Colormap; return *this; }
84 
87  std::vector<unsigned char> GetColormap() const { return this->m_Colormap; }
88 
90  std::string GetName() const { return std::string ("LabelMapOverlayImageFilter"); }
91 
93  std::string ToString() const;
94 
95 
98  Image Execute ( const Image & labelMapImage, const Image & featureImage );
99 
100 
101  private:
103  using MemberFunctionType = Image (Self::*)( const Image * labelMapImage, const Image * featureImage );
104 
106  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * labelMapImage, const Image * featureImage );
107 
108 
109  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
110 
111 
112 
113  /* Value assigned to pixels outside of the mask */
114  double m_Opacity{0.5};
115 
116  std::vector<unsigned char> m_Colormap{std::vector<unsigned char>()};
117 
118 
119  };
120 
131  SITKBasicFilters_EXPORT Image LabelMapOverlay ( const Image & labelMapImage, const Image & featureImage, double opacity = 0.5, std::vector<unsigned char> colormap = std::vector<unsigned char>() );
132 
134  }
135 }
136 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::LabelMapOverlayImageFilter::PixelIDTypeList
LabelPixelIDTypeList PixelIDTypeList
Definition: sitkLabelMapOverlayImageFilter.h:67
itk::simple::LabelMapOverlayImageFilter::SetOpacity
Self & SetOpacity(double Opacity)
Definition: sitkLabelMapOverlayImageFilter.h:74
itk::simple::LabelMapOverlayImageFilter::SetColormap
Self & SetColormap(std::vector< unsigned char > Colormap)
Definition: sitkLabelMapOverlayImageFilter.h:83
sitkImageFilter.h
itk::simple::LabelMapOverlayImageFilter
Apply a colormap to a label map and superimpose it on an image.
Definition: sitkLabelMapOverlayImageFilter.h:55
sitkDualMemberFunctionFactory.h
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::LabelMapOverlayImageFilter::GetColormap
std::vector< unsigned char > GetColormap() const
Definition: sitkLabelMapOverlayImageFilter.h:87
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:44
itk::simple::LabelMapOverlayImageFilter::GetOpacity
double GetOpacity() const
Definition: sitkLabelMapOverlayImageFilter.h:79
itk
itk::simple::LabelMapOverlayImageFilter::MemberFunctionType
Image(Self::*)(const Image *labelMapImage, const Image *featureImage) MemberFunctionType
Definition: sitkLabelMapOverlayImageFilter.h:103
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::LabelMapOverlayImageFilter::GetName
std::string GetName() const
Definition: sitkLabelMapOverlayImageFilter.h:90
itk::simple::LabelMapOverlay
Image LabelMapOverlay(const Image &labelMapImage, const Image &featureImage, double opacity=0.5, std::vector< unsigned char > colormap=std::vector< unsigned char >())
Apply a colormap to a label map and superimpose it on an image.
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::LabelMapOverlayImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkLabelMapOverlayImageFilter.h:109
itk::simple::LabelPixelIDTypeList
typelist::MakeTypeList< LabelPixelID< uint8_t >, LabelPixelID< uint16_t >, LabelPixelID< uint32_t > >::Type LabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:165