SimpleITK  1.3.0.dev466
sitkSymmetricForcesDemonsRegistrationFilter.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 sitkSymmetricForcesDemonsRegistrationFilter_h
19 #define sitkSymmetricForcesDemonsRegistrationFilter_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 
113  SITK_RETURN_SELF_TYPE_HEADER SetSmoothDisplacementField ( bool SmoothDisplacementField ) { this->m_SmoothDisplacementField = SmoothDisplacementField; return *this; }
114 
116  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOn() { return this->SetSmoothDisplacementField(true); }
117  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOff() { return this->SetSmoothDisplacementField(false); }
118 
122  bool GetSmoothDisplacementField() const { return this->m_SmoothDisplacementField; }
123 
127  SITK_RETURN_SELF_TYPE_HEADER SetSmoothUpdateField ( bool SmoothUpdateField ) { this->m_SmoothUpdateField = SmoothUpdateField; return *this; }
128 
130  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOn() { return this->SetSmoothUpdateField(true); }
131  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOff() { return this->SetSmoothUpdateField(false); }
132 
136  bool GetSmoothUpdateField() const { return this->m_SmoothUpdateField; }
137 
141  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations ( const std::vector<double> & UpdateFieldStandardDeviations ) { this->m_UpdateFieldStandardDeviations = UpdateFieldStandardDeviations; return *this; }
142 
144  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations( double value ) { this->m_UpdateFieldStandardDeviations = std::vector<double>(3, value); return *this; }
145 
146 
150  std::vector<double> GetUpdateFieldStandardDeviations() const { return this->m_UpdateFieldStandardDeviations; }
151 
155  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
156 
160  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }
161 
165  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
166 
170  double GetMaximumError() const { return this->m_MaximumError; }
171 
175  SITK_RETURN_SELF_TYPE_HEADER SetIntensityDifferenceThreshold ( double IntensityDifferenceThreshold ) { this->m_IntensityDifferenceThreshold = IntensityDifferenceThreshold; return *this; }
176 
179  double GetIntensityDifferenceThreshold() const { return this->m_IntensityDifferenceThreshold; }
180 
183  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
184 
186  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
187  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
188 
191  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
199  uint32_t GetElapsedIterations() const { return this->m_pfGetElapsedIterations(); };
200 
207  double GetRMSChange() const { return this->m_RMSChange; };
208 
216  double GetMetric() const { return this->m_pfGetMetric(); };
217 
219  std::string GetName() const { return std::string ("SymmetricForcesDemonsRegistrationFilter"); }
220 
222  std::string ToString() const;
223 
224 
226  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField );
227  Image Execute ( const Image & fixedImage, const Image & movingImage );
228 
229 
231  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField, const std::vector<double> & standardDeviations, uint32_t numberOfIterations, double maximumRMSError, bool smoothDisplacementField, bool smoothUpdateField, const std::vector<double> & updateFieldStandardDeviations, unsigned int maximumKernelWidth, double maximumError, double intensityDifferenceThreshold, bool useImageSpacing );
232  Image Execute ( const Image & fixedImage, const Image & movingImage, const std::vector<double> & standardDeviations, uint32_t numberOfIterations, double maximumRMSError, bool smoothDisplacementField, bool smoothUpdateField, const std::vector<double> & updateFieldStandardDeviations, unsigned int maximumKernelWidth, double maximumError, double intensityDifferenceThreshold, bool useImageSpacing );
233 
234  private:
235 
238  typedef Image (Self::*MemberFunctionType)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
239  template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
240 
241 
242  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
243 
244  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
245 
246 
247  std::vector<double> m_StandardDeviations;
248  /* Number of iterations to run */
250  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
254  std::vector<double> m_UpdateFieldStandardDeviations;
255  unsigned int m_MaximumKernelWidth;
259 
260  nsstd::function<uint32_t()> m_pfGetElapsedIterations;
261 
262  double m_RMSChange;
263 
264  nsstd::function<double()> m_pfGetMetric;
265 
266  // Holder of process object for active measurements
268  };
269 
270 
271  }
272 }
273 #endif
Self & SetUpdateFieldStandardDeviations(const std::vector< double > &UpdateFieldStandardDeviations)
#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
Deformably register two images using the demons algorithm.
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Self & SetStandardDeviations(const std::vector< double > &StandardDeviations)
::uint32_t uint32_t
The Image class for SimpleITK.
Definition: sitkImage.h:78
The base interface for SimpleITK filters that take one input image.