SimpleITK  
sitkObjectnessMeasureImageFilter.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 sitkObjectnessMeasureImageFilter_h
19 #define sitkObjectnessMeasureImageFilter_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 
56  public:
58 
61 
65 
68 \
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
74 
78  double GetAlpha() const { return this->m_Alpha; }\
79 
83  SITK_RETURN_SELF_TYPE_HEADER SetBeta ( double Beta ) { this->m_Beta = Beta; return *this; }
84 
88  double GetBeta() const { return this->m_Beta; }\
89 
93  SITK_RETURN_SELF_TYPE_HEADER SetGamma ( double Gamma ) { this->m_Gamma = Gamma; return *this; }
94 
98  double GetGamma() const { return this->m_Gamma; }\
99 
103  SITK_RETURN_SELF_TYPE_HEADER SetScaleObjectnessMeasure ( bool ScaleObjectnessMeasure ) { this->m_ScaleObjectnessMeasure = ScaleObjectnessMeasure; return *this; }
104 
106  SITK_RETURN_SELF_TYPE_HEADER ScaleObjectnessMeasureOn() { return this->SetScaleObjectnessMeasure(true); }
107  SITK_RETURN_SELF_TYPE_HEADER ScaleObjectnessMeasureOff() { return this->SetScaleObjectnessMeasure(false); }
108 
112  bool GetScaleObjectnessMeasure() const { return this->m_ScaleObjectnessMeasure; }\
113 
117  SITK_RETURN_SELF_TYPE_HEADER SetObjectDimension ( unsigned int ObjectDimension ) { this->m_ObjectDimension = ObjectDimension; return *this; }
118 
122  unsigned int GetObjectDimension() const { return this->m_ObjectDimension; }\
123 
127  SITK_RETURN_SELF_TYPE_HEADER SetBrightObject ( bool BrightObject ) { this->m_BrightObject = BrightObject; return *this; }
128 
130  SITK_RETURN_SELF_TYPE_HEADER BrightObjectOn() { return this->SetBrightObject(true); }
131  SITK_RETURN_SELF_TYPE_HEADER BrightObjectOff() { return this->SetBrightObject(false); }
132 
136  bool GetBrightObject() const { return this->m_BrightObject; }
137 
139  std::string GetName() const { return std::string ("ObjectnessMeasureImageFilter"); }
140 
142  std::string ToString() const;
143 
144 
147  Image Execute ( const Image& image1 );
148 
149  private:
150 
153  using MemberFunctionType = Image (Self::*)( const Image& image1 );
154  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
155 
156 
158 
159  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
160 
161 
162  double m_Alpha{0.5};
163 
164  /* Alpha */
165  double m_Beta{0.5};
166 
167  double m_Gamma{5.0};
168 
169  bool m_ScaleObjectnessMeasure{true};
170 
171  unsigned int m_ObjectDimension{1u};
172 
173  bool m_BrightObject{true};
174 
175 
176  };
177 
188  SITKBasicFilters_EXPORT Image ObjectnessMeasure ( const Image& image1, double alpha = 0.5, double beta = 0.5, double gamma = 5.0, bool scaleObjectnessMeasure = true, unsigned int objectDimension = 1u, bool brightObject = true );
189 
191 }
192 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::ObjectnessMeasureImageFilter::SetScaleObjectnessMeasure
Self & SetScaleObjectnessMeasure(bool ScaleObjectnessMeasure)
Definition: sitkObjectnessMeasureImageFilter.h:103
itk::simple::ObjectnessMeasureImageFilter::GetGamma
double GetGamma() const
Definition: sitkObjectnessMeasureImageFilter.h:98
sitkBasicFilters.h
itk::simple::ObjectnessMeasureImageFilter::SetBeta
Self & SetBeta(double Beta)
Definition: sitkObjectnessMeasureImageFilter.h:83
itk::simple::ObjectnessMeasureImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkObjectnessMeasureImageFilter.h:73
itk::simple::RealPixelIDTypeList
typelist2::typelist< BasicPixelID< float >, BasicPixelID< double > > RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:98
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::ObjectnessMeasureImageFilter
Enhance M-dimensional objects in N-dimensional images.
Definition: sitkObjectnessMeasureImageFilter.h:55
itk::simple::ObjectnessMeasureImageFilter::SetGamma
Self & SetGamma(double Gamma)
Definition: sitkObjectnessMeasureImageFilter.h:93
itk::simple::ObjectnessMeasureImageFilter::SetObjectDimension
Self & SetObjectDimension(unsigned int ObjectDimension)
Definition: sitkObjectnessMeasureImageFilter.h:117
itk::simple::ObjectnessMeasureImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkObjectnessMeasureImageFilter.h:153
sitkImageFilter.h
itk::simple::ObjectnessMeasureImageFilter::GetName
std::string GetName() const
Definition: sitkObjectnessMeasureImageFilter.h:139
itk::simple::ObjectnessMeasureImageFilter::ScaleObjectnessMeasureOff
Self & ScaleObjectnessMeasureOff()
Definition: sitkObjectnessMeasureImageFilter.h:107
itk::simple::ObjectnessMeasureImageFilter::GetAlpha
double GetAlpha() const
Definition: sitkObjectnessMeasureImageFilter.h:78
itk::simple::ObjectnessMeasureImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkObjectnessMeasureImageFilter.h:67
itk::simple::ObjectnessMeasure
Image ObjectnessMeasure(const Image &image1, double alpha=0.5, double beta=0.5, double gamma=5.0, bool scaleObjectnessMeasure=true, unsigned int objectDimension=1u, bool brightObject=true)
Enhance M-dimensional objects in N-dimensional images.
itk::simple::ObjectnessMeasureImageFilter::GetBeta
double GetBeta() const
Definition: sitkObjectnessMeasureImageFilter.h:88
itk::simple::ObjectnessMeasureImageFilter::BrightObjectOff
Self & BrightObjectOff()
Definition: sitkObjectnessMeasureImageFilter.h:131
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ObjectnessMeasureImageFilter::GetObjectDimension
unsigned int GetObjectDimension() const
Definition: sitkObjectnessMeasureImageFilter.h:122
itk::simple::ObjectnessMeasureImageFilter::BrightObjectOn
Self & BrightObjectOn()
Definition: sitkObjectnessMeasureImageFilter.h:130
itk::simple::ObjectnessMeasureImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkObjectnessMeasureImageFilter.h:159
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::ObjectnessMeasureImageFilter::SetBrightObject
Self & SetBrightObject(bool BrightObject)
Definition: sitkObjectnessMeasureImageFilter.h:127
itk::simple::ObjectnessMeasureImageFilter::GetBrightObject
bool GetBrightObject() const
Definition: sitkObjectnessMeasureImageFilter.h:136
itk::simple::ObjectnessMeasureImageFilter::ScaleObjectnessMeasureOn
Self & ScaleObjectnessMeasureOn()
Definition: sitkObjectnessMeasureImageFilter.h:106
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::ObjectnessMeasureImageFilter::GetScaleObjectnessMeasure
bool GetScaleObjectnessMeasure() const
Definition: sitkObjectnessMeasureImageFilter.h:112