SimpleITK  
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::simple {
33 
52  public:
54 
57 
61 
64 \
65 
69  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfThresholds ( uint8_t NumberOfThresholds ) { this->m_NumberOfThresholds = NumberOfThresholds; return *this; }
70 
74  uint8_t GetNumberOfThresholds() const { return this->m_NumberOfThresholds; }\
75 
79  SITK_RETURN_SELF_TYPE_HEADER SetLabelOffset ( uint8_t LabelOffset ) { this->m_LabelOffset = LabelOffset; return *this; }
80 
84  uint8_t GetLabelOffset() const { return this->m_LabelOffset; }\
85 
89  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfHistogramBins ( uint32_t NumberOfHistogramBins ) { this->m_NumberOfHistogramBins = NumberOfHistogramBins; return *this; }
90 
94  uint32_t GetNumberOfHistogramBins() const { return this->m_NumberOfHistogramBins; }\
95 
99  SITK_RETURN_SELF_TYPE_HEADER SetValleyEmphasis ( bool ValleyEmphasis ) { this->m_ValleyEmphasis = ValleyEmphasis; return *this; }
100 
102  SITK_RETURN_SELF_TYPE_HEADER ValleyEmphasisOn() { return this->SetValleyEmphasis(true); }
103  SITK_RETURN_SELF_TYPE_HEADER ValleyEmphasisOff() { return this->SetValleyEmphasis(false); }
104 
108  bool GetValleyEmphasis() const { return this->m_ValleyEmphasis; }\
109 
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 
122  bool GetReturnBinMidpoint() const { return this->m_ReturnBinMidpoint; }
129  std::vector<double> GetThresholds() const { return this->m_Thresholds; };
130 
131 
133  std::string GetName() const { return std::string ("OtsuMultipleThresholdsImageFilter"); }
134 
136  std::string ToString() const;
137 
138 
141  Image Execute ( const Image& image1 );
142 
143  private:
144 
147  using MemberFunctionType = Image (Self::*)( const Image& image1 );
148  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
149 
150 
152 
153  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
154 
155 
156  uint8_t m_NumberOfThresholds{1u};
157 
158  uint8_t m_LabelOffset{0u};
159 
160  uint32_t m_NumberOfHistogramBins{128u};
161 
162  /* */
163  bool m_ValleyEmphasis{false};
164 
165  bool m_ReturnBinMidpoint{false};
166 
167 
168  std::vector<double> m_Thresholds{std::vector<double>()};
169 
170 
171  };
172 
183  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 );
184 
186 }
187 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::OtsuMultipleThresholdsImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkOtsuMultipleThresholdsImageFilter.h:147
itk::simple::OtsuMultipleThresholdsImageFilter::GetNumberOfThresholds
uint8_t GetNumberOfThresholds() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:74
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::OtsuMultipleThresholdsImageFilter
Threshold an image using multiple Otsu Thresholds.
Definition: sitkOtsuMultipleThresholdsImageFilter.h:51
itk::simple::OtsuMultipleThresholdsImageFilter::ReturnBinMidpointOff
Self & ReturnBinMidpointOff()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:117
itk::simple::OtsuMultipleThresholdsImageFilter::SetValleyEmphasis
Self & SetValleyEmphasis(bool ValleyEmphasis)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:99
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::OtsuMultipleThresholdsImageFilter::GetLabelOffset
uint8_t GetLabelOffset() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:84
itk::simple::OtsuMultipleThresholdsImageFilter::GetReturnBinMidpoint
bool GetReturnBinMidpoint() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:122
sitkImageFilter.h
itk::simple::OtsuMultipleThresholdsImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkOtsuMultipleThresholdsImageFilter.h:63
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:153
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::OtsuMultipleThresholdsImageFilter::SetLabelOffset
Self & SetLabelOffset(uint8_t LabelOffset)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:79
itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfHistogramBins
Self & SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:89
itk::simple::OtsuMultipleThresholdsImageFilter::SetReturnBinMidpoint
Self & SetReturnBinMidpoint(bool ReturnBinMidpoint)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:113
itk::simple::OtsuMultipleThresholdsImageFilter::GetNumberOfHistogramBins
uint32_t GetNumberOfHistogramBins() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:94
itk::simple::OtsuMultipleThresholdsImageFilter::GetName
std::string GetName() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:133
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::OtsuMultipleThresholdsImageFilter::ReturnBinMidpointOn
Self & ReturnBinMidpointOn()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:116
itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOff
Self & ValleyEmphasisOff()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:103
itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOn
Self & ValleyEmphasisOn()
Definition: sitkOtsuMultipleThresholdsImageFilter.h:102
itk::simple::OtsuMultipleThresholdsImageFilter::GetThresholds
std::vector< double > GetThresholds() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:129
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::OtsuMultipleThresholdsImageFilter::GetValleyEmphasis
bool GetValleyEmphasis() const
Definition: sitkOtsuMultipleThresholdsImageFilter.h:108
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfThresholds
Self & SetNumberOfThresholds(uint8_t NumberOfThresholds)
Definition: sitkOtsuMultipleThresholdsImageFilter.h:69