SimpleITK  2.0.0rc2.post50
sitkSymmetricForcesDemonsRegistrationFilter.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 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 
68  public:
70 
73 
77 
80 \
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations ( std::vector<double> StandardDeviations ) { this->m_StandardDeviations = std::move(StandardDeviations); return *this; }
86 
88  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations( double value ) { this->m_StandardDeviations = std::vector<double>(3, value); return *this; }
89 
93  std::vector<double> GetStandardDeviations() const { return this->m_StandardDeviations; }\
94 
97  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
98 
101  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
102 
105  SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }
106 
109  double GetMaximumRMSError() const { return this->m_MaximumRMSError; }\
110 
114  SITK_RETURN_SELF_TYPE_HEADER SetSmoothDisplacementField ( bool SmoothDisplacementField ) { this->m_SmoothDisplacementField = SmoothDisplacementField; return *this; }
115 
117  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOn() { return this->SetSmoothDisplacementField(true); }
118  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOff() { return this->SetSmoothDisplacementField(false); }
119 
123  bool GetSmoothDisplacementField() const { return this->m_SmoothDisplacementField; }\
124 
128  SITK_RETURN_SELF_TYPE_HEADER SetSmoothUpdateField ( bool SmoothUpdateField ) { this->m_SmoothUpdateField = SmoothUpdateField; return *this; }
129 
131  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOn() { return this->SetSmoothUpdateField(true); }
132  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOff() { return this->SetSmoothUpdateField(false); }
133 
137  bool GetSmoothUpdateField() const { return this->m_SmoothUpdateField; }\
138 
142  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations ( std::vector<double> UpdateFieldStandardDeviations ) { this->m_UpdateFieldStandardDeviations = std::move(UpdateFieldStandardDeviations); return *this; }
143 
145  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations( double value ) { this->m_UpdateFieldStandardDeviations = std::vector<double>(3, value); return *this; }
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 
218 
220  std::string GetName() const { return std::string ("SymmetricForcesDemonsRegistrationFilter"); }
221 
223  std::string ToString() const;
224 
225 
228  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField );
229  Image Execute ( const Image & fixedImage, const Image & movingImage );
230 
231  private:
232 
235  using MemberFunctionType = Image (Self::*)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
236  template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
237 
238 
240 
241  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
242 
243 
244  std::vector<double> m_StandardDeviations{std::vector<double>(3, 1.0)};
245 
246  /* Number of iterations to run */
247  uint32_t m_NumberOfIterations{10u};
248 
249  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
250  double m_MaximumRMSError{0.02};
251 
252  bool m_SmoothDisplacementField{true};
253 
254  bool m_SmoothUpdateField{false};
255 
256  std::vector<double> m_UpdateFieldStandardDeviations{std::vector<double>(3, 1.0)};
257 
258  unsigned int m_MaximumKernelWidth{30u};
259 
260  double m_MaximumError{0.1};
261 
262  double m_IntensityDifferenceThreshold{0.001};
263 
264  bool m_UseImageSpacing{true};
265 
266 
268 
269  double m_RMSChange{0.0};
270 
271  std::function<double()> m_pfGetMetric;
272 
273  // Holder of process object for active measurements
274  itk::ProcessObject *m_Filter{nullptr};
275 
276  };
277 
278 
279  }
280 }
281 #endif
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetIntensityDifferenceThreshold
Self & SetIntensityDifferenceThreshold(double IntensityDifferenceThreshold)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:175
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetMaximumKernelWidth
Self & SetMaximumKernelWidth(unsigned int MaximumKernelWidth)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:155
itk::simple::SymmetricForcesDemonsRegistrationFilter::m_pfGetMetric
std::function< double()> m_pfGetMetric
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:271
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetMaximumRMSError
double GetMaximumRMSError() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:109
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetMaximumError
double GetMaximumError() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:170
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetUpdateFieldStandardDeviations
std::vector< double > GetUpdateFieldStandardDeviations() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:150
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetSmoothUpdateField
Self & SetSmoothUpdateField(bool SmoothUpdateField)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:128
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetNumberOfIterations
uint32_t GetNumberOfIterations() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:101
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::SymmetricForcesDemonsRegistrationFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:187
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations
Self & SetUpdateFieldStandardDeviations(double value)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:145
itk::simple::SymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOff
Self & SmoothUpdateFieldOff()
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:132
itk::simple::SymmetricForcesDemonsRegistrationFilter
Deformably register two images using the demons algorithm.
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:67
itk::simple::BasicPixelIDTypeList
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
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetSmoothUpdateField
bool GetSmoothUpdateField() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:137
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetName
std::string GetName() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:220
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetMaximumKernelWidth
unsigned int GetMaximumKernelWidth() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:160
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetElapsedIterations
uint32_t GetElapsedIterations() const
Number of iterations run.
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:199
itk::simple::SymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOn
Self & SmoothUpdateFieldOn()
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:131
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetMaximumError
Self & SetMaximumError(double MaximumError)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:165
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetRMSChange
double GetRMSChange() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:207
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:183
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetSmoothDisplacementField
Self & SetSmoothDisplacementField(bool SmoothDisplacementField)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:114
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetStandardDeviations
Self & SetStandardDeviations(std::vector< double > StandardDeviations)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:85
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations
Self & SetUpdateFieldStandardDeviations(std::vector< double > UpdateFieldStandardDeviations)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:142
itk::simple::SymmetricForcesDemonsRegistrationFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:186
itk::simple::SymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOff
Self & SmoothDisplacementFieldOff()
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:118
itk::simple::SymmetricForcesDemonsRegistrationFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:241
itk::simple::SymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOn
Self & SmoothDisplacementFieldOn()
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:117
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetMetric
double GetMetric() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:216
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetSmoothDisplacementField
bool GetSmoothDisplacementField() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:123
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetIntensityDifferenceThreshold
double GetIntensityDifferenceThreshold() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:179
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetStandardDeviations
std::vector< double > GetStandardDeviations() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:93
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetMaximumRMSError
Self & SetMaximumRMSError(double MaximumRMSError)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:105
itk
itk::simple::SymmetricForcesDemonsRegistrationFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:79
itk::simple::SymmetricForcesDemonsRegistrationFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:191
itk::ProcessObject
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::SymmetricForcesDemonsRegistrationFilter::MemberFunctionType
Image(Self::*)(const Image *fixedImage, const Image *movingImage, const Image *initialDisplacementField) MemberFunctionType
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:235
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetNumberOfIterations
Self & SetNumberOfIterations(uint32_t NumberOfIterations)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:97
itk::uint32_t
::uint32_t uint32_t
itk::simple::SymmetricForcesDemonsRegistrationFilter::m_pfGetElapsedIterations
std::function< uint32_t()> m_pfGetElapsedIterations
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:267
itk::simple::SymmetricForcesDemonsRegistrationFilter::SetStandardDeviations
Self & SetStandardDeviations(double value)
Definition: sitkSymmetricForcesDemonsRegistrationFilter.h:88