SimpleITK  1.3.0.dev466
sitkLiThresholdImageFilter.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 sitkLiThresholdImageFilter_h
19 #define sitkLiThresholdImageFilter_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 ~LiThresholdImageFilter();
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 ("LiThresholdImageFilter"); }
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 LiThreshold ( 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 LiThreshold ( 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
double GetThreshold() const
Get the computed threshold.
#define SITKBasicFilters_EXPORT
Threshold an image using the Li Threshold.
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
Self & SetOutsideValue(uint8_t OutsideValue)
Self & SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins)
::uint8_t uint8_t
::uint32_t uint32_t
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
The Image class for SimpleITK.
Definition: sitkImage.h:78
Image LiThreshold(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 Li Threshold.
The base interface for SimpleITK filters that take one input image.