SimpleITK  2.0.0rc2.post17
sitkOtsuThresholdImageFilter.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 sitkOtsuThresholdImageFilter_h
19 #define sitkOtsuThresholdImageFilter_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 
53  public:
55 
57  virtual ~OtsuThresholdImageFilter();
58 
62 
65 \
66 
71  SITK_RETURN_SELF_TYPE_HEADER SetInsideValue ( uint8_t InsideValue ) { this->m_InsideValue = InsideValue; return *this; }
72 
77  uint8_t GetInsideValue() const { return this->m_InsideValue; }\
78 
83  SITK_RETURN_SELF_TYPE_HEADER SetOutsideValue ( uint8_t OutsideValue ) { this->m_OutsideValue = OutsideValue; return *this; }
84 
89  uint8_t GetOutsideValue() const { return this->m_OutsideValue; }\
90 
95  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfHistogramBins ( uint32_t NumberOfHistogramBins ) { this->m_NumberOfHistogramBins = NumberOfHistogramBins; return *this; }
96 
99  uint32_t GetNumberOfHistogramBins() const { return this->m_NumberOfHistogramBins; }\
100 
104  SITK_RETURN_SELF_TYPE_HEADER SetMaskOutput ( bool MaskOutput ) { this->m_MaskOutput = MaskOutput; return *this; }
105 
107  SITK_RETURN_SELF_TYPE_HEADER MaskOutputOn() { return this->SetMaskOutput(true); }
108  SITK_RETURN_SELF_TYPE_HEADER MaskOutputOff() { return this->SetMaskOutput(false); }
109 
112  bool GetMaskOutput() const { return this->m_MaskOutput; }\
113 
117  SITK_RETURN_SELF_TYPE_HEADER SetMaskValue ( uint8_t MaskValue ) { this->m_MaskValue = MaskValue; return *this; }
118 
121  uint8_t GetMaskValue() const { return this->m_MaskValue; }\
122 
126  SITK_RETURN_SELF_TYPE_HEADER SetReturnBinMidpoint ( bool ReturnBinMidpoint ) { this->m_ReturnBinMidpoint = ReturnBinMidpoint; return *this; }
127 
129  SITK_RETURN_SELF_TYPE_HEADER ReturnBinMidpointOn() { return this->SetReturnBinMidpoint(true); }
130  SITK_RETURN_SELF_TYPE_HEADER ReturnBinMidpointOff() { return this->SetReturnBinMidpoint(false); }
131 
135  bool GetReturnBinMidpoint() const { return this->m_ReturnBinMidpoint; }
142  double GetThreshold() const { return this->m_Threshold; };
143 
144 
146  std::string GetName() const { return std::string ("OtsuThresholdImageFilter"); }
147 
149  std::string ToString() const;
150 
151 
154  Image Execute ( const Image & image, const Image & maskImage );
155  Image Execute ( const Image & image );
156 
157  private:
158 
161  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage );
162  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * maskImage );
163 
164 
166 
167  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
168 
169 
170  uint8_t m_InsideValue{1u};
171 
172  uint8_t m_OutsideValue{0u};
173 
174  uint32_t m_NumberOfHistogramBins{128u};
175 
176  bool m_MaskOutput{true};
177 
178  uint8_t m_MaskValue{255u};
179 
180  bool m_ReturnBinMidpoint{false};
181 
182  /* Docs */
183  double m_Threshold{0.0};
184 
185 
186  };
187 
198  SITKBasicFilters_EXPORT Image OtsuThreshold ( const Image & image, const Image & maskImage, uint8_t insideValue = 1u, uint8_t outsideValue = 0u, uint32_t numberOfHistogramBins = 128u, bool maskOutput = true, uint8_t maskValue = 255u, bool returnBinMidpoint = false );
199  SITKBasicFilters_EXPORT Image OtsuThreshold ( const Image & image, uint8_t insideValue = 1u, uint8_t outsideValue = 0u, uint32_t numberOfHistogramBins = 128u, bool maskOutput = true, uint8_t maskValue = 255u, bool returnBinMidpoint = false );
201  }
202 }
203 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::uint8_t
::uint8_t uint8_t
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::OtsuThresholdImageFilter::SetMaskOutput
Self & SetMaskOutput(bool MaskOutput)
Definition: sitkOtsuThresholdImageFilter.h:104
itk::simple::OtsuThresholdImageFilter::SetNumberOfHistogramBins
Self & SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins)
Definition: sitkOtsuThresholdImageFilter.h:95
itk::simple::OtsuThresholdImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkOtsuThresholdImageFilter.h:167
itk::simple::OtsuThresholdImageFilter::ReturnBinMidpointOn
Self & ReturnBinMidpointOn()
Definition: sitkOtsuThresholdImageFilter.h:129
itk::simple::OtsuThresholdImageFilter::MaskOutputOn
Self & MaskOutputOn()
Definition: sitkOtsuThresholdImageFilter.h:107
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::OtsuThresholdImageFilter::GetNumberOfHistogramBins
uint32_t GetNumberOfHistogramBins() const
Definition: sitkOtsuThresholdImageFilter.h:99
itk::simple::OtsuThresholdImageFilter::SetReturnBinMidpoint
Self & SetReturnBinMidpoint(bool ReturnBinMidpoint)
Definition: sitkOtsuThresholdImageFilter.h:126
itk::simple::OtsuThreshold
Image OtsuThreshold(const Image &image, const Image &maskImage, uint8_t insideValue=1u, uint8_t outsideValue=0u, uint32_t numberOfHistogramBins=128u, bool maskOutput=true, uint8_t maskValue=255u, bool returnBinMidpoint=false)
Threshold an image using the Otsu Threshold.
itk::simple::OtsuThresholdImageFilter::GetMaskOutput
bool GetMaskOutput() const
Definition: sitkOtsuThresholdImageFilter.h:112
itk::simple::OtsuThresholdImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkOtsuThresholdImageFilter.h:64
itk::simple::OtsuThresholdImageFilter::SetMaskValue
Self & SetMaskValue(uint8_t MaskValue)
Definition: sitkOtsuThresholdImageFilter.h:117
itk::simple::OtsuThresholdImageFilter::SetInsideValue
Self & SetInsideValue(uint8_t InsideValue)
Definition: sitkOtsuThresholdImageFilter.h:71
itk::simple::OtsuThresholdImageFilter
Threshold an image using the Otsu Threshold.
Definition: sitkOtsuThresholdImageFilter.h:52
itk::simple::OtsuThresholdImageFilter::ReturnBinMidpointOff
Self & ReturnBinMidpointOff()
Definition: sitkOtsuThresholdImageFilter.h:130
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::OtsuThresholdImageFilter::GetInsideValue
uint8_t GetInsideValue() const
Definition: sitkOtsuThresholdImageFilter.h:77
itk::simple::OtsuThresholdImageFilter::GetMaskValue
uint8_t GetMaskValue() const
Definition: sitkOtsuThresholdImageFilter.h:121
itk::simple::OtsuThresholdImageFilter::GetReturnBinMidpoint
bool GetReturnBinMidpoint() const
Definition: sitkOtsuThresholdImageFilter.h:135
itk::simple::OtsuThresholdImageFilter::SetOutsideValue
Self & SetOutsideValue(uint8_t OutsideValue)
Definition: sitkOtsuThresholdImageFilter.h:83
itk
itk::simple::OtsuThresholdImageFilter::GetOutsideValue
uint8_t GetOutsideValue() const
Definition: sitkOtsuThresholdImageFilter.h:89
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::OtsuThresholdImageFilter::GetName
std::string GetName() const
Definition: sitkOtsuThresholdImageFilter.h:146
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::OtsuThresholdImageFilter::MaskOutputOff
Self & MaskOutputOff()
Definition: sitkOtsuThresholdImageFilter.h:108
itk::simple::OtsuThresholdImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *maskImage) MemberFunctionType
Definition: sitkOtsuThresholdImageFilter.h:161
itk::simple::OtsuThresholdImageFilter::GetThreshold
double GetThreshold() const
Get the computed threshold.
Definition: sitkOtsuThresholdImageFilter.h:142