SimpleITK  1.1.0
sitkIsoDataThresholdImageFilter.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 sitkIsoDataThresholdImageFilter_h
19 #define sitkIsoDataThresholdImageFilter_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 ~IsoDataThresholdImageFilter();
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; }
127  double GetThreshold() const { return this->m_Threshold; };
128 
130  std::string GetName() const { return std::string ("IsoDataThresholdImageFilter"); }
131 
133  std::string ToString() const;
134 
135 
137  Image Execute ( const Image & image, const Image & maskImage );
138  Image Execute ( const Image & image );
139 
140 
142  Image Execute ( const Image & image, const Image & maskImage, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue );
143  Image Execute ( const Image & image, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue );
144 
145  private:
146 
149  typedef Image (Self::*MemberFunctionType)( const Image * image, const Image * maskImage );
150  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * maskImage );
151 
152 
153  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
154 
155  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
156 
157 
163  /* Docs */
164  double m_Threshold;
165 
166  };
167 
168 
177  SITKBasicFilters_EXPORT Image IsoDataThreshold ( 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 );
178  SITKBasicFilters_EXPORT Image IsoDataThreshold ( const Image & image, uint8_t insideValue = 1u, uint8_t outsideValue = 0u, uint32_t numberOfHistogramBins = 256u, bool maskOutput = true, uint8_t maskValue = 255u );
179  }
180 }
181 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::uint8_t
::uint8_t uint8_t
itk::simple::IsoDataThresholdImageFilter::SetInsideValue
Self & SetInsideValue(uint8_t InsideValue)
Definition: sitkIsoDataThresholdImageFilter.h:70
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::IsoDataThresholdImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkIsoDataThresholdImageFilter.h:62
itk::simple::IsoDataThresholdImageFilter::GetNumberOfHistogramBins
uint32_t GetNumberOfHistogramBins() const
Definition: sitkIsoDataThresholdImageFilter.h:98
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::IsoDataThresholdImageFilter
Threshold an image using the IsoData Threshold.
Definition: sitkIsoDataThresholdImageFilter.h:50
itk::simple::IsoDataThresholdImageFilter::SetMaskValue
Self & SetMaskValue(uint8_t MaskValue)
Definition: sitkIsoDataThresholdImageFilter.h:116
itk::simple::IsoDataThresholdImageFilter::GetOutsideValue
uint8_t GetOutsideValue() const
Definition: sitkIsoDataThresholdImageFilter.h:88
itk::simple::IsoDataThresholdImageFilter::Self
IsoDataThresholdImageFilter Self
Definition: sitkIsoDataThresholdImageFilter.h:52
itk::simple::IsoDataThresholdImageFilter::GetInsideValue
uint8_t GetInsideValue() const
Definition: sitkIsoDataThresholdImageFilter.h:76
itk::simple::IsoDataThresholdImageFilter::GetMaskValue
uint8_t GetMaskValue() const
Definition: sitkIsoDataThresholdImageFilter.h:120
itk::simple::IsoDataThresholdImageFilter::SetMaskOutput
Self & SetMaskOutput(bool MaskOutput)
Definition: sitkIsoDataThresholdImageFilter.h:103
itk::simple::IsoDataThresholdImageFilter::m_InsideValue
uint8_t m_InsideValue
Definition: sitkIsoDataThresholdImageFilter.h:158
itk::simple::IsoDataThreshold
Image IsoDataThreshold(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 IsoData Threshold.
itk::simple::IsoDataThresholdImageFilter::m_OutsideValue
uint8_t m_OutsideValue
Definition: sitkIsoDataThresholdImageFilter.h:159
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::IsoDataThresholdImageFilter::GetName
std::string GetName() const
Definition: sitkIsoDataThresholdImageFilter.h:130
itk::simple::IsoDataThresholdImageFilter::GetThreshold
double GetThreshold() const
Get the computed threshold.
Definition: sitkIsoDataThresholdImageFilter.h:127
itk::simple::IsoDataThresholdImageFilter::MaskOutputOff
Self & MaskOutputOff()
Definition: sitkIsoDataThresholdImageFilter.h:107
itk::simple::IsoDataThresholdImageFilter::m_Threshold
double m_Threshold
Definition: sitkIsoDataThresholdImageFilter.h:164
itk
itk::simple::IsoDataThresholdImageFilter::m_MaskValue
uint8_t m_MaskValue
Definition: sitkIsoDataThresholdImageFilter.h:162
itk::simple::IsoDataThresholdImageFilter::SetOutsideValue
Self & SetOutsideValue(uint8_t OutsideValue)
Definition: sitkIsoDataThresholdImageFilter.h:82
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::IsoDataThresholdImageFilter::GetMaskOutput
bool GetMaskOutput() const
Definition: sitkIsoDataThresholdImageFilter.h:111
itk::uint32_t
::uint32_t uint32_t
itk::simple::IsoDataThresholdImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkIsoDataThresholdImageFilter.h:155
itk::simple::IsoDataThresholdImageFilter::MaskOutputOn
Self & MaskOutputOn()
Definition: sitkIsoDataThresholdImageFilter.h:106
itk::simple::IsoDataThresholdImageFilter::SetNumberOfHistogramBins
Self & SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins)
Definition: sitkIsoDataThresholdImageFilter.h:94
itk::simple::IsoDataThresholdImageFilter::m_MaskOutput
bool m_MaskOutput
Definition: sitkIsoDataThresholdImageFilter.h:161
itk::simple::IsoDataThresholdImageFilter::m_NumberOfHistogramBins
uint32_t m_NumberOfHistogramBins
Definition: sitkIsoDataThresholdImageFilter.h:160