SimpleITK  2.0.0rc2.post21
sitkRenyiEntropyThresholdImageFilter.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 sitkRenyiEntropyThresholdImageFilter_h
19 #define sitkRenyiEntropyThresholdImageFilter_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 
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; }
128  double GetThreshold() const { return this->m_Threshold; };
129 
130 
132  std::string GetName() const { return std::string ("RenyiEntropyThresholdImageFilter"); }
133 
135  std::string ToString() const;
136 
137 
140  Image Execute ( const Image & image, const Image & maskImage );
141  Image Execute ( const Image & image );
142 
143  private:
144 
147  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage );
148  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * maskImage );
149 
150 
152 
153  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
154 
155 
156  uint8_t m_InsideValue{1u};
157 
158  uint8_t m_OutsideValue{0u};
159 
160  uint32_t m_NumberOfHistogramBins{256u};
161 
162  bool m_MaskOutput{true};
163 
164  uint8_t m_MaskValue{255u};
165 
166  /* Docs */
167  double m_Threshold{0.0};
168 
169 
170  };
171 
182  SITKBasicFilters_EXPORT Image RenyiEntropyThreshold ( const Image & image, const Image & maskImage, uint8_t insideValue = 1u, uint8_t outsideValue = 0u, uint32_t numberOfHistogramBins = 256u, bool maskOutput = true, uint8_t maskValue = 255u );
183  SITKBasicFilters_EXPORT Image RenyiEntropyThreshold ( const Image & image, uint8_t insideValue = 1u, uint8_t outsideValue = 0u, uint32_t numberOfHistogramBins = 256u, bool maskOutput = true, uint8_t maskValue = 255u );
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::RenyiEntropyThresholdImageFilter::GetName
std::string GetName() const
Definition: sitkRenyiEntropyThresholdImageFilter.h:132
itk::simple::RenyiEntropyThresholdImageFilter::SetInsideValue
Self & SetInsideValue(uint8_t InsideValue)
Definition: sitkRenyiEntropyThresholdImageFilter.h:71
itk::simple::RenyiEntropyThresholdImageFilter::MaskOutputOn
Self & MaskOutputOn()
Definition: sitkRenyiEntropyThresholdImageFilter.h:107
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RenyiEntropyThresholdImageFilter::SetMaskValue
Self & SetMaskValue(uint8_t MaskValue)
Definition: sitkRenyiEntropyThresholdImageFilter.h:117
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::RenyiEntropyThresholdImageFilter::SetOutsideValue
Self & SetOutsideValue(uint8_t OutsideValue)
Definition: sitkRenyiEntropyThresholdImageFilter.h:83
itk::simple::RenyiEntropyThresholdImageFilter::GetInsideValue
uint8_t GetInsideValue() const
Definition: sitkRenyiEntropyThresholdImageFilter.h:77
itk::simple::RenyiEntropyThresholdImageFilter::GetThreshold
double GetThreshold() const
Get the computed threshold.
Definition: sitkRenyiEntropyThresholdImageFilter.h:128
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::RenyiEntropyThresholdImageFilter::GetOutsideValue
uint8_t GetOutsideValue() const
Definition: sitkRenyiEntropyThresholdImageFilter.h:89
itk::simple::RenyiEntropyThresholdImageFilter::GetMaskValue
uint8_t GetMaskValue() const
Definition: sitkRenyiEntropyThresholdImageFilter.h:121
itk::simple::RenyiEntropyThresholdImageFilter::SetMaskOutput
Self & SetMaskOutput(bool MaskOutput)
Definition: sitkRenyiEntropyThresholdImageFilter.h:104
itk
itk::simple::RenyiEntropyThresholdImageFilter
Threshold an image using the RenyiEntropy Threshold.
Definition: sitkRenyiEntropyThresholdImageFilter.h:52
itk::simple::RenyiEntropyThresholdImageFilter::SetNumberOfHistogramBins
Self & SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins)
Definition: sitkRenyiEntropyThresholdImageFilter.h:95
itk::simple::RenyiEntropyThresholdImageFilter::GetMaskOutput
bool GetMaskOutput() const
Definition: sitkRenyiEntropyThresholdImageFilter.h:112
itk::simple::RenyiEntropyThresholdImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRenyiEntropyThresholdImageFilter.h:153
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::RenyiEntropyThresholdImageFilter::MaskOutputOff
Self & MaskOutputOff()
Definition: sitkRenyiEntropyThresholdImageFilter.h:108
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::RenyiEntropyThreshold
Image RenyiEntropyThreshold(const Image &image, const Image &maskImage, uint8_t insideValue=1u, uint8_t outsideValue=0u, uint32_t numberOfHistogramBins=256u, bool maskOutput=true, uint8_t maskValue=255u)
Threshold an image using the RenyiEntropy Threshold.
itk::simple::RenyiEntropyThresholdImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *maskImage) MemberFunctionType
Definition: sitkRenyiEntropyThresholdImageFilter.h:147
itk::simple::RenyiEntropyThresholdImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkRenyiEntropyThresholdImageFilter.h:64
itk::simple::RenyiEntropyThresholdImageFilter::GetNumberOfHistogramBins
uint32_t GetNumberOfHistogramBins() const
Definition: sitkRenyiEntropyThresholdImageFilter.h:99