SimpleITK  2.0.0rc2.post21
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 {
33  namespace simple {
34 
52  public:
54 
57 
61 
64 \
65 
69  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius ( std::vector<unsigned int> KernelRadius ) { this->m_KernelRadius = std::move(KernelRadius); return *this; }
70 
72  SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius( unsigned int value ) { this->m_KernelRadius = std::vector<unsigned int>(3, value); return *this; }
73 
77  std::vector<unsigned int> GetKernelRadius() const { return this->m_KernelRadius; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetKernelType ( KernelEnum KernelType ) { this->m_KernelType = KernelType; return *this; }
83 
87  KernelEnum GetKernelType() const { return this->m_KernelType; }\
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
93 
97  double GetForegroundValue() const { return this->m_ForegroundValue; }\
98 
102  SITK_RETURN_SELF_TYPE_HEADER SetSafeBorder ( bool SafeBorder ) { this->m_SafeBorder = SafeBorder; return *this; }
103 
105  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOn() { return this->SetSafeBorder(true); }
106  SITK_RETURN_SELF_TYPE_HEADER SafeBorderOff() { return this->SetSafeBorder(false); }
107 
111  bool GetSafeBorder() const { return this->m_SafeBorder; }
112 
114  std::string GetName() const { return std::string ("BinaryMorphologicalClosingImageFilter"); }
115 
117  std::string ToString() const;
118 
119 
122  Image Execute ( const Image& image1 );
123 
124  private:
125 
128  using MemberFunctionType = Image (Self::*)( const Image& image1 );
129  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
130 
131 
133 
134  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
135 
136 
137  /* */
138  std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
139 
141 
142  double m_ForegroundValue{1.0};
143 
144  /* */
145  bool m_SafeBorder{true};
146 
147 
148  };
149 
160  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 );
161 
163  }
164 }
165 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::BinaryMorphologicalClosingImageFilter::SafeBorderOff
Self & SafeBorderOff()
Definition: sitkBinaryMorphologicalClosingImageFilter.h:106
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::BinaryMorphologicalClosingImageFilter::GetSafeBorder
bool GetSafeBorder() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:111
itk::simple::BinaryMorphologicalClosingImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryMorphologicalClosingImageFilter.h:63
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:102
itk::simple::BinaryMorphologicalClosingImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:92
itk::simple::sitkBall
@ sitkBall
Definition: sitkKernel.h:31
itk::simple::BinaryMorphologicalClosingImageFilter::SetKernelRadius
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:69
itk::simple::BinaryMorphologicalClosingImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:97
itk::simple::BinaryMorphologicalClosingImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryMorphologicalClosingImageFilter.h:134
itk::simple::BinaryMorphologicalClosingImageFilter
binary morphological closing of an image.
Definition: sitkBinaryMorphologicalClosingImageFilter.h:51
itk::simple::BinaryMorphologicalClosingImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:87
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:29
itk::simple::BinaryMorphologicalClosingImageFilter::SetKernelRadius
Self & SetKernelRadius(unsigned int value)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:72
itk::simple::BinaryMorphologicalClosingImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkBinaryMorphologicalClosingImageFilter.h:82
itk
itk::simple::BinaryMorphologicalClosingImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:114
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::BinaryMorphologicalClosingImageFilter::GetKernelRadius
std::vector< unsigned int > GetKernelRadius() const
Definition: sitkBinaryMorphologicalClosingImageFilter.h:77
itk::simple::BinaryMorphologicalClosingImageFilter::SafeBorderOn
Self & SafeBorderOn()
Definition: sitkBinaryMorphologicalClosingImageFilter.h:105
itk::simple::BinaryMorphologicalClosingImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryMorphologicalClosingImageFilter.h:128
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