SimpleITK  
sitkLabelOverlayImageFilter.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 sitkLabelOverlayImageFilter_h
19 #define sitkLabelOverlayImageFilter_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 
53  public:
55 
57  virtual ~LabelOverlayImageFilter();
58 
62 
65 
66 \
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetOpacity ( double Opacity ) { this->m_Opacity = Opacity; return *this; }
72 
76  double GetOpacity() const { return this->m_Opacity; }\
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
82 
86  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
87 
90  SITK_RETURN_SELF_TYPE_HEADER SetColormap ( std::vector<uint8_t> Colormap ) { this->m_Colormap = Colormap; return *this; }
91 
94  std::vector<uint8_t> GetColormap() const { return this->m_Colormap; }
95 
97  std::string GetName() const { return std::string ("LabelOverlayImageFilter"); }
98 
100  std::string ToString() const;
101 
102 
104 #ifndef SWIG
105  Image Execute ( Image && image, const Image & labelImage );
106 #endif
107  Image Execute ( const Image & image, const Image & labelImage );
108 
109 
110  private:
112  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * labelImage );
113 
115  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * image, const Image * labelImage );
116 
117 
118  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
119 
120 
121 
122  /* Value assigned to pixels outside of the mask */
123  double m_Opacity{0.5};
124 
125  double m_BackgroundValue{0.0};
126 
127  std::vector<uint8_t> m_Colormap{std::vector<uint8_t>()};
128 
129 
130  bool m_InPlace{false};
131  };
132 
142 #ifndef SWIG
143  SITKBasicFilters_EXPORT Image LabelOverlay ( Image && image, const Image & labelImage, double opacity = 0.5, double backgroundValue = 0.0, std::vector<uint8_t> colormap = std::vector<uint8_t>() );
144 #endif
145  SITKBasicFilters_EXPORT Image LabelOverlay ( const Image & image, const Image & labelImage, double opacity = 0.5, double backgroundValue = 0.0, std::vector<uint8_t> colormap = std::vector<uint8_t>() );
146 
148 }
149 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::LabelOverlayImageFilter::SetOpacity
Self & SetOpacity(double Opacity)
Definition: sitkLabelOverlayImageFilter.h:71
itk::simple::LabelOverlayImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *labelImage) MemberFunctionType
Definition: sitkLabelOverlayImageFilter.h:112
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::LabelOverlayImageFilter
Apply a colormap to a label image and put it on top of the input image.
Definition: sitkLabelOverlayImageFilter.h:52
sitkImageFilter.h
itk::simple::LabelOverlayImageFilter::GetName
std::string GetName() const
Definition: sitkLabelOverlayImageFilter.h:97
itk::simple::LabelOverlay
Image LabelOverlay(Image &&image, const Image &labelImage, double opacity=0.5, double backgroundValue=0.0, std::vector< uint8_t > colormap=std::vector< uint8_t >())
Apply a colormap to a label image and put it on top of the input image.
itk::simple::LabelOverlayImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkLabelOverlayImageFilter.h:118
sitkDualMemberFunctionFactory.h
itk::simple::LabelOverlayImageFilter::SetColormap
Self & SetColormap(std::vector< uint8_t > Colormap)
Definition: sitkLabelOverlayImageFilter.h:90
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:42
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::LabelOverlayImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkLabelOverlayImageFilter.h:86
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::LabelOverlayImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkLabelOverlayImageFilter.h:64
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::LabelOverlayImageFilter::GetOpacity
double GetOpacity() const
Definition: sitkLabelOverlayImageFilter.h:76
itk::simple::LabelOverlayImageFilter::GetColormap
std::vector< uint8_t > GetColormap() const
Definition: sitkLabelOverlayImageFilter.h:94
itk::simple::LabelOverlayImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkLabelOverlayImageFilter.h:81