SimpleITK  
sitkBinaryMorphologicalClosingImageFilter.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 sitkBinaryMorphologicalClosingImageFilter_h
19 #define sitkBinaryMorphologicalClosingImageFilter_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 SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
92 
96  double GetForegroundValue() const { return this->m_ForegroundValue; }\
97 
101  SITK_RETURN_SELF_TYPE_HEADER SetSafeBorder ( bool SafeBorder ) { this->m_SafeBorder = SafeBorder; return *this; }
102 
104  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOn() { return this->SetSafeBorder(true); }
105  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOff() { return this->SetSafeBorder(false); }
106 
110  bool GetSafeBorder() const { return this->m_SafeBorder; }
111 
113  std::string GetName() const { return std::string ("BinaryMorphologicalClosingImageFilter"); }
114 
116  std::string ToString() const;
117 
118 
121  Image Execute ( const Image& image1 );
122 
123  private:
124 
127  using MemberFunctionType = Image (Self::*)( const Image& image1 );
128  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
129 
130 
132 
133  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
134 
135 
136  /* */
137  std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
138 
140 
141  double m_ForegroundValue{1.0};
142 
143  /* */
144  bool m_SafeBorder{true};
145 
146 
147  };
148 
159  SITKBasicFilters_EXPORT Image BinaryMorphologicalClosing ( const Image& image1, std::vector<unsigned int> kernelRadius = std::vector<uint32_t>(3, 1), KernelEnum kernelType = itk::simple::sitkBall, double foregroundValue = 1.0, bool safeBorder = true );
160 
162 }
163 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::BinaryMorphologicalClosingImageFilter::SafeBorderOff
Self & SafeBorderOff()
Definition: sitkBinaryMorphologicalClosingImageFilter.h:105
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::BinaryMorphologicalClosingImageFilter::GetSafeBorder
bool GetSafeBorder() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:110
itk::simple::BinaryMorphologicalClosingImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryMorphologicalClosingImageFilter.h:62
itk::simple::BinaryMorphologicalClosing
Image BinaryMorphologicalClosing(const Image &image1, std::vector< unsigned int > kernelRadius=std::vector< uint32_t >(3, 1), KernelEnum kernelType=itk::simple::sitkBall, double foregroundValue=1.0, bool safeBorder=true)
binary morphological closing of an image.
sitkImageFilter.h
itk::simple::BinaryMorphologicalClosingImageFilter::SetSafeBorder
Self & SetSafeBorder(bool SafeBorder)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:101
itk::simple::BinaryMorphologicalClosingImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:91
itk::simple::sitkBall
@ sitkBall
Ball (sphere in 3D, circle in 2D) shaped structuring element.
Definition: sitkKernel.h:34
itk::simple::BinaryMorphologicalClosingImageFilter::SetKernelRadius
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:68
itk::simple::BinaryMorphologicalClosingImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:96
itk::simple::BinaryMorphologicalClosingImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryMorphologicalClosingImageFilter.h:133
itk::simple::BinaryMorphologicalClosingImageFilter
binary morphological closing of an image.
Definition: sitkBinaryMorphologicalClosingImageFilter.h:50
itk::simple::BinaryMorphologicalClosingImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:86
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:27
itk::simple::BinaryMorphologicalClosingImageFilter::SetKernelRadius
Self & SetKernelRadius(unsigned int value)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:71
itk::simple::BinaryMorphologicalClosingImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:81
itk::simple::BinaryMorphologicalClosingImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:113
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
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::BinaryMorphologicalClosingImageFilter::GetKernelRadius
std::vector< unsigned int > GetKernelRadius() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:76
itk::simple::BinaryMorphologicalClosingImageFilter::SafeBorderOn
Self & SafeBorderOn()
Definition: sitkBinaryMorphologicalClosingImageFilter.h:104
itk::simple::BinaryMorphologicalClosingImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryMorphologicalClosingImageFilter.h:127
itk::simple
Definition: sitkAdditionalProcedures.h:28