SimpleITK  2.0.0rc2.post21
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 {
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 SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
103 
107  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
108 
112  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
113 
115  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
116  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
117 
121  bool GetFullyConnected() const { return this->m_FullyConnected; }
122 
124  std::string GetName() const { return std::string ("BinaryOpeningByReconstructionImageFilter"); }
125 
127  std::string ToString() const;
128 
129 
132  Image Execute ( const Image& image1 );
133 
134  private:
135 
138  using MemberFunctionType = Image (Self::*)( const Image& image1 );
139  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
140 
141 
143 
144  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
145 
146 
147  /* */
148  std::vector<unsigned int> m_KernelRadius{std::vector<uint32_t>(3, 1)};
149 
151 
152  double m_ForegroundValue{1.0};
153 
154  double m_BackgroundValue{0.0};
155 
156  /* */
157  bool m_FullyConnected{false};
158 
159 
160  };
161 
172  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 );
173 
175  }
176 }
177 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::BinaryOpeningByReconstructionImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:107
itk::simple::BinaryOpeningByReconstructionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:144
itk::simple::BinaryOpeningByReconstructionImageFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:116
itk::simple::BinaryOpeningByReconstructionImageFilter::SetKernelType
Self & SetKernelType(KernelEnum KernelType)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:82
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::BinaryOpeningByReconstructionImageFilter::GetKernelRadius
std::vector< unsigned int > GetKernelRadius() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:77
itk::simple::BinaryOpeningByReconstructionImageFilter::SetKernelRadius
Self & SetKernelRadius(unsigned int value)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:72
sitkImageFilter.h
itk::simple::BinaryOpeningByReconstructionImageFilter::GetKernelType
KernelEnum GetKernelType() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:87
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:97
itk::simple::BinaryOpeningByReconstructionImageFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:115
itk::simple::sitkBall
@ sitkBall
Definition: sitkKernel.h:31
itk::simple::BinaryOpeningByReconstructionImageFilter
binary morphological closing of an image.
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:51
itk::simple::BinaryOpeningByReconstructionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:138
itk::simple::BinaryOpeningByReconstructionImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:92
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::KernelEnum
KernelEnum
Definition: sitkKernel.h:29
itk::simple::BinaryOpeningByReconstructionImageFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:112
itk::simple::BinaryOpeningByReconstructionImageFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:121
itk::simple::BinaryOpeningByReconstructionImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:102
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::BinaryOpeningByReconstructionImageFilter::SetKernelRadius
Self & SetKernelRadius(std::vector< unsigned int > KernelRadius)
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:69
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::BinaryOpeningByReconstructionImageFilter::GetName
std::string GetName() const
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:124
itk::simple::BinaryOpeningByReconstructionImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryOpeningByReconstructionImageFilter.h:63
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