ITK
6.0.0
Insight Toolkit
|
#include <itkSymmetricForcesDemonsRegistrationFunction.h>
This class encapsulate the PDE which drives the demons registration algorithm (formula (5) in J.-P. Thirions's paper "Fast Non-Rigid Matching of 3D Medical Images", May 1995). It is used by SymmetricForcesDemonsRegistrationFilter to compute the output displacement field which will map a moving image onto a a fixed image.
This class was contributed by Corinne Mattmann, ETH Zurich, Switzerland. based on a variation of the DemonsRegistrationFunction. The basic modification is to use equation (5) from Thirion's paper along with the modification for avoiding large displacements when gradients have small values.
Non-integer moving image values are obtained by using interpolation. The default interpolator is of type LinearInterpolateImageFunction. The user may set other interpolators via method SetMovingImageInterpolator. Note that the input interpolator must derive from baseclass InterpolateImageFunction.
This class is templated over the fixed image type, moving image type, and the displacement field type.
Definition at line 62 of file itkSymmetricForcesDemonsRegistrationFunction.h.
Classes | |
struct | GlobalDataStruct |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static constexpr unsigned int | ImageDimension = Superclass::ImageDimension |
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField > | |
static constexpr unsigned int | ImageDimension |
Protected Types | |
using | FixedImageNeighborhoodIteratorType = ConstNeighborhoodIterator< FixedImageType > |
Protected Member Functions | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
SymmetricForcesDemonsRegistrationFunction () | |
~SymmetricForcesDemonsRegistrationFunction () override=default | |
Protected Member Functions inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > | |
PDEDeformableRegistrationFunction () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~PDEDeformableRegistrationFunction () override=default | |
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField > | |
FiniteDifferenceFunction () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~FiniteDifferenceFunction () override=default | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Attributes | |
double | m_DenominatorThreshold {} |
GradientCalculatorPointer | m_FixedImageGradientCalculator {} |
PointType | m_FixedImageOrigin {} |
SpacingType | m_FixedImageSpacing {} |
double | m_IntensityDifferenceThreshold {} |
double | m_Metric {} |
std::mutex | m_MetricCalculationMutex {} |
InterpolatorPointer | m_MovingImageInterpolator {} |
double | m_Normalizer {} |
SizeValueType | m_NumberOfPixelsProcessed {} |
double | m_RMSChange {} |
double | m_SumOfSquaredChange {} |
double | m_SumOfSquaredDifference {} |
TimeStepType | m_TimeStep {} |
Additional Inherited Members | |
Protected Attributes inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > | |
DisplacementFieldTypePointer | m_DisplacementField {} |
double | m_Energy {} |
FixedImagePointer | m_FixedImage {} |
double | m_GradientStep {} |
MovingImagePointer | m_MovingImage {} |
bool | m_NormalizeGradient {} |
Protected Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField > | |
RadiusType | m_Radius |
PixelRealType | m_ScaleCoefficients [ImageDimension] |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer = SmartPointer<const Self> |
Definition at line 72 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CoordRepType = double |
Interpolator type.
Definition at line 106 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CovariantVectorType = CovariantVector<double, Self::ImageDimension> |
Covariant vector type.
Definition at line 113 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DefaultInterpolatorType = LinearInterpolateImageFunction<MovingImageType, CoordRepType> |
Definition at line 110 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
protected |
FixedImage image neighborhood iterator type.
Definition at line 204 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorPointer = typename GradientCalculatorType::Pointer |
Definition at line 117 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorType = CentralDifferenceImageFunction<FixedImageType> |
Gradient calculator type.
Definition at line 116 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::IndexType = typename FixedImageType::IndexType |
Definition at line 87 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorPointer = typename InterpolatorType::Pointer |
Definition at line 108 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorType = InterpolateImageFunction<MovingImageType, CoordRepType> |
Definition at line 107 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Pointer = SmartPointer<Self> |
Definition at line 71 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PointType = typename InterpolatorType::PointType |
Definition at line 109 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Self = SymmetricForcesDemonsRegistrationFunction |
Standard class type aliases.
Definition at line 69 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SizeType = typename FixedImageType::SizeType |
Definition at line 88 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SpacingType = typename FixedImageType::SpacingType |
Definition at line 89 of file itkSymmetricForcesDemonsRegistrationFunction.h.
using itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass = PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField> |
Definition at line 70 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
protected |
|
overrideprotecteddefault |
|
inlineoverridevirtual |
This class uses a constant timestep of 1.
Implements itk::FiniteDifferenceFunction< TDisplacementField >.
Definition at line 135 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
overridevirtual |
Compute update at a non boundary neighbourhood.
Called by a finite difference solver image filter at each pixel that does not lie on a data set boundary.
Implements itk::FiniteDifferenceFunction< TDisplacementField >.
|
inlineoverridevirtual |
Return a pointer to a global data structure that is passed to this object from the solver at each calculation.
Implements itk::FiniteDifferenceFunction< TDisplacementField >.
Definition at line 143 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
virtual |
|
inlinevirtual |
Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the overlapping region between the two images.
Definition at line 175 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
inline |
Get the moving image interpolator.
Definition at line 128 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
overridevirtual |
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.
|
inlinevirtual |
Get the rms change in displacement field.
Definition at line 182 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
overridevirtual |
Set the object's state before each iteration.
Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.
|
overridevirtual |
Release memory for global data structure.
Updates the metric and releases the per-thread-global data.
Implements itk::FiniteDifferenceFunction< TDisplacementField >.
|
virtual |
Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.
|
inline |
Set the moving image interpolator.
Definition at line 121 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
staticconstexpr |
Inherit some enums from the superclass.
Definition at line 96 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Threshold below which the denominator term is considered zero.
Definition at line 231 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Function to compute derivatives of the fixed image.
Definition at line 222 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Definition at line 218 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Cache fixed image information.
Definition at line 217 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Threshold below which two intensity value are assumed to match.
Definition at line 234 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images.
Definition at line 239 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Mutex lock to protect modification to metric.
Definition at line 246 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Function to interpolate the moving image.
Definition at line 225 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Definition at line 219 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Definition at line 241 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Definition at line 242 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Definition at line 243 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Definition at line 240 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
The global timestep.
Definition at line 228 of file itkSymmetricForcesDemonsRegistrationFunction.h.