SimpleITK  2.0.0rc2.post50
sitkBinaryErodeImageFilter.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 sitkBinaryErodeImageFilter_h
19 #define sitkBinaryErodeImageFilter_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 sitkImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkBasicFilters.h"
30 #include "sitkImageFilter.h"
31 
32 namespace itk {
33  namespace simple {
34 
56  public:
58 
60  virtual ~BinaryErodeImageFilter();
61 
65 
68 \
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius ( std::vector<unsigned int> KernelRadius ) { this->m_KernelRadius = std::move(KernelRadius); return *this; }
74 
76  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius( unsigned int value ) { this->m_KernelRadius = std::vector<unsigned int>(3, value); return *this; }
77 
81  std::vector<unsigned int> GetKernelRadius() const { return this->m_KernelRadius; }\
82 
86  SITK_RETURN_SELF_TYPE_HEADER SetKernelType ( KernelEnum KernelType ) { this->m_KernelType = KernelType; return *this; }
87 
91  KernelEnum GetKernelType() const { return this->m_KernelType; }\
92 
95  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
96 
99  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
100 
103  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
104 
107  double GetForegroundValue() const { return this->m_ForegroundValue; }\
108 
111  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryToForeground ( bool BoundaryToForeground ) { this->m_BoundaryToForeground = BoundaryToForeground; return *this; }
112 
114  SITK_RETURN_SELF_TYPE_HEADER BoundaryToForegroundOn() { return this->SetBoundaryToForeground(true); }
115  SITK_RETURN_SELF_TYPE_HEADER BoundaryToForegroundOff() { return this->SetBoundaryToForeground(false); }
116 
119  bool GetBoundaryToForeground() const { return this->m_BoundaryToForeground; }
120 
122  std::string GetName() const { return std::string ("BinaryErodeImageFilter"); }
123 
125  std::string ToString() const;
126 
127 
130  Image Execute ( const Image& image1 );
131 
132  private:
133 
136  using MemberFunctionType = Image (Self::*)( const Image& image1 );
137  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
138 
139 
141 
142  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
143 
144 
145  /* */
146  std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
147 
149 
150  /* */
151  double m_BackgroundValue{0.0};
152 
153  /* */
154  double m_ForegroundValue{1.0};
155 
156  /* */
157  bool m_BoundaryToForeground{true};
158 
159 
160  };
161 
172  SITKBasicFilters_EXPORT Image BinaryErode ( const Image& image1, std::vector<unsigned int> kernelRadius = std::vector<uint32_t>(3, 1), KernelEnum kernelType = itk::simple::sitkBall, double backgroundValue = 0.0, double foregroundValue = 1.0, bool boundaryToForeground = true );
173 
175  }
176 }
177 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::BinaryErodeImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkBinaryErodeImageFilter.h:107
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::BinaryErodeImageFilter
Fast binary erosion of a single intensity value in the image.
Definition: sitkBinaryErodeImageFilter.h:55
itk::simple::BinaryErodeImageFilter::SetKernelRadius
Self & SetKernelRadius(unsigned int value)
Definition: sitkBinaryErodeImageFilter.h:76
itk::simple::BinaryErodeImageFilter::GetKernelRadius
std::vector< unsigned int > GetKernelRadius() const
Definition: sitkBinaryErodeImageFilter.h:81
sitkImageFilter.h
itk::simple::BinaryErodeImageFilter::BoundaryToForegroundOn
Self & BoundaryToForegroundOn()
Definition: sitkBinaryErodeImageFilter.h:114
itk::simple::BinaryErodeImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkBinaryErodeImageFilter.h:95
itk::simple::sitkBall
@ sitkBall
Definition: sitkKernel.h:31
itk::simple::BinaryErodeImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryErodeImageFilter.h:136
itk::simple::BinaryErodeImageFilter::SetKernelRadius
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Definition: sitkBinaryErodeImageFilter.h:73
itk::simple::BinaryErodeImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryErodeImageFilter.h:142
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:29
itk::simple::BinaryErodeImageFilter::BoundaryToForegroundOff
Self & BoundaryToForegroundOff()
Definition: sitkBinaryErodeImageFilter.h:115
itk
itk::simple::BinaryErodeImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkBinaryErodeImageFilter.h:91
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::BinaryErodeImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryErodeImageFilter.h:103
itk::simple::BinaryErodeImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryErodeImageFilter.h:67
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::BinaryErodeImageFilter::SetBoundaryToForeground
Self & SetBoundaryToForeground(bool BoundaryToForeground)
Definition: sitkBinaryErodeImageFilter.h:111
itk::simple::BinaryErode
Image BinaryErode(const Image &image1, std::vector< unsigned int > kernelRadius=std::vector< uint32_t >(3, 1), KernelEnum kernelType=itk::simple::sitkBall, double backgroundValue=0.0, double foregroundValue=1.0, bool boundaryToForeground=true)
Fast binary erosion of a single intensity value in the image.
itk::simple::BinaryErodeImageFilter::GetBoundaryToForeground
bool GetBoundaryToForeground() const
Definition: sitkBinaryErodeImageFilter.h:119
itk::simple::BinaryErodeImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkBinaryErodeImageFilter.h:86
itk::simple::BinaryErodeImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkBinaryErodeImageFilter.h:99
itk::simple::IntegerPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > >::Type IntegerPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:76
itk::simple::BinaryErodeImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryErodeImageFilter.h:122