SimpleITK  
sitkBinaryMorphologicalOpeningImageFilter.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 sitkBinaryMorphologicalOpeningImageFilter_h
19 #define sitkBinaryMorphologicalOpeningImageFilter_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::simple {
33 
51  public:
53 
56 
60 
63 \
64 
68  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius ( std::vector<unsigned int> KernelRadius ) { this->m_KernelRadius = std::move(KernelRadius); return *this; }
69 
71  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius( unsigned int value ) { this->m_KernelRadius = std::vector<unsigned int>(3, value); return *this; }
72 
76  std::vector<unsigned int> GetKernelRadius() const { return this->m_KernelRadius; }\
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetKernelType ( KernelEnum KernelType ) { this->m_KernelType = KernelType; return *this; }
82 
86  KernelEnum GetKernelType() const { return this->m_KernelType; }\
87 
91  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
92 
96  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
97 
101  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
102 
106  double GetForegroundValue() const { return this->m_ForegroundValue; }
107 
109  std::string GetName() const { return std::string ("BinaryMorphologicalOpeningImageFilter"); }
110 
112  std::string ToString() const;
113 
114 
117  Image Execute ( const Image& image1 );
118 
119  private:
120 
123  using MemberFunctionType = Image (Self::*)( const Image& image1 );
124  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
125 
126 
128 
129  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
130 
131 
132  /* */
133  std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
134 
136 
137  double m_BackgroundValue{0.0};
138 
139  double m_ForegroundValue{1.0};
140 
141 
142  };
143 
154  SITKBasicFilters_EXPORT Image BinaryMorphologicalOpening ( 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 );
155 
157 }
158 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::BinaryMorphologicalOpeningImageFilter::GetKernelRadius
std::vector< unsigned int > GetKernelRadius() const
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:76
itk::simple::BinaryMorphologicalOpeningImageFilter
binary morphological opening of an image.
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:50
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:81
itk::simple::BinaryMorphologicalOpening
Image BinaryMorphologicalOpening(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)
binary morphological opening of an image.
sitkImageFilter.h
itk::simple::BinaryMorphologicalOpeningImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:62
itk::simple::BinaryMorphologicalOpeningImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:106
itk::simple::sitkBall
@ sitkBall
Ball (sphere in 3D, circle in 2D) shaped structuring element.
Definition: sitkKernel.h:34
itk::simple::BinaryMorphologicalOpeningImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:86
itk::simple::BinaryMorphologicalOpeningImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:96
itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelRadius
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:68
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::BinaryMorphologicalOpeningImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:109
itk::simple::BinaryMorphologicalOpeningImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:101
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:27
itk::simple::BinaryMorphologicalOpeningImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:91
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::BinaryMorphologicalOpeningImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:123
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::IntegerPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > > IntegerPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:75
itk::simple::BinaryMorphologicalOpeningImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:129
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelRadius
Self & SetKernelRadius(unsigned int value)
Definition: sitkBinaryMorphologicalOpeningImageFilter.h:71