SimpleITK  1.3.0.dev466
sitkOtsuThresholdImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
51  public:
53 
55  virtual ~OtsuThresholdImageFilter();
56 
60 
63 
64 
65 
70  SITK_RETURN_SELF_TYPE_HEADER SetInsideValue ( uint8_t InsideValue ) { this->m_InsideValue = InsideValue; return *this; }
71 
76  uint8_t GetInsideValue() const { return this->m_InsideValue; }
77 
82  SITK_RETURN_SELF_TYPE_HEADER SetOutsideValue ( uint8_t OutsideValue ) { this->m_OutsideValue = OutsideValue; return *this; }
83 
88  uint8_t GetOutsideValue() const { return this->m_OutsideValue; }
89 
94  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfHistogramBins ( uint32_t NumberOfHistogramBins ) { this->m_NumberOfHistogramBins = NumberOfHistogramBins; return *this; }
95 
98  uint32_t GetNumberOfHistogramBins() const { return this->m_NumberOfHistogramBins; }
99 
103  SITK_RETURN_SELF_TYPE_HEADER SetMaskOutput ( bool MaskOutput ) { this->m_MaskOutput = MaskOutput; return *this; }
104 
106  SITK_RETURN_SELF_TYPE_HEADER MaskOutputOn() { return this->SetMaskOutput(true); }
107  SITK_RETURN_SELF_TYPE_HEADER MaskOutputOff() { return this->SetMaskOutput(false); }
108 
111  bool GetMaskOutput() const { return this->m_MaskOutput; }
112 
116  SITK_RETURN_SELF_TYPE_HEADER SetMaskValue ( uint8_t MaskValue ) { this->m_MaskValue = MaskValue; return *this; }
117 
120  uint8_t GetMaskValue() const { return this->m_MaskValue; }
121 
124  SITK_RETURN_SELF_TYPE_HEADER SetReturnBinMidpoint ( bool ReturnBinMidpoint ) { this->m_ReturnBinMidpoint = ReturnBinMidpoint; return *this; }
125 
127  SITK_RETURN_SELF_TYPE_HEADER ReturnBinMidpointOn() { return this->SetReturnBinMidpoint(true); }
128  SITK_RETURN_SELF_TYPE_HEADER ReturnBinMidpointOff() { return this->SetReturnBinMidpoint(false); }
129 
132  bool GetReturnBinMidpoint() const { return this->m_ReturnBinMidpoint; }
139  double GetThreshold() const { return this->m_Threshold; };
140 
142  std::string GetName() const { return std::string ("OtsuThresholdImageFilter"); }
143 
145  std::string ToString() const;
146 
147 
149  Image Execute ( const Image & image, const Image & maskImage );
150  Image Execute ( const Image & image );
151 
152 
154  Image Execute ( const Image & image, const Image & maskImage, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue, bool returnBinMidpoint );
155  Image Execute ( const Image & image, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue, bool returnBinMidpoint );
156 
157  private:
158 
161  typedef Image (Self::*MemberFunctionType)( const Image * image, const Image * maskImage );
162  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * maskImage );
163 
164 
165  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
166 
167  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
168 
169 
176  /* Docs */
177  double m_Threshold;
178 
179  };
180 
181 
190  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 = true );
191  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 = true );
192  }
193 }
194 #endif
#define SITKBasicFilters_EXPORT
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
::uint8_t uint8_t
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=true)
Threshold an image using the Otsu Threshold.
::uint32_t uint32_t
The Image class for SimpleITK.
Definition: sitkImage.h:78
double GetThreshold() const
Get the computed threshold.
Threshold an image using the Otsu Threshold.
Self & SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins)
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Self & SetReturnBinMidpoint(bool ReturnBinMidpoint)
The base interface for SimpleITK filters that take one input image.