SimpleITK  1.3.0.dev466
sitkShapeDetectionLevelSetImageFilter.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 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 
85  public:
87 
90 
94 
97 
98 
99 
102  SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }
103 
106  double GetMaximumRMSError() const { return this->m_MaximumRMSError; }
107 
110  SITK_RETURN_SELF_TYPE_HEADER SetPropagationScaling ( double PropagationScaling ) { this->m_PropagationScaling = PropagationScaling; return *this; }
111 
114  double GetPropagationScaling() const { return this->m_PropagationScaling; }
115 
118  SITK_RETURN_SELF_TYPE_HEADER SetCurvatureScaling ( double CurvatureScaling ) { this->m_CurvatureScaling = CurvatureScaling; return *this; }
119 
122  double GetCurvatureScaling() const { return this->m_CurvatureScaling; }
123 
126  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
127 
130  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }
131 
134  SITK_RETURN_SELF_TYPE_HEADER SetReverseExpansionDirection ( bool ReverseExpansionDirection ) { this->m_ReverseExpansionDirection = ReverseExpansionDirection; return *this; }
135 
137  SITK_RETURN_SELF_TYPE_HEADER ReverseExpansionDirectionOn() { return this->SetReverseExpansionDirection(true); }
138  SITK_RETURN_SELF_TYPE_HEADER ReverseExpansionDirectionOff() { return this->SetReverseExpansionDirection(false); }
139 
142  bool GetReverseExpansionDirection() const { return this->m_ReverseExpansionDirection; }
149  uint32_t GetElapsedIterations() const { return this->m_ElapsedIterations; };
150 
157  double GetRMSChange() const { return this->m_RMSChange; };
158 
160  std::string GetName() const { return std::string ("ShapeDetectionLevelSetImageFilter"); }
161 
163  std::string ToString() const;
164 
165 
167  Image Execute ( const Image & initialImage, const Image & featureImage );
168 
169 
171  Image Execute ( const Image & initialImage, const Image & featureImage, double maximumRMSError, double propagationScaling, double curvatureScaling, uint32_t numberOfIterations, bool reverseExpansionDirection );
172 
173  private:
174 
177  typedef Image (Self::*MemberFunctionType)( const Image * initialImage, const Image * featureImage );
178  template <class TImageType> Image ExecuteInternal ( const Image * initialImage, const Image * featureImage );
179 
180 
181  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
182 
183  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
184 
185 
186  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
188  /* Weight of direct propagation contribution to the speed term */
190  /* Weight of the curvature contribution to the speed term */
192  /* Number of iterations to run */
194  /* 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. */
196  /* Level Set filter that uses propagation and curvature terms. */
198  /* Level Set filter that uses propagation and curvature terms. */
199  double m_RMSChange;
200 
201  };
202 
203 
212  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 );
213 
214  }
215 }
216 #endif
#define SITKBasicFilters_EXPORT
typelist::MakeTypeList< BasicPixelID< float >, BasicPixelID< double > >::Type RealPixelIDTypeList
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)
Segments structures in images based on a user supplied edge potential map.
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Segments structures in images based on a user supplied edge potential map.
::uint32_t uint32_t
The Image class for SimpleITK.
Definition: sitkImage.h:78
uint32_t GetElapsedIterations() const
Number of iterations run.
double GetRMSChange() const
The Root Mean Square of the levelset upon termination.
The base interface for SimpleITK filters that take one input image.