SimpleITK  1.1.0
sitkMaskImageFilter.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 sitkMaskImageFilter_h
19 #define sitkMaskImageFilter_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 
73  public:
75 
77  virtual ~MaskImageFilter();
78 
82 
85 
86 
87 
91  SITK_RETURN_SELF_TYPE_HEADER SetOutsideValue ( double OutsideValue ) { this->m_OutsideValue = OutsideValue; return *this; }
92 
95  double GetOutsideValue() const { return this->m_OutsideValue; }
96 
100  SITK_RETURN_SELF_TYPE_HEADER SetMaskingValue ( double MaskingValue ) { this->m_MaskingValue = MaskingValue; return *this; }
101 
105  double GetMaskingValue() const { return this->m_MaskingValue; }
107  std::string GetName() const { return std::string ("MaskImageFilter"); }
108 
110  std::string ToString() const;
111 
112 
114  Image Execute ( const Image & image, const Image & maskImage );
115 
116 
118  Image Execute ( const Image & image, const Image & maskImage, double outsideValue, double maskingValue );
119 
120 
121  private:
123  typedef Image (Self::*MemberFunctionType)( const Image * image, const Image * maskImage );
124 
125  friend struct detail::DualExecuteInternalAddressor<MemberFunctionType>;
126  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * image, const Image * maskImage );
127 
128 
129  nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
130 
131 
132 
135  };
136 
137 
138 
147  SITKBasicFilters_EXPORT Image Mask ( const Image & image, const Image & maskImage, double outsideValue = 0, double maskingValue = 0 );
148 
149  }
150 }
151 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::MaskImageFilter::m_MaskingValue
double m_MaskingValue
Definition: sitkMaskImageFilter.h:134
itk::simple::MaskImageFilter
Mask an image with a mask.
Definition: sitkMaskImageFilter.h:72
itk::simple::NonLabelPixelIDTypeList
typelist::Append< typelist::Append< BasicPixelIDTypeList, ComplexPixelIDTypeList >::Type, VectorPixelIDTypeList >::Type NonLabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:180
itk::simple::MaskImageFilter::SetMaskingValue
Self & SetMaskingValue(double MaskingValue)
Definition: sitkMaskImageFilter.h:100
itk::simple::Mask
Image Mask(const Image &image, const Image &maskImage, double outsideValue=0, double maskingValue=0)
Mask an image with a mask.
itk::simple::MaskImageFilter::m_OutsideValue
double m_OutsideValue
Definition: sitkMaskImageFilter.h:133
itk::simple::MaskImageFilter::m_DualMemberFactory
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkMaskImageFilter.h:129
sitkImageFilter.h
itk::simple::MaskImageFilter::SetOutsideValue
Self & SetOutsideValue(double OutsideValue)
Definition: sitkMaskImageFilter.h:91
itk::simple::MaskImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkMaskImageFilter.h:84
itk::simple::MaskImageFilter::GetOutsideValue
double GetOutsideValue() const
Definition: sitkMaskImageFilter.h:95
itk::simple::MaskImageFilter::Self
MaskImageFilter Self
Definition: sitkMaskImageFilter.h:74
sitkDualMemberFunctionFactory.h
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
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::MaskImageFilter::GetName
std::string GetName() const
Definition: sitkMaskImageFilter.h:107
itk::simple::MaskImageFilter::GetMaskingValue
double GetMaskingValue() const
Definition: sitkMaskImageFilter.h:105