SimpleITK  
sitkLevelSetMotionRegistrationFilter.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 sitkLevelSetMotionRegistrationFilter_h
19 #define sitkLevelSetMotionRegistrationFilter_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::simple {
33 
66  public:
68 
71 
75 
78 \
79 
83  SITK_RETURN_SELF_TYPE_HEADER SetGradientSmoothingStandardDeviations ( double GradientSmoothingStandardDeviations ) { this->m_GradientSmoothingStandardDeviations = GradientSmoothingStandardDeviations; return *this; }
84 
87  double GetGradientSmoothingStandardDeviations() const { return this->m_GradientSmoothingStandardDeviations; }\
88 
91  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
92 
95  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
96 
99  SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }
100 
103  double GetMaximumRMSError() const { return this->m_MaximumRMSError; }\
104 
108  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations ( std::vector<double> StandardDeviations ) { this->m_StandardDeviations = std::move(StandardDeviations); return *this; }
109 
111  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations( double value ) { this->m_StandardDeviations = std::vector<double>(3, value); return *this; }
112 
116  std::vector<double> GetStandardDeviations() const { return this->m_StandardDeviations; }\
117 
121  SITK_RETURN_SELF_TYPE_HEADER SetSmoothDisplacementField ( bool SmoothDisplacementField ) { this->m_SmoothDisplacementField = SmoothDisplacementField; return *this; }
122 
124  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOn() { return this->SetSmoothDisplacementField(true); }
125  SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOff() { return this->SetSmoothDisplacementField(false); }
126 
130  bool GetSmoothDisplacementField() const { return this->m_SmoothDisplacementField; }\
131 
135  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations ( std::vector<double> UpdateFieldStandardDeviations ) { this->m_UpdateFieldStandardDeviations = std::move(UpdateFieldStandardDeviations); return *this; }
136 
138  SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations( double value ) { this->m_UpdateFieldStandardDeviations = std::vector<double>(3, value); return *this; }
139 
143  std::vector<double> GetUpdateFieldStandardDeviations() const { return this->m_UpdateFieldStandardDeviations; }\
144 
148  SITK_RETURN_SELF_TYPE_HEADER SetSmoothUpdateField ( bool SmoothUpdateField ) { this->m_SmoothUpdateField = SmoothUpdateField; return *this; }
149 
151  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOn() { return this->SetSmoothUpdateField(true); }
152  SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOff() { return this->SetSmoothUpdateField(false); }
153 
157  bool GetSmoothUpdateField() const { return this->m_SmoothUpdateField; }\
158 
162  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
163 
167  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }\
168 
172  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
173 
177  double GetMaximumError() const { return this->m_MaximumError; }\
178 
182  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
183 
186  double GetAlpha() const { return this->m_Alpha; }\
187 
191  SITK_RETURN_SELF_TYPE_HEADER SetIntensityDifferenceThreshold ( double IntensityDifferenceThreshold ) { this->m_IntensityDifferenceThreshold = IntensityDifferenceThreshold; return *this; }
192 
195  double GetIntensityDifferenceThreshold() const { return this->m_IntensityDifferenceThreshold; }\
196 
200  SITK_RETURN_SELF_TYPE_HEADER SetGradientMagnitudeThreshold ( double GradientMagnitudeThreshold ) { this->m_GradientMagnitudeThreshold = GradientMagnitudeThreshold; return *this; }
201 
204  double GetGradientMagnitudeThreshold() const { return this->m_GradientMagnitudeThreshold; }\
205 
208  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
209 
211  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
212  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
213 
216  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
223  uint32_t GetElapsedIterations() const { return this->m_ElapsedIterations; };
224 
231  double GetRMSChange() const { return this->m_RMSChange; };
232 
239  double GetMetric() const { return this->m_Metric; };
240 
241 
243  std::string GetName() const { return std::string ("LevelSetMotionRegistrationFilter"); }
244 
246  std::string ToString() const;
247 
248 
251  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField );
252  Image Execute ( const Image & fixedImage, const Image & movingImage );
253 
254  private:
255 
258  using MemberFunctionType = Image (Self::*)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
259  template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
260 
261 
263 
264  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
265 
266 
267  double m_GradientSmoothingStandardDeviations{1.0};
268 
269  /* Number of iterations to run */
270  uint32_t m_NumberOfIterations{10u};
271 
272  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
273  double m_MaximumRMSError{0.02};
274 
275  std::vector<double> m_StandardDeviations{std::vector<double>(3, 1.0)};
276 
277  bool m_SmoothDisplacementField{false};
278 
279  std::vector<double> m_UpdateFieldStandardDeviations{std::vector<double>(3, 1.0)};
280 
281  bool m_SmoothUpdateField{false};
282 
283  unsigned int m_MaximumKernelWidth{30u};
284 
285  double m_MaximumError{0.1};
286 
287  double m_Alpha{0.1};
288 
289  double m_IntensityDifferenceThreshold{0.001};
290 
291  double m_GradientMagnitudeThreshold{1e-9};
292 
293  bool m_UseImageSpacing{true};
294 
295 
296  uint32_t m_ElapsedIterations{0};
297 
298  double m_RMSChange{0.0};
299 
300  double m_Metric{0.0};
301 
302 
303  };
304 
305 
306 }
307 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::LevelSetMotionRegistrationFilter::GetGradientSmoothingStandardDeviations
double GetGradientSmoothingStandardDeviations() const
Definition: sitkLevelSetMotionRegistrationFilter.h:87
sitkBasicFilters.h
itk::simple::LevelSetMotionRegistrationFilter::SmoothDisplacementFieldOn
Self & SmoothDisplacementFieldOn()
Definition: sitkLevelSetMotionRegistrationFilter.h:124
itk::simple::LevelSetMotionRegistrationFilter::SetIntensityDifferenceThreshold
Self & SetIntensityDifferenceThreshold(double IntensityDifferenceThreshold)
Definition: sitkLevelSetMotionRegistrationFilter.h:191
itk::simple::LevelSetMotionRegistrationFilter::SetUpdateFieldStandardDeviations
Self & SetUpdateFieldStandardDeviations(std::vector< double > UpdateFieldStandardDeviations)
Definition: sitkLevelSetMotionRegistrationFilter.h:135
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::LevelSetMotionRegistrationFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkLevelSetMotionRegistrationFilter.h:212
itk::simple::LevelSetMotionRegistrationFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkLevelSetMotionRegistrationFilter.h:182
itk::simple::LevelSetMotionRegistrationFilter::GetSmoothUpdateField
bool GetSmoothUpdateField() const
Definition: sitkLevelSetMotionRegistrationFilter.h:157
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::LevelSetMotionRegistrationFilter::SetMaximumKernelWidth
Self & SetMaximumKernelWidth(unsigned int MaximumKernelWidth)
Definition: sitkLevelSetMotionRegistrationFilter.h:162
itk::simple::LevelSetMotionRegistrationFilter::GetName
std::string GetName() const
Definition: sitkLevelSetMotionRegistrationFilter.h:243
itk::simple::LevelSetMotionRegistrationFilter::GetMetric
double GetMetric() const
Definition: sitkLevelSetMotionRegistrationFilter.h:239
itk::simple::LevelSetMotionRegistrationFilter::GetSmoothDisplacementField
bool GetSmoothDisplacementField() const
Definition: sitkLevelSetMotionRegistrationFilter.h:130
itk::simple::LevelSetMotionRegistrationFilter::GetMaximumError
double GetMaximumError() const
Definition: sitkLevelSetMotionRegistrationFilter.h:177
itk::simple::LevelSetMotionRegistrationFilter::SetUpdateFieldStandardDeviations
Self & SetUpdateFieldStandardDeviations(double value)
Definition: sitkLevelSetMotionRegistrationFilter.h:138
itk::simple::LevelSetMotionRegistrationFilter::SmoothUpdateFieldOn
Self & SmoothUpdateFieldOn()
Definition: sitkLevelSetMotionRegistrationFilter.h:151
sitkImageFilter.h
itk::simple::LevelSetMotionRegistrationFilter::SetSmoothDisplacementField
Self & SetSmoothDisplacementField(bool SmoothDisplacementField)
Definition: sitkLevelSetMotionRegistrationFilter.h:121
itk::simple::LevelSetMotionRegistrationFilter::SetStandardDeviations
Self & SetStandardDeviations(double value)
Definition: sitkLevelSetMotionRegistrationFilter.h:111
itk::simple::LevelSetMotionRegistrationFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkLevelSetMotionRegistrationFilter.h:77
itk::simple::LevelSetMotionRegistrationFilter::SetStandardDeviations
Self & SetStandardDeviations(std::vector< double > StandardDeviations)
Definition: sitkLevelSetMotionRegistrationFilter.h:108
itk::simple::LevelSetMotionRegistrationFilter
Deformably register two images using level set motion.
Definition: sitkLevelSetMotionRegistrationFilter.h:65
itk::simple::LevelSetMotionRegistrationFilter::GetRMSChange
double GetRMSChange() const
The Root Mean Square of the levelset upon termination.
Definition: sitkLevelSetMotionRegistrationFilter.h:231
itk::simple::LevelSetMotionRegistrationFilter::GetStandardDeviations
std::vector< double > GetStandardDeviations() const
Definition: sitkLevelSetMotionRegistrationFilter.h:116
itk::simple::LevelSetMotionRegistrationFilter::GetAlpha
double GetAlpha() const
Definition: sitkLevelSetMotionRegistrationFilter.h:186
itk::simple::LevelSetMotionRegistrationFilter::GetNumberOfIterations
uint32_t GetNumberOfIterations() const
Definition: sitkLevelSetMotionRegistrationFilter.h:95
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::LevelSetMotionRegistrationFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkLevelSetMotionRegistrationFilter.h:208
itk::simple::LevelSetMotionRegistrationFilter::GetUpdateFieldStandardDeviations
std::vector< double > GetUpdateFieldStandardDeviations() const
Definition: sitkLevelSetMotionRegistrationFilter.h:143
itk::simple::LevelSetMotionRegistrationFilter::SetGradientMagnitudeThreshold
Self & SetGradientMagnitudeThreshold(double GradientMagnitudeThreshold)
Definition: sitkLevelSetMotionRegistrationFilter.h:200
itk::simple::LevelSetMotionRegistrationFilter::GetElapsedIterations
uint32_t GetElapsedIterations() const
Number of iterations run.
Definition: sitkLevelSetMotionRegistrationFilter.h:223
itk::simple::LevelSetMotionRegistrationFilter::SmoothDisplacementFieldOff
Self & SmoothDisplacementFieldOff()
Definition: sitkLevelSetMotionRegistrationFilter.h:125
itk::simple::LevelSetMotionRegistrationFilter::SetGradientSmoothingStandardDeviations
Self & SetGradientSmoothingStandardDeviations(double GradientSmoothingStandardDeviations)
Definition: sitkLevelSetMotionRegistrationFilter.h:83
itk::simple::LevelSetMotionRegistrationFilter::SetMaximumRMSError
Self & SetMaximumRMSError(double MaximumRMSError)
Definition: sitkLevelSetMotionRegistrationFilter.h:99
itk::simple::LevelSetMotionRegistrationFilter::GetMaximumKernelWidth
unsigned int GetMaximumKernelWidth() const
Definition: sitkLevelSetMotionRegistrationFilter.h:167
itk::simple::LevelSetMotionRegistrationFilter::MemberFunctionType
Image(Self::*)(const Image *fixedImage, const Image *movingImage, const Image *initialDisplacementField) MemberFunctionType
Definition: sitkLevelSetMotionRegistrationFilter.h:258
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::LevelSetMotionRegistrationFilter::GetIntensityDifferenceThreshold
double GetIntensityDifferenceThreshold() const
Definition: sitkLevelSetMotionRegistrationFilter.h:195
itk::simple::LevelSetMotionRegistrationFilter::SmoothUpdateFieldOff
Self & SmoothUpdateFieldOff()
Definition: sitkLevelSetMotionRegistrationFilter.h:152
itk::simple::LevelSetMotionRegistrationFilter::GetGradientMagnitudeThreshold
double GetGradientMagnitudeThreshold() const
Definition: sitkLevelSetMotionRegistrationFilter.h:204
itk::simple::LevelSetMotionRegistrationFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkLevelSetMotionRegistrationFilter.h:264
itk::simple::LevelSetMotionRegistrationFilter::SetSmoothUpdateField
Self & SetSmoothUpdateField(bool SmoothUpdateField)
Definition: sitkLevelSetMotionRegistrationFilter.h:148
itk::simple::LevelSetMotionRegistrationFilter::SetMaximumError
Self & SetMaximumError(double MaximumError)
Definition: sitkLevelSetMotionRegistrationFilter.h:172
itk::simple::LevelSetMotionRegistrationFilter::GetMaximumRMSError
double GetMaximumRMSError() const
Definition: sitkLevelSetMotionRegistrationFilter.h:103
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::LevelSetMotionRegistrationFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkLevelSetMotionRegistrationFilter.h:216
itk::simple::LevelSetMotionRegistrationFilter::SetNumberOfIterations
Self & SetNumberOfIterations(uint32_t NumberOfIterations)
Definition: sitkLevelSetMotionRegistrationFilter.h:91
itk::simple::LevelSetMotionRegistrationFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkLevelSetMotionRegistrationFilter.h:211