ITK  5.3.0
Insight Toolkit
itkFastSymmetricForcesDemonsRegistrationFilter.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 itkFastSymmetricForcesDemonsRegistrationFilter_h
19 #define itkFastSymmetricForcesDemonsRegistrationFilter_h
20 
23 
24 #include "itkMultiplyImageFilter.h"
26 
27 namespace itk
28 {
72 template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
74  : public PDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>
75 {
76 public:
77  ITK_DISALLOW_COPY_AND_MOVE(FastSymmetricForcesDemonsRegistrationFilter);
78 
84 
86  itkNewMacro(Self);
87 
90 
92  using typename Superclass::FixedImageType;
93  using typename Superclass::FixedImagePointer;
94 
96  using typename Superclass::MovingImageType;
97  using typename Superclass::MovingImagePointer;
98 
100  using typename Superclass::DisplacementFieldType;
101  using typename Superclass::DisplacementFieldPointer;
102 
103  static constexpr unsigned int ImageDimension = FixedImageType::ImageDimension;
104 
109  virtual double
110  GetMetric() const;
111 
112  const double &
113  GetRMSChange() const override;
114 
122 
124  virtual void
125  SetUseGradientType(GradientType gtype);
126 
127  virtual GradientType
128  GetUseGradientType() const;
129 
134  virtual void
135  SetIntensityDifferenceThreshold(double);
136 
137  virtual double
138  GetIntensityDifferenceThreshold() const;
139 
140  virtual void
141  SetMaximumUpdateStepLength(double);
142 
143  virtual double
144  GetMaximumUpdateStepLength() const;
145 
146 protected:
148  ~FastSymmetricForcesDemonsRegistrationFilter() override = default;
149  void
150  PrintSelf(std::ostream & os, Indent indent) const override;
151 
153  void
154  InitializeIteration() override;
155 
158  void
159  AllocateUpdateBuffer() override;
160 
162  using typename Superclass::FiniteDifferenceFunctionType;
163 
166 
168  void
169  ApplyUpdate(const TimeStepType & dt) override;
170 
172  using MultiplyByConstantType =
174 
176 
179 
180 private:
184  DownCastDifferenceFunctionType();
185 
187  DownCastDifferenceFunctionType() const;
188 
191 };
192 } // end namespace itk
193 
194 #ifndef ITK_MANUAL_INSTANTIATION
195 # include "itkFastSymmetricForcesDemonsRegistrationFilter.hxx"
196 #endif
197 
198 #endif
itkExponentialDisplacementFieldImageFilter.h
itkESMDemonsRegistrationFunction.h
itk::FastSymmetricForcesDemonsRegistrationFilter::m_Multiplier
MultiplyByConstantPointer m_Multiplier
Definition: itkFastSymmetricForcesDemonsRegistrationFilter.h:189
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::FastSymmetricForcesDemonsRegistrationFilter::TimeStepType
typename FiniteDifferenceFunctionType::TimeStepType TimeStepType
Definition: itkFastSymmetricForcesDemonsRegistrationFilter.h:165
itk::FastSymmetricForcesDemonsRegistrationFilter::m_Adder
AdderPointer m_Adder
Definition: itkFastSymmetricForcesDemonsRegistrationFilter.h:190
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::FastSymmetricForcesDemonsRegistrationFilter
Deformably register two images using a symmetric forces demons algorithm.
Definition: itkFastSymmetricForcesDemonsRegistrationFilter.h:73
itk::FastSymmetricForcesDemonsRegistrationFilter::GradientType
typename DemonsRegistrationFunctionType::GradientEnum GradientType
Definition: itkFastSymmetricForcesDemonsRegistrationFilter.h:123
itkMultiplyImageFilter.h
itk::PDEDeformableRegistrationFilter::DisplacementFieldType
TDisplacementField DisplacementFieldType
Definition: itkPDEDeformableRegistrationFilter.h:102
itk::ESMDemonsRegistrationFunction
Fast implementation of the symmetric demons registration force.
Definition: itkESMDemonsRegistrationFunction.h:84
itk::FastSymmetricForcesDemonsRegistrationFilter::AdderPointer
typename AdderType::Pointer AdderPointer
Definition: itkFastSymmetricForcesDemonsRegistrationFilter.h:178
itk::FastSymmetricForcesDemonsRegistrationFilter::MultiplyByConstantPointer
typename MultiplyByConstantType::Pointer MultiplyByConstantPointer
Definition: itkFastSymmetricForcesDemonsRegistrationFilter.h:177
itk::ESMDemonsRegistrationFunctionEnums::Gradient
Gradient
Definition: itkESMDemonsRegistrationFunction.h:40
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::AddImageFilter
Pixel-wise addition of two images.
Definition: itkAddImageFilter.h:80
itkPDEDeformableRegistrationFilter.h
itk::MultiplyImageFilter
Pixel-wise multiplication of two images.
Definition: itkMultiplyImageFilter.h:43
itk::PDEDeformableRegistrationFilter
Deformably register two images using a PDE algorithm.
Definition: itkPDEDeformableRegistrationFilter.h:73
itk::FiniteDifferenceFunction< TDisplacementField >::TimeStepType
double TimeStepType
Definition: itkFiniteDifferenceFunction.h:90