SimpleITK  1.3.0.dev466
sitkLabelOverlayImageFilter.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 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 
52  public:
54 
56  virtual ~LabelOverlayImageFilter();
57 
61 
64 
65 
66 
70  SITK_RETURN_SELF_TYPE_HEADER SetOpacity ( double Opacity ) { this->m_Opacity = Opacity; return *this; }
71 
75  double GetOpacity() const { return this->m_Opacity; }
76 
80  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
81 
85  double GetBackgroundValue() const { return this->m_BackgroundValue; }
86 
89  SITK_RETURN_SELF_TYPE_HEADER SetColormap ( std::vector<uint8_t> Colormap ) { this->m_Colormap = Colormap; return *this; }
90 
93  std::vector<uint8_t> GetColormap() const { return this->m_Colormap; }
95  std::string GetName() const { return std::string ("LabelOverlayImageFilter"); }
96 
98  std::string ToString() const;
99 
100 
102  Image Execute ( const Image & image, const Image & labelImage );
103 
104 
106  Image Execute ( const Image & image, const Image & labelImage, double opacity, double backgroundValue, std::vector<uint8_t> colormap );
107 
108 
109  private:
111  typedef Image (Self::*MemberFunctionType)( const Image * image, const Image * labelImage );
112 
113  friend struct detail::DualExecuteInternalAddressor<MemberFunctionType>;
114  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * image, const Image * labelImage );
115 
116 
117  nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
118 
119 
120 
121  /* Value assigned to pixels outside of the mask */
122  double m_Opacity;
124  std::vector<uint8_t> m_Colormap;
125  };
126 
127 
128 
137  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>() );
138 
139  }
140 }
141 #endif
#define SITKBasicFilters_EXPORT
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
Self & SetBackgroundValue(double BackgroundValue)
Apply a colormap to a label image and put it on top of the input image.
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
The Image class for SimpleITK.
Definition: sitkImage.h:78
Self & SetColormap(std::vector< uint8_t > Colormap)
The base interface for SimpleITK filters that take one input image.
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 >())
Apply a colormap to a label image and put it on top of the input image.
std::vector< uint8_t > GetColormap() const