SimpleITK  
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::simple {
34 
55  public:
57 
59  virtual ~LabelMapOverlayImageFilter();
60 
64 
67 
68 \
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetOpacity ( double Opacity ) { this->m_Opacity = Opacity; return *this; }
74 
78  double GetOpacity() const { return this->m_Opacity; }\
79 
82  SITK_RETURN_SELF_TYPE_HEADER SetColormap ( std::vector<unsigned char> Colormap ) { this->m_Colormap = Colormap; return *this; }
83 
86  std::vector<unsigned char> GetColormap() const { return this->m_Colormap; }
87 
89  std::string GetName() const { return std::string ("LabelMapOverlayImageFilter"); }
90 
92  std::string ToString() const;
93 
94 
97  Image Execute ( const Image & labelMapImage, const Image & featureImage );
98 
99 
100  private:
102  using MemberFunctionType = Image (Self::*)( const Image * labelMapImage, const Image * featureImage );
103 
105  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * labelMapImage, const Image * featureImage );
106 
107 
108  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
109 
110 
111 
112  /* Value assigned to pixels outside of the mask */
113  double m_Opacity{0.5};
114 
115  std::vector<unsigned char> m_Colormap{std::vector<unsigned char>()};
116 
117 
118  };
119 
130  SITKBasicFilters_EXPORT Image LabelMapOverlay ( const Image & labelMapImage, const Image & featureImage, double opacity = 0.5, std::vector<unsigned char> colormap = std::vector<unsigned char>() );
131 
133 }
134 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::LabelMapOverlayImageFilter::PixelIDTypeList
LabelPixelIDTypeList PixelIDTypeList
Definition: sitkLabelMapOverlayImageFilter.h:66
itk::simple::LabelMapOverlayImageFilter::SetOpacity
Self & SetOpacity(double Opacity)
Definition: sitkLabelMapOverlayImageFilter.h:73
itk::simple::LabelMapOverlayImageFilter::SetColormap
Self & SetColormap(std::vector< unsigned char > Colormap)
Definition: sitkLabelMapOverlayImageFilter.h:82
sitkImageFilter.h
itk::simple::LabelMapOverlayImageFilter
Apply a colormap to a label map and superimpose it on an image.
Definition: sitkLabelMapOverlayImageFilter.h:54
sitkDualMemberFunctionFactory.h
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::LabelMapOverlayImageFilter::GetColormap
std::vector< unsigned char > GetColormap() const
Definition: sitkLabelMapOverlayImageFilter.h:86
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:42
itk::simple::LabelMapOverlayImageFilter::GetOpacity
double GetOpacity() const
Definition: sitkLabelMapOverlayImageFilter.h:78
itk::simple::LabelPixelIDTypeList
typelist2::typelist< LabelPixelID< uint8_t >, LabelPixelID< uint16_t >, LabelPixelID< uint32_t > > LabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:167
itk::simple::LabelMapOverlayImageFilter::MemberFunctionType
Image(Self::*)(const Image *labelMapImage, const Image *featureImage) MemberFunctionType
Definition: sitkLabelMapOverlayImageFilter.h:102
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::LabelMapOverlayImageFilter::GetName
std::string GetName() const
Definition: sitkLabelMapOverlayImageFilter.h:89
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:28
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::LabelMapOverlayImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkLabelMapOverlayImageFilter.h:108