SimpleITK  
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
32namespace itk::simple {
33
67 public:
69
72
76
79\
80
84 SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations ( std::vector<double> StandardDeviations ) { this->m_StandardDeviations = std::move(StandardDeviations); return *this; }
85
87 SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations( double value ) { this->m_StandardDeviations = std::vector<double>(3, value); return *this; }
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
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 ( std::vector<double> UpdateFieldStandardDeviations ) { this->m_UpdateFieldStandardDeviations = std::move(UpdateFieldStandardDeviations); return *this; }
142
144 SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations( double value ) { this->m_UpdateFieldStandardDeviations = std::vector<double>(3, value); return *this; }
145
149 std::vector<double> GetUpdateFieldStandardDeviations() const { return this->m_UpdateFieldStandardDeviations; }\
150
154 SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
155
159 unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }\
160
164 SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
165
169 double GetMaximumError() const { return this->m_MaximumError; }\
170
174 SITK_RETURN_SELF_TYPE_HEADER SetIntensityDifferenceThreshold ( double IntensityDifferenceThreshold ) { this->m_IntensityDifferenceThreshold = IntensityDifferenceThreshold; return *this; }
175
179
182 SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
183
185 SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
186 SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
187
190 bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
198 uint32_t GetElapsedIterations() const { return this->m_pfGetElapsedIterations(); };
199
206 double GetRMSChange() const { return this->m_RMSChange; };
207
215 double GetMetric() const { return this->m_pfGetMetric(); };
216
224 void StopRegistration() { return this->m_pfGetStopRegistration(); };
225
226
228 std::string GetName() const { return std::string ("SymmetricForcesDemonsRegistrationFilter"); }
229
231 std::string ToString() const;
232
233
235
236 Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField );
237 Image Execute ( const Image & fixedImage, const Image & movingImage );
238
239 private:
240
242
243 using MemberFunctionType = Image (Self::*)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
244 template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
245
246
248
249 std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
250
251
252 std::vector<double> m_StandardDeviations{std::vector<double>(3, 1.0)};
253
254 /* Number of iterations to run */
255 uint32_t m_NumberOfIterations{10u};
256
257 /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
258 double m_MaximumRMSError{0.02};
259
261
263
264 std::vector<double> m_UpdateFieldStandardDeviations{std::vector<double>(3, 1.0)};
265
266 unsigned int m_MaximumKernelWidth{30u};
267
268 double m_MaximumError{0.1};
269
271
273
274
275 std::function<uint32_t()> m_pfGetElapsedIterations;
276
277 double m_RMSChange{0.0};
278
279 std::function<double()> m_pfGetMetric;
280
281 std::function<void()> m_pfGetStopRegistration;
282
283 // Holder of process object for active measurements
285
286 };
287
288
289}
290#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
Image Execute(const Image &fixedImage, const Image &movingImage, const Image &initialDisplacementField)
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Image(Self::*)(const Image *fixedImage, const Image *movingImage, const Image *initialDisplacementField) MemberFunctionType
Image Execute(const Image &fixedImage, const Image &movingImage)
Image ExecuteInternal(const Image *fixedImage, const Image *movingImage, const Image *initialDisplacementField)
Self & SetUpdateFieldStandardDeviations(std::vector< double > UpdateFieldStandardDeviations)
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
#define SITKBasicFilters_EXPORT