SimpleITK  2.0.0rc2.post23
sitkMaskImageFilter.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 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 
67  public:
69 
71  virtual ~MaskImageFilter();
72 
76 
79 
80 \
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetOutsideValue ( double OutsideValue ) { this->m_OutsideValue = OutsideValue; return *this; }
86 
89  double GetOutsideValue() const { return this->m_OutsideValue; }\
90 
94  SITK_RETURN_SELF_TYPE_HEADER SetMaskingValue ( double MaskingValue ) { this->m_MaskingValue = MaskingValue; return *this; }
95 
99  double GetMaskingValue() const { return this->m_MaskingValue; }
100 
102  std::string GetName() const { return std::string ("MaskImageFilter"); }
103 
105  std::string ToString() const;
106 
107 
109 #ifndef SWIG
110  Image Execute ( Image && image, const Image & maskImage );
111 #endif
112  Image Execute ( const Image & image, const Image & maskImage );
113 
114 
115  private:
117  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage );
118 
120  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * image, const Image * maskImage );
121 
122 
123  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
124 
125 
126 
127  double m_OutsideValue{0};
128 
129  double m_MaskingValue{0};
130 
131 
132  bool m_InPlace{false};
133  };
134 
144 #ifndef SWIG
145  SITKBasicFilters_EXPORT Image Mask ( Image && image, const Image & maskImage, double outsideValue = 0, double maskingValue = 0 );
146 #endif
147  SITKBasicFilters_EXPORT Image Mask ( const Image & image, const Image & maskImage, double outsideValue = 0, double maskingValue = 0 );
148 
150  }
151 }
152 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::MaskImageFilter
Mask an image with a mask.
Definition: sitkMaskImageFilter.h:66
itk::simple::MaskImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkMaskImageFilter.h:78
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:94
itk::simple::MaskImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkMaskImageFilter.h:123
sitkImageFilter.h
itk::simple::MaskImageFilter::SetOutsideValue
Self & SetOutsideValue(double OutsideValue)
Definition: sitkMaskImageFilter.h:85
itk::simple::MaskImageFilter::GetOutsideValue
double GetOutsideValue() const
Definition: sitkMaskImageFilter.h:89
itk::simple::MaskImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *maskImage) MemberFunctionType
Definition: sitkMaskImageFilter.h:117
sitkDualMemberFunctionFactory.h
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:44
itk::simple::Mask
Image Mask(Image &&image, const Image &maskImage, double outsideValue=0, double maskingValue=0)
Mask an image with a mask.
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::MaskImageFilter::GetName
std::string GetName() const
Definition: sitkMaskImageFilter.h:102
itk::simple::MaskImageFilter::GetMaskingValue
double GetMaskingValue() const
Definition: sitkMaskImageFilter.h:99