SimpleITK  1.1.0
sitkLabelMapContourOverlayImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 sitkLabelMapContourOverlayImageFilter_h
19 #define sitkLabelMapContourOverlayImageFilter_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 
60  public:
62 
65 
69 
72 
73 
74 
78  SITK_RETURN_SELF_TYPE_HEADER SetOpacity ( double Opacity ) { this->m_Opacity = Opacity; return *this; }
79 
83  double GetOpacity() const { return this->m_Opacity; }
84 
88  SITK_RETURN_SELF_TYPE_HEADER SetDilationRadius ( const std::vector<unsigned int> & DilationRadius ) { this->m_DilationRadius = DilationRadius; return *this; }
89 
91  SITK_RETURN_SELF_TYPE_HEADER SetDilationRadius( unsigned int value ) { this->m_DilationRadius = std::vector<unsigned int>(3, value); return *this; }
92 
93 
97  std::vector<unsigned int> GetDilationRadius() const { return this->m_DilationRadius; }
98 
102  SITK_RETURN_SELF_TYPE_HEADER SetContourThickness ( const std::vector<unsigned int> & ContourThickness ) { this->m_ContourThickness = ContourThickness; return *this; }
103 
107  std::vector<unsigned int> GetContourThickness() const { return this->m_ContourThickness; }
108 
112  SITK_RETURN_SELF_TYPE_HEADER SetSliceDimension ( unsigned int SliceDimension ) { this->m_SliceDimension = SliceDimension; return *this; }
113 
117  unsigned int GetSliceDimension() const { return this->m_SliceDimension; }
118 
119  typedef enum {PLAIN,CONTOUR,SLICE_CONTOUR} ContourTypeType;
120 
125  SITK_RETURN_SELF_TYPE_HEADER SetContourType ( ContourTypeType ContourType ) { this->m_ContourType = ContourType; return *this; }
126 
131  ContourTypeType GetContourType() const { return this->m_ContourType; }
132 
133  typedef enum {HIGH_LABEL_ON_TOP,LOW_LABEL_ON_TOP} PriorityType;
134 
138  SITK_RETURN_SELF_TYPE_HEADER SetPriority ( PriorityType Priority ) { this->m_Priority = Priority; return *this; }
139 
143  PriorityType GetPriority() const { return this->m_Priority; }
144 
147  SITK_RETURN_SELF_TYPE_HEADER SetColormap ( std::vector<uint8_t> Colormap ) { this->m_Colormap = Colormap; return *this; }
148 
151  std::vector<uint8_t> GetColormap() const { return this->m_Colormap; }
153  std::string GetName() const { return std::string ("LabelMapContourOverlayImageFilter"); }
154 
156  std::string ToString() const;
157 
158 
160  Image Execute ( const Image & labelMapImage, const Image & featureImage );
161 
162 
164  Image Execute ( const Image & labelMapImage, const Image & featureImage, double opacity, const std::vector<unsigned int> & dilationRadius, const std::vector<unsigned int> & contourThickness, unsigned int sliceDimension, LabelMapContourOverlayImageFilter::ContourTypeType contourType, LabelMapContourOverlayImageFilter::PriorityType priority, std::vector<uint8_t> colormap );
165 
166 
167  private:
169  typedef Image (Self::*MemberFunctionType)( const Image * labelMapImage, const Image * featureImage );
170 
171  friend struct detail::DualExecuteInternalAddressor<MemberFunctionType>;
172  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * labelMapImage, const Image * featureImage );
173 
174 
175  nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
176 
177 
178 
179  double m_Opacity;
180  std::vector<unsigned int> m_DilationRadius;
181  std::vector<unsigned int> m_ContourThickness;
182  unsigned int m_SliceDimension;
185  std::vector<uint8_t> m_Colormap;
186  };
187 
188 
189 
198  SITKBasicFilters_EXPORT Image LabelMapContourOverlay ( const Image & labelMapImage, const Image & featureImage, double opacity = 0.5, const std::vector<unsigned int> & dilationRadius = std::vector<unsigned int>(3, 1), const std::vector<unsigned int> & contourThickness = std::vector<unsigned int>(3, 1), unsigned int sliceDimension = 0u, LabelMapContourOverlayImageFilter::ContourTypeType contourType = itk::simple::LabelMapContourOverlayImageFilter::CONTOUR, LabelMapContourOverlayImageFilter::PriorityType priority = itk::simple::LabelMapContourOverlayImageFilter::HIGH_LABEL_ON_TOP, std::vector<uint8_t> colormap = std::vector<uint8_t>() );
199 
200  }
201 }
202 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
itk::simple::LabelMapContourOverlayImageFilter::SetContourThickness
Self & SetContourThickness(const std::vector< unsigned int > &ContourThickness)
Definition: sitkLabelMapContourOverlayImageFilter.h:102
sitkBasicFilters.h
itk::simple::LabelMapContourOverlayImageFilter::GetName
std::string GetName() const
Definition: sitkLabelMapContourOverlayImageFilter.h:153
itk::simple::LabelMapContourOverlayImageFilter::PixelIDTypeList
LabelPixelIDTypeList PixelIDTypeList
Definition: sitkLabelMapContourOverlayImageFilter.h:71
itk::simple::LabelMapContourOverlayImageFilter::m_DualMemberFactory
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkLabelMapContourOverlayImageFilter.h:175
itk::simple::LabelMapContourOverlayImageFilter::SetSliceDimension
Self & SetSliceDimension(unsigned int SliceDimension)
Definition: sitkLabelMapContourOverlayImageFilter.h:112
itk::simple::LabelMapContourOverlayImageFilter::PriorityType
PriorityType
Definition: sitkLabelMapContourOverlayImageFilter.h:133
itk::simple::LabelMapContourOverlayImageFilter::GetSliceDimension
unsigned int GetSliceDimension() const
Definition: sitkLabelMapContourOverlayImageFilter.h:117
itk::simple::LabelMapContourOverlayImageFilter::SetDilationRadius
Self & SetDilationRadius(unsigned int value)
Definition: sitkLabelMapContourOverlayImageFilter.h:91
itk::simple::LabelMapContourOverlayImageFilter::SetContourType
Self & SetContourType(ContourTypeType ContourType)
Definition: sitkLabelMapContourOverlayImageFilter.h:125
itk::simple::LabelMapContourOverlayImageFilter::ContourTypeType
ContourTypeType
Definition: sitkLabelMapContourOverlayImageFilter.h:119
itk::simple::LabelMapContourOverlayImageFilter::GetColormap
std::vector< uint8_t > GetColormap() const
Definition: sitkLabelMapContourOverlayImageFilter.h:151
itk::simple::LabelMapContourOverlayImageFilter::SetOpacity
Self & SetOpacity(double Opacity)
Definition: sitkLabelMapContourOverlayImageFilter.h:78
itk::simple::LabelMapContourOverlayImageFilter::CONTOUR
@ CONTOUR
Definition: sitkLabelMapContourOverlayImageFilter.h:119
itk::simple::LabelMapContourOverlayImageFilter::m_SliceDimension
unsigned int m_SliceDimension
Definition: sitkLabelMapContourOverlayImageFilter.h:182
itk::simple::LabelMapContourOverlayImageFilter::SetColormap
Self & SetColormap(std::vector< uint8_t > Colormap)
Definition: sitkLabelMapContourOverlayImageFilter.h:147
itk::simple::LabelMapContourOverlayImageFilter::GetContourThickness
std::vector< unsigned int > GetContourThickness() const
Definition: sitkLabelMapContourOverlayImageFilter.h:107
itk::simple::LabelMapContourOverlayImageFilter::Self
LabelMapContourOverlayImageFilter Self
Definition: sitkLabelMapContourOverlayImageFilter.h:61
sitkImageFilter.h
itk::simple::LabelMapContourOverlay
Image LabelMapContourOverlay(const Image &labelMapImage, const Image &featureImage, double opacity=0.5, const std::vector< unsigned int > &dilationRadius=std::vector< unsigned int >(3, 1), const std::vector< unsigned int > &contourThickness=std::vector< unsigned int >(3, 1), unsigned int sliceDimension=0u, LabelMapContourOverlayImageFilter::ContourTypeType contourType=itk::simple::LabelMapContourOverlayImageFilter::CONTOUR, LabelMapContourOverlayImageFilter::PriorityType priority=itk::simple::LabelMapContourOverlayImageFilter::HIGH_LABEL_ON_TOP, std::vector< uint8_t > colormap=std::vector< uint8_t >())
Apply a colormap to the contours (outlines) of each object in a label map and superimpose it on top o...
itk::simple::LabelMapContourOverlayImageFilter::m_ContourThickness
std::vector< unsigned int > m_ContourThickness
Definition: sitkLabelMapContourOverlayImageFilter.h:181
itk::simple::LabelMapContourOverlayImageFilter::GetOpacity
double GetOpacity() const
Definition: sitkLabelMapContourOverlayImageFilter.h:83
itk::simple::LabelMapContourOverlayImageFilter::m_ContourType
ContourTypeType m_ContourType
Definition: sitkLabelMapContourOverlayImageFilter.h:183
itk::simple::LabelMapContourOverlayImageFilter::GetContourType
ContourTypeType GetContourType() const
Definition: sitkLabelMapContourOverlayImageFilter.h:131
itk::simple::LabelMapContourOverlayImageFilter::GetPriority
PriorityType GetPriority() const
Definition: sitkLabelMapContourOverlayImageFilter.h:143
sitkDualMemberFunctionFactory.h
itk::simple::LabelMapContourOverlayImageFilter::SetDilationRadius
Self & SetDilationRadius(const std::vector< unsigned int > &DilationRadius)
Definition: sitkLabelMapContourOverlayImageFilter.h:88
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::LabelMapContourOverlayImageFilter
Apply a colormap to the contours (outlines) of each object in a label map and superimpose it on top o...
Definition: sitkLabelMapContourOverlayImageFilter.h:59
itk::simple::LabelMapContourOverlayImageFilter::HIGH_LABEL_ON_TOP
@ HIGH_LABEL_ON_TOP
Definition: sitkLabelMapContourOverlayImageFilter.h:133
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:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::LabelMapContourOverlayImageFilter::m_Opacity
double m_Opacity
Definition: sitkLabelMapContourOverlayImageFilter.h:179
itk::simple::LabelMapContourOverlayImageFilter::GetDilationRadius
std::vector< unsigned int > GetDilationRadius() const
Definition: sitkLabelMapContourOverlayImageFilter.h:97
itk::simple::LabelMapContourOverlayImageFilter::SetPriority
Self & SetPriority(PriorityType Priority)
Definition: sitkLabelMapContourOverlayImageFilter.h:138
itk::simple::LabelMapContourOverlayImageFilter::m_Colormap
std::vector< uint8_t > m_Colormap
Definition: sitkLabelMapContourOverlayImageFilter.h:185
itk::simple::LabelMapContourOverlayImageFilter::m_DilationRadius
std::vector< unsigned int > m_DilationRadius
Definition: sitkLabelMapContourOverlayImageFilter.h:180
itk::simple::LabelMapContourOverlayImageFilter::m_Priority
PriorityType m_Priority
Definition: sitkLabelMapContourOverlayImageFilter.h:184
itk::simple::LabelPixelIDTypeList
typelist::MakeTypeList< LabelPixelID< uint8_t >, LabelPixelID< uint16_t >, LabelPixelID< uint32_t > >::Type LabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:165