SimpleITK  1.3.0.dev466
sitkDiffeomorphicDemonsRegistrationFilter.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 sitkDiffeomorphicDemonsRegistrationFilter_h
19 #define sitkDiffeomorphicDemonsRegistrationFilter_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 
67  public:
69 
72 
76 
79 
80 
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations ( const std::vector<double> & StandardDeviations ) { this->m_StandardDeviations = StandardDeviations; return *this; }
86 
88  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations( double value ) { this->m_StandardDeviations = std::vector<double>(3, value); return *this; }
89 
90 
94  std::vector<double> GetStandardDeviations() const { return this->m_StandardDeviations; }
95 
98  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
99 
102  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }
103 
106  SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }
107 
110  double GetMaximumRMSError() const { return this->m_MaximumRMSError; }
111 
112  typedef enum {Symmetric,Fixed,WarpedMoving,MappedMoving} UseGradientTypeType;
113 
116  SITK_RETURN_SELF_TYPE_HEADER SetUseGradientType ( UseGradientTypeType UseGradientType ) { this->m_UseGradientType = UseGradientType; return *this; }
117 
120  UseGradientTypeType GetUseGradientType() const { return this->m_UseGradientType; }
121 
125  SITK_RETURN_SELF_TYPE_HEADER SetUseFirstOrderExp ( bool UseFirstOrderExp ) { this->m_UseFirstOrderExp = UseFirstOrderExp; return *this; }
126 
128  SITK_RETURN_SELF_TYPE_HEADER UseFirstOrderExpOn() { return this->SetUseFirstOrderExp(true); }
129  SITK_RETURN_SELF_TYPE_HEADER UseFirstOrderExpOff() { return this->SetUseFirstOrderExp(false); }
130 
134  bool GetUseFirstOrderExp() const { return this->m_UseFirstOrderExp; }
135 
139  SITK_RETURN_SELF_TYPE_HEADER SetMaximumUpdateStepLength ( double MaximumUpdateStepLength ) { this->m_MaximumUpdateStepLength = MaximumUpdateStepLength; return *this; }
140 
143  double GetMaximumUpdateStepLength() const { return this->m_MaximumUpdateStepLength; }
144 
148  SITK_RETURN_SELF_TYPE_HEADER SetSmoothDisplacementField ( bool SmoothDisplacementField ) { this->m_SmoothDisplacementField = SmoothDisplacementField; return *this; }
149 
151  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOn() { return this->SetSmoothDisplacementField(true); }
152  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOff() { return this->SetSmoothDisplacementField(false); }
153 
157  bool GetSmoothDisplacementField() const { return this->m_SmoothDisplacementField; }
158 
162  SITK_RETURN_SELF_TYPE_HEADER SetSmoothUpdateField ( bool SmoothUpdateField ) { this->m_SmoothUpdateField = SmoothUpdateField; return *this; }
163 
165  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOn() { return this->SetSmoothUpdateField(true); }
166  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOff() { return this->SetSmoothUpdateField(false); }
167 
171  bool GetSmoothUpdateField() const { return this->m_SmoothUpdateField; }
172 
176  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations ( const std::vector<double> & UpdateFieldStandardDeviations ) { this->m_UpdateFieldStandardDeviations = UpdateFieldStandardDeviations; return *this; }
177 
179  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations( double value ) { this->m_UpdateFieldStandardDeviations = std::vector<double>(3, value); return *this; }
180 
181 
185  std::vector<double> GetUpdateFieldStandardDeviations() const { return this->m_UpdateFieldStandardDeviations; }
186 
190  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
191 
195  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }
196 
200  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
201 
205  double GetMaximumError() const { return this->m_MaximumError; }
206 
210  SITK_RETURN_SELF_TYPE_HEADER SetIntensityDifferenceThreshold ( double IntensityDifferenceThreshold ) { this->m_IntensityDifferenceThreshold = IntensityDifferenceThreshold; return *this; }
211 
214  double GetIntensityDifferenceThreshold() const { return this->m_IntensityDifferenceThreshold; }
215 
218  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
219 
221  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
222  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
223 
226  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
234  uint32_t GetElapsedIterations() const { return this->m_pfGetElapsedIterations(); };
235 
242  double GetRMSChange() const { return this->m_RMSChange; };
243 
251  double GetMetric() const { return this->m_pfGetMetric(); };
252 
254  std::string GetName() const { return std::string ("DiffeomorphicDemonsRegistrationFilter"); }
255 
257  std::string ToString() const;
258 
259 
261  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField );
262  Image Execute ( const Image & fixedImage, const Image & movingImage );
263 
264 
266  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField, const std::vector<double> & standardDeviations, uint32_t numberOfIterations, double maximumRMSError, DiffeomorphicDemonsRegistrationFilter::UseGradientTypeType useGradientType, bool useFirstOrderExp, double maximumUpdateStepLength, bool smoothDisplacementField, bool smoothUpdateField, const std::vector<double> & updateFieldStandardDeviations, unsigned int maximumKernelWidth, double maximumError, double intensityDifferenceThreshold, bool useImageSpacing );
267  Image Execute ( const Image & fixedImage, const Image & movingImage, const std::vector<double> & standardDeviations, uint32_t numberOfIterations, double maximumRMSError, DiffeomorphicDemonsRegistrationFilter::UseGradientTypeType useGradientType, bool useFirstOrderExp, double maximumUpdateStepLength, bool smoothDisplacementField, bool smoothUpdateField, const std::vector<double> & updateFieldStandardDeviations, unsigned int maximumKernelWidth, double maximumError, double intensityDifferenceThreshold, bool useImageSpacing );
268 
269  private:
270 
273  typedef Image (Self::*MemberFunctionType)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
274  template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
275 
276 
277  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
278 
279  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
280 
281 
282  std::vector<double> m_StandardDeviations;
283  /* Number of iterations to run */
285  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
292  std::vector<double> m_UpdateFieldStandardDeviations;
293  unsigned int m_MaximumKernelWidth;
297 
298  nsstd::function<uint32_t()> m_pfGetElapsedIterations;
299 
300  double m_RMSChange;
301 
302  nsstd::function<double()> m_pfGetMetric;
303 
304  // Holder of process object for active measurements
306  };
307 
308 
309  }
310 }
311 #endif
#define SITKBasicFilters_EXPORT
Deformably register two images using a diffeomorphic demons algorithm.
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 & SetStandardDeviations(const std::vector< double > &StandardDeviations)
::uint32_t uint32_t
The Image class for SimpleITK.
Definition: sitkImage.h:78
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Self & SetUpdateFieldStandardDeviations(const std::vector< double > &UpdateFieldStandardDeviations)
Self & SetIntensityDifferenceThreshold(double IntensityDifferenceThreshold)
The base interface for SimpleITK filters that take one input image.