SimpleITK  2.0.0rc2.post17
sitkOtsuMultipleThresholdsImageFilter.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 sitkOtsuMultipleThresholdsImageFilter_h
19 #define sitkOtsuMultipleThresholdsImageFilter_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 
58 
62 
65 \
66 
70  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfThresholds ( uint8_t NumberOfThresholds ) { this->m_NumberOfThresholds = NumberOfThresholds; return *this; }
71 
75  uint8_t GetNumberOfThresholds() const { return this->m_NumberOfThresholds; }\
76 
80  SITK_RETURN_SELF_TYPE_HEADER SetLabelOffset ( uint8_t LabelOffset ) { this->m_LabelOffset = LabelOffset; return *this; }
81 
85  uint8_t GetLabelOffset() const { return this->m_LabelOffset; }\
86 
90  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfHistogramBins ( uint32_t NumberOfHistogramBins ) { this->m_NumberOfHistogramBins = NumberOfHistogramBins; return *this; }
91 
95  uint32_t GetNumberOfHistogramBins() const { return this->m_NumberOfHistogramBins; }\
96 
100  SITK_RETURN_SELF_TYPE_HEADER SetValleyEmphasis ( bool ValleyEmphasis ) { this->m_ValleyEmphasis = ValleyEmphasis; return *this; }
101 
103  SITK_RETURN_SELF_TYPE_HEADER ValleyEmphasisOn() { return this->SetValleyEmphasis(true); }
104  SITK_RETURN_SELF_TYPE_HEADER ValleyEmphasisOff() { return this->SetValleyEmphasis(false); }
105 
109  bool GetValleyEmphasis() const { return this->m_ValleyEmphasis; }\
110 
113  SITK_RETURN_SELF_TYPE_HEADER SetReturnBinMidpoint ( bool ReturnBinMidpoint ) { this->m_ReturnBinMidpoint = ReturnBinMidpoint; return *this; }
114 
116  SITK_RETURN_SELF_TYPE_HEADER ReturnBinMidpointOn() { return this->SetReturnBinMidpoint(true); }
117  SITK_RETURN_SELF_TYPE_HEADER ReturnBinMidpointOff() { return this->SetReturnBinMidpoint(false); }
118 
121  bool GetReturnBinMidpoint() const { return this->m_ReturnBinMidpoint; }
128  std::vector<double> GetThresholds() const { return this->m_Thresholds; };
129 
130 
132  std::string GetName() const { return std::string ("OtsuMultipleThresholdsImageFilter"); }
133 
135  std::string ToString() const;
136 
137 
140  Image Execute ( const Image& image1 );
141 
142  private:
143 
146  using MemberFunctionType = Image (Self::*)( const Image& image1 );
147  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
148 
149 
151 
152  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
153 
154 
155  uint8_t m_NumberOfThresholds{1u};
156 
157  uint8_t m_LabelOffset{0u};
158 
159  uint32_t m_NumberOfHistogramBins{128u};
160 
161  /* */
162  bool m_ValleyEmphasis{false};
163 
164  bool m_ReturnBinMidpoint{false};
165 
166 
167  std::vector<double> m_Thresholds{std::vector<double>()};
168 
169 
170  };
171 
182  SITKBasicFilters_EXPORT Image OtsuMultipleThresholds ( const Image& image1, uint8_t numberOfThresholds = 1u, uint8_t labelOffset = 0u, uint32_t numberOfHistogramBins = 128u, bool valleyEmphasis = false, bool returnBinMidpoint = false );
183 
185  }
186 }
187 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::uint8_t
::uint8_t uint8_t
itk::simple::OtsuMultipleThresholdsImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkOtsuMultipleThresholdsImageFilter.h:146
itk::simple::OtsuMultipleThresholdsImageFilter::GetNumberOfThresholds
uint8_t GetNumberOfThresholds() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:75
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::OtsuMultipleThresholdsImageFilter
Threshold an image using multiple Otsu Thresholds.
Definition: sitkOtsuMultipleThresholdsImageFilter.h:52
itk::simple::OtsuMultipleThresholdsImageFilter::ReturnBinMidpointOff
Self & ReturnBinMidpointOff()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:117
itk::simple::OtsuMultipleThresholdsImageFilter::SetValleyEmphasis
Self & SetValleyEmphasis(bool ValleyEmphasis)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:100
itk::simple::OtsuMultipleThresholdsImageFilter::GetLabelOffset
uint8_t GetLabelOffset() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:85
itk::simple::OtsuMultipleThresholdsImageFilter::GetReturnBinMidpoint
bool GetReturnBinMidpoint() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:121
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::OtsuMultipleThresholdsImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkOtsuMultipleThresholdsImageFilter.h:64
itk::simple::OtsuMultipleThresholds
Image OtsuMultipleThresholds(const Image &image1, uint8_t numberOfThresholds=1u, uint8_t labelOffset=0u, uint32_t numberOfHistogramBins=128u, bool valleyEmphasis=false, bool returnBinMidpoint=false)
Threshold an image using multiple Otsu Thresholds.
itk::simple::OtsuMultipleThresholdsImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkOtsuMultipleThresholdsImageFilter.h:152
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::OtsuMultipleThresholdsImageFilter::SetLabelOffset
Self & SetLabelOffset(uint8_t LabelOffset)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:80
itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfHistogramBins
Self & SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:90
itk::simple::OtsuMultipleThresholdsImageFilter::SetReturnBinMidpoint
Self & SetReturnBinMidpoint(bool ReturnBinMidpoint)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:113
itk::simple::OtsuMultipleThresholdsImageFilter::GetNumberOfHistogramBins
uint32_t GetNumberOfHistogramBins() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:95
itk
itk::simple::OtsuMultipleThresholdsImageFilter::GetName
std::string GetName() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:132
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::OtsuMultipleThresholdsImageFilter::ReturnBinMidpointOn
Self & ReturnBinMidpointOn()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:116
itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOff
Self & ValleyEmphasisOff()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:104
itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOn
Self & ValleyEmphasisOn()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:103
itk::simple::OtsuMultipleThresholdsImageFilter::GetThresholds
std::vector< double > GetThresholds() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:128
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::OtsuMultipleThresholdsImageFilter::GetValleyEmphasis
bool GetValleyEmphasis() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:109
itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfThresholds
Self & SetNumberOfThresholds(uint8_t NumberOfThresholds)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:70