SimpleITK  1.3.0.dev466
sitkFastSymmetricForcesDemonsRegistrationFilter.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 sitkFastSymmetricForcesDemonsRegistrationFilter_h
19 #define sitkFastSymmetricForcesDemonsRegistrationFilter_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 
65  public:
67 
70 
74 
77 
78 
79 
83  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations ( const std::vector<double> & StandardDeviations ) { this->m_StandardDeviations = StandardDeviations; return *this; }
84 
86  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations( double value ) { this->m_StandardDeviations = std::vector<double>(3, value); return *this; }
87 
88 
92  std::vector<double> GetStandardDeviations() const { return this->m_StandardDeviations; }
93 
96  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
97 
100  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }
101 
104  SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }
105 
108  double GetMaximumRMSError() const { return this->m_MaximumRMSError; }
109 
110  typedef enum {Symmetric,Fixed,WarpedMoving,MappedMoving} UseGradientTypeType;
111 
114  SITK_RETURN_SELF_TYPE_HEADER SetUseGradientType ( UseGradientTypeType UseGradientType ) { this->m_UseGradientType = UseGradientType; return *this; }
115 
118  UseGradientTypeType GetUseGradientType() const { return this->m_UseGradientType; }
119 
122  SITK_RETURN_SELF_TYPE_HEADER SetMaximumUpdateStepLength ( double MaximumUpdateStepLength ) { this->m_MaximumUpdateStepLength = MaximumUpdateStepLength; return *this; }
123 
126  double GetMaximumUpdateStepLength() const { return this->m_MaximumUpdateStepLength; }
127 
131  SITK_RETURN_SELF_TYPE_HEADER SetSmoothDisplacementField ( bool SmoothDisplacementField ) { this->m_SmoothDisplacementField = SmoothDisplacementField; return *this; }
132 
134  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOn() { return this->SetSmoothDisplacementField(true); }
135  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOff() { return this->SetSmoothDisplacementField(false); }
136 
140  bool GetSmoothDisplacementField() const { return this->m_SmoothDisplacementField; }
141 
145  SITK_RETURN_SELF_TYPE_HEADER SetSmoothUpdateField ( bool SmoothUpdateField ) { this->m_SmoothUpdateField = SmoothUpdateField; return *this; }
146 
148  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOn() { return this->SetSmoothUpdateField(true); }
149  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOff() { return this->SetSmoothUpdateField(false); }
150 
154  bool GetSmoothUpdateField() const { return this->m_SmoothUpdateField; }
155 
159  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations ( const std::vector<double> & UpdateFieldStandardDeviations ) { this->m_UpdateFieldStandardDeviations = UpdateFieldStandardDeviations; return *this; }
160 
162  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations( double value ) { this->m_UpdateFieldStandardDeviations = std::vector<double>(3, value); return *this; }
163 
164 
168  std::vector<double> GetUpdateFieldStandardDeviations() const { return this->m_UpdateFieldStandardDeviations; }
169 
173  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
174 
178  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }
179 
183  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
184 
188  double GetMaximumError() const { return this->m_MaximumError; }
189 
193  SITK_RETURN_SELF_TYPE_HEADER SetIntensityDifferenceThreshold ( double IntensityDifferenceThreshold ) { this->m_IntensityDifferenceThreshold = IntensityDifferenceThreshold; return *this; }
194 
197  double GetIntensityDifferenceThreshold() const { return this->m_IntensityDifferenceThreshold; }
198 
201  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
202 
204  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
205  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
206 
209  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
217  uint32_t GetElapsedIterations() const { return this->m_pfGetElapsedIterations(); };
218 
225  double GetRMSChange() const { return this->m_RMSChange; };
226 
234  double GetMetric() const { return this->m_pfGetMetric(); };
235 
237  std::string GetName() const { return std::string ("FastSymmetricForcesDemonsRegistrationFilter"); }
238 
240  std::string ToString() const;
241 
242 
244  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField );
245  Image Execute ( const Image & fixedImage, const Image & movingImage );
246 
247 
249  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField, const std::vector<double> & standardDeviations, uint32_t numberOfIterations, double maximumRMSError, FastSymmetricForcesDemonsRegistrationFilter::UseGradientTypeType useGradientType, double maximumUpdateStepLength, bool smoothDisplacementField, bool smoothUpdateField, const std::vector<double> & updateFieldStandardDeviations, unsigned int maximumKernelWidth, double maximumError, double intensityDifferenceThreshold, bool useImageSpacing );
250  Image Execute ( const Image & fixedImage, const Image & movingImage, const std::vector<double> & standardDeviations, uint32_t numberOfIterations, double maximumRMSError, FastSymmetricForcesDemonsRegistrationFilter::UseGradientTypeType useGradientType, double maximumUpdateStepLength, bool smoothDisplacementField, bool smoothUpdateField, const std::vector<double> & updateFieldStandardDeviations, unsigned int maximumKernelWidth, double maximumError, double intensityDifferenceThreshold, bool useImageSpacing );
251 
252  private:
253 
256  typedef Image (Self::*MemberFunctionType)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
257  template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
258 
259 
260  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
261 
262  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
263 
264 
265  std::vector<double> m_StandardDeviations;
266  /* Number of iterations to run */
268  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
274  std::vector<double> m_UpdateFieldStandardDeviations;
275  unsigned int m_MaximumKernelWidth;
279 
280  nsstd::function<uint32_t()> m_pfGetElapsedIterations;
281 
282  double m_RMSChange;
283 
284  nsstd::function<double()> m_pfGetMetric;
285 
286  // Holder of process object for active measurements
288  };
289 
290 
291  }
292 }
293 #endif
#define SITKBasicFilters_EXPORT
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
::uint32_t uint32_t
The Image class for SimpleITK.
Definition: sitkImage.h:78
Deformably register two images using a symmetric forces demons algorithm.
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Self & SetStandardDeviations(const std::vector< double > &StandardDeviations)
Self & SetUpdateFieldStandardDeviations(const std::vector< double > &UpdateFieldStandardDeviations)
The base interface for SimpleITK filters that take one input image.