SimpleITK  
sitkBinaryOpeningByReconstructionImageFilter.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 sitkBinaryOpeningByReconstructionImageFilter_h
19 #define sitkBinaryOpeningByReconstructionImageFilter_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 SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
102 
106  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
107 
111  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
112 
114  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
115  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
116 
120  bool GetFullyConnected() const { return this->m_FullyConnected; }
121 
123  std::string GetName() const { return std::string ("BinaryOpeningByReconstructionImageFilter"); }
124 
126  std::string ToString() const;
127 
128 
131  Image Execute ( const Image& image1 );
132 
133  private:
134 
137  using MemberFunctionType = Image (Self::*)( const Image& image1 );
138  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
139 
140 
142 
143  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
144 
145 
146  /* */
147  std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
148 
150 
151  double m_ForegroundValue{1.0};
152 
153  double m_BackgroundValue{0.0};
154 
155  /* */
156  bool m_FullyConnected{false};
157 
158 
159  };
160 
171  SITKBasicFilters_EXPORT Image BinaryOpeningByReconstruction ( const Image& image1, std::vector<unsigned int> kernelRadius = std::vector<uint32_t>(3, 1), KernelEnum kernelType = itk::simple::sitkBall, double foregroundValue = 1.0, double backgroundValue = 0.0, bool fullyConnected = false );
172 
174 }
175 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::BinaryOpeningByReconstructionImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:106
itk::simple::BinaryOpeningByReconstructionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:143
itk::simple::BinaryOpeningByReconstructionImageFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:115
itk::simple::BinaryOpeningByReconstructionImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:81
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::BinaryOpeningByReconstructionImageFilter::GetKernelRadius
std::vector< unsigned int > GetKernelRadius() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:76
itk::simple::BinaryOpeningByReconstructionImageFilter::SetKernelRadius
Self & SetKernelRadius(unsigned int value)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:71
sitkImageFilter.h
itk::simple::BinaryOpeningByReconstructionImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:86
itk::simple::BinaryOpeningByReconstruction
Image BinaryOpeningByReconstruction(const Image &image1, std::vector< unsigned int > kernelRadius=std::vector< uint32_t >(3, 1), KernelEnum kernelType=itk::simple::sitkBall, double foregroundValue=1.0, double backgroundValue=0.0, bool fullyConnected=false)
binary morphological closing of an image.
itk::simple::BinaryOpeningByReconstructionImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:96
itk::simple::BinaryOpeningByReconstructionImageFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:114
itk::simple::sitkBall
@ sitkBall
Ball (sphere in 3D, circle in 2D) shaped structuring element.
Definition: sitkKernel.h:34
itk::simple::BinaryOpeningByReconstructionImageFilter
binary morphological closing of an image.
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:50
itk::simple::BinaryOpeningByReconstructionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:137
itk::simple::BinaryOpeningByReconstructionImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:91
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:27
itk::simple::BinaryOpeningByReconstructionImageFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:111
itk::simple::BinaryOpeningByReconstructionImageFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:120
itk::simple::BinaryOpeningByReconstructionImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:101
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::BinaryOpeningByReconstructionImageFilter::SetKernelRadius
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:68
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
Definition: sitkAdditionalProcedures.h:28
itk::simple::BinaryOpeningByReconstructionImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:123
itk::simple::BinaryOpeningByReconstructionImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:62