SimpleITK  2.0.0rc2.post17
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 {
34  namespace simple {
35 
54  public:
56 
58  virtual ~LabelOverlayImageFilter();
59 
63 
66 
67 \
68 
72  SITK_RETURN_SELF_TYPE_HEADER SetOpacity ( double Opacity ) { this->m_Opacity = Opacity; return *this; }
73 
77  double GetOpacity() const { return this->m_Opacity; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
83 
87  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
88 
91  SITK_RETURN_SELF_TYPE_HEADER SetColormap ( std::vector<uint8_t> Colormap ) { this->m_Colormap = Colormap; return *this; }
92 
95  std::vector<uint8_t> GetColormap() const { return this->m_Colormap; }
96 
98  std::string GetName() const { return std::string ("LabelOverlayImageFilter"); }
99 
101  std::string ToString() const;
102 
103 
105 #ifndef SWIG
106  Image Execute ( Image && image, const Image & labelImage );
107 #endif
108  Image Execute ( const Image & image, const Image & labelImage );
109 
110 
111  private:
113  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * labelImage );
114 
116  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * image, const Image * labelImage );
117 
118 
119  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
120 
121 
122 
123  /* Value assigned to pixels outside of the mask */
124  double m_Opacity{0.5};
125 
126  double m_BackgroundValue{0.0};
127 
128  std::vector<uint8_t> m_Colormap{std::vector<uint8_t>()};
129 
130 
131  bool m_InPlace{false};
132  };
133 
143 #ifndef SWIG
144  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>() );
145 #endif
146  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>() );
147 
149  }
150 }
151 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::LabelOverlayImageFilter::SetOpacity
Self & SetOpacity(double Opacity)
Definition: sitkLabelOverlayImageFilter.h:72
itk::simple::LabelOverlayImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *labelImage) MemberFunctionType
Definition: sitkLabelOverlayImageFilter.h:113
itk::simple::LabelOverlayImageFilter
Apply a colormap to a label image and put it on top of the input image.
Definition: sitkLabelOverlayImageFilter.h:53
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::LabelOverlayImageFilter::GetName
std::string GetName() const
Definition: sitkLabelOverlayImageFilter.h:98
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:119
sitkDualMemberFunctionFactory.h
itk::simple::LabelOverlayImageFilter::SetColormap
Self & SetColormap(std::vector< uint8_t > Colormap)
Definition: sitkLabelOverlayImageFilter.h:91
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:44
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::LabelOverlayImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkLabelOverlayImageFilter.h:87
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::LabelOverlayImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkLabelOverlayImageFilter.h:65
itk::simple::LabelOverlayImageFilter::GetOpacity
double GetOpacity() const
Definition: sitkLabelOverlayImageFilter.h:77
itk::simple::LabelOverlayImageFilter::GetColormap
std::vector< uint8_t > GetColormap() const
Definition: sitkLabelOverlayImageFilter.h:95
itk::simple::LabelOverlayImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkLabelOverlayImageFilter.h:82