SimpleITK  2.0.0rc2.post21
sitkShapeDetectionLevelSetImageFilter.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 sitkShapeDetectionLevelSetImageFilter_h
19 #define sitkShapeDetectionLevelSetImageFilter_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 
97  public:
99 
102 
106 
109 \
110 
113  SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }
114 
117  double GetMaximumRMSError() const { return this->m_MaximumRMSError; }\
118 
121  SITK_RETURN_SELF_TYPE_HEADER SetPropagationScaling ( double PropagationScaling ) { this->m_PropagationScaling = PropagationScaling; return *this; }
122 
125  double GetPropagationScaling() const { return this->m_PropagationScaling; }\
126 
129  SITK_RETURN_SELF_TYPE_HEADER SetCurvatureScaling ( double CurvatureScaling ) { this->m_CurvatureScaling = CurvatureScaling; return *this; }
130 
133  double GetCurvatureScaling() const { return this->m_CurvatureScaling; }\
134 
137  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
138 
141  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
142 
145  SITK_RETURN_SELF_TYPE_HEADER SetReverseExpansionDirection ( bool ReverseExpansionDirection ) { this->m_ReverseExpansionDirection = ReverseExpansionDirection; return *this; }
146 
148  SITK_RETURN_SELF_TYPE_HEADER ReverseExpansionDirectionOn() { return this->SetReverseExpansionDirection(true); }
149  SITK_RETURN_SELF_TYPE_HEADER ReverseExpansionDirectionOff() { return this->SetReverseExpansionDirection(false); }
150 
153  bool GetReverseExpansionDirection() const { return this->m_ReverseExpansionDirection; }
160  uint32_t GetElapsedIterations() const { return this->m_ElapsedIterations; };
161 
168  double GetRMSChange() const { return this->m_RMSChange; };
169 
170 
172  std::string GetName() const { return std::string ("ShapeDetectionLevelSetImageFilter"); }
173 
175  std::string ToString() const;
176 
177 
179 #ifndef SWIG
180  Image Execute ( Image && initialImage, const Image & featureImage );
181 #endif
182  Image Execute ( const Image & initialImage, const Image & featureImage );
183 
184  private:
185 
188  using MemberFunctionType = Image (Self::*)( const Image * initialImage, const Image * featureImage );
189  template <class TImageType> Image ExecuteInternal ( const Image * initialImage, const Image * featureImage );
190 
191 
193 
194  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
195 
196 
197  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
198  double m_MaximumRMSError{0.02};
199 
200  /* Weight of direct propagation contribution to the speed term */
201  double m_PropagationScaling{1.0};
202 
203  /* Weight of the curvature contribution to the speed term */
204  double m_CurvatureScaling{1.0};
205 
206  /* Number of iterations to run */
207  uint32_t m_NumberOfIterations{1000u};
208 
209  /* Turn On/Off the flag which determines whether Positive or Negative speed terms will cause surface expansion. If set to TRUE then negative speed terms will cause the surface to expand and positive speed terms will cause the surface to contract. If set to FALSE (default) then positive speed terms will cause the surface to expand and negative speed terms will cause the surface to contract. This method can be safely used to reverse the expansion/contraction as appropriate to a particular application or data set. */
210  bool m_ReverseExpansionDirection{false};
211 
212  /* Level Set filter that uses propagation and curvature terms. */
213  uint32_t m_ElapsedIterations{0};
214  /* Level Set filter that uses propagation and curvature terms. */
215  double m_RMSChange{0.0};
216 
217 
218  bool m_InPlace{false};
219  };
220 
230 #ifndef SWIG
231  SITKBasicFilters_EXPORT Image ShapeDetectionLevelSet ( Image && initialImage, const Image & featureImage, double maximumRMSError = 0.02, double propagationScaling = 1.0, double curvatureScaling = 1.0, uint32_t numberOfIterations = 1000u, bool reverseExpansionDirection = false );
232 #endif
233  SITKBasicFilters_EXPORT Image ShapeDetectionLevelSet ( const Image & initialImage, const Image & featureImage, double maximumRMSError = 0.02, double propagationScaling = 1.0, double curvatureScaling = 1.0, uint32_t numberOfIterations = 1000u, bool reverseExpansionDirection = false );
234 
236  }
237 }
238 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::ShapeDetectionLevelSetImageFilter::GetRMSChange
double GetRMSChange() const
The Root Mean Square of the levelset upon termination.
Definition: sitkShapeDetectionLevelSetImageFilter.h:168
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::ShapeDetectionLevelSetImageFilter::GetElapsedIterations
uint32_t GetElapsedIterations() const
Number of iterations run.
Definition: sitkShapeDetectionLevelSetImageFilter.h:160
itk::simple::RealPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< float >, BasicPixelID< double > >::Type RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:96
itk::simple::ShapeDetectionLevelSetImageFilter
Segments structures in images based on a user supplied edge potential map.
Definition: sitkShapeDetectionLevelSetImageFilter.h:96
itk::simple::ShapeDetectionLevelSetImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(uint32_t NumberOfIterations)
Definition: sitkShapeDetectionLevelSetImageFilter.h:137
itk::simple::ShapeDetectionLevelSetImageFilter::GetMaximumRMSError
double GetMaximumRMSError() const
Definition: sitkShapeDetectionLevelSetImageFilter.h:117
sitkImageFilter.h
itk::simple::ShapeDetectionLevelSetImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkShapeDetectionLevelSetImageFilter.h:194
itk::simple::ShapeDetectionLevelSetImageFilter::ReverseExpansionDirectionOn
Self & ReverseExpansionDirectionOn()
Definition: sitkShapeDetectionLevelSetImageFilter.h:148
itk::simple::ShapeDetectionLevelSetImageFilter::MemberFunctionType
Image(Self::*)(const Image *initialImage, const Image *featureImage) MemberFunctionType
Definition: sitkShapeDetectionLevelSetImageFilter.h:188
itk::simple::ShapeDetectionLevelSetImageFilter::ReverseExpansionDirectionOff
Self & ReverseExpansionDirectionOff()
Definition: sitkShapeDetectionLevelSetImageFilter.h:149
itk::simple::ShapeDetectionLevelSetImageFilter::GetReverseExpansionDirection
bool GetReverseExpansionDirection() const
Definition: sitkShapeDetectionLevelSetImageFilter.h:153
itk::simple::ShapeDetectionLevelSetImageFilter::GetNumberOfIterations
uint32_t GetNumberOfIterations() const
Definition: sitkShapeDetectionLevelSetImageFilter.h:141
itk::simple::ShapeDetectionLevelSetImageFilter::SetMaximumRMSError
Self & SetMaximumRMSError(double MaximumRMSError)
Definition: sitkShapeDetectionLevelSetImageFilter.h:113
itk::simple::ShapeDetectionLevelSetImageFilter::GetPropagationScaling
double GetPropagationScaling() const
Definition: sitkShapeDetectionLevelSetImageFilter.h:125
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ShapeDetectionLevelSet
Image ShapeDetectionLevelSet(Image &&initialImage, const Image &featureImage, double maximumRMSError=0.02, double propagationScaling=1.0, double curvatureScaling=1.0, uint32_t numberOfIterations=1000u, bool reverseExpansionDirection=false)
Segments structures in images based on a user supplied edge potential map.
itk::simple::ShapeDetectionLevelSetImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkShapeDetectionLevelSetImageFilter.h:108
itk
itk::simple::ShapeDetectionLevelSetImageFilter::GetCurvatureScaling
double GetCurvatureScaling() const
Definition: sitkShapeDetectionLevelSetImageFilter.h:133
itk::simple::ShapeDetectionLevelSetImageFilter::GetName
std::string GetName() const
Definition: sitkShapeDetectionLevelSetImageFilter.h:172
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::ShapeDetectionLevelSetImageFilter::SetPropagationScaling
Self & SetPropagationScaling(double PropagationScaling)
Definition: sitkShapeDetectionLevelSetImageFilter.h:121
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::ShapeDetectionLevelSetImageFilter::SetReverseExpansionDirection
Self & SetReverseExpansionDirection(bool ReverseExpansionDirection)
Definition: sitkShapeDetectionLevelSetImageFilter.h:145
itk::simple::ShapeDetectionLevelSetImageFilter::SetCurvatureScaling
Self & SetCurvatureScaling(double CurvatureScaling)
Definition: sitkShapeDetectionLevelSetImageFilter.h:129