ITK
4.8.0
Insight Segmentation and Registration 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 61 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 const unsigned int | ImageDimension = Superclass::ImageDimension |
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField > | |
static const unsigned int | ImageDimension |
Protected Types | |
typedef ConstNeighborhoodIterator < FixedImageType > | FixedImageNeighborhoodIteratorType |
Protected Member Functions | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
SymmetricForcesDemonsRegistrationFunction () | |
~SymmetricForcesDemonsRegistrationFunction () | |
Protected Member Functions inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > | |
PDEDeformableRegistrationFunction () | |
~PDEDeformableRegistrationFunction () | |
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField > | |
FiniteDifferenceFunction () | |
~FiniteDifferenceFunction () | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Member Functions | |
void | operator= (const Self &) |
SymmetricForcesDemonsRegistrationFunction (const Self &) | |
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 | |
AtomicInt< int > | m_ReferenceCount |
typedef SmartPointer< const Self > itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer |
Definition at line 73 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef double itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CoordRepType |
Interpolator type.
Definition at line 109 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef CovariantVector< double, itkGetStaticConstMacro(ImageDimension) > itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CovariantVectorType |
Covariant vector type.
Definition at line 116 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef LinearInterpolateImageFunction< MovingImageType, CoordRepType > itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DefaultInterpolatorType |
Definition at line 113 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::DisplacementFieldType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType |
Deformation field type.
Definition at line 94 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::DisplacementFieldTypePointer itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldTypePointer |
Definition at line 96 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
protected |
FixedImage image neighborhood iterator type.
Definition at line 182 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::FixedImagePointer itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer |
Definition at line 88 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::FixedImageType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType |
FixedImage image type.
Definition at line 87 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::FloatOffsetType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FloatOffsetType |
Definition at line 105 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef GradientCalculatorType::Pointer itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorPointer |
Definition at line 120 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef CentralDifferenceImageFunction< FixedImageType > itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorType |
Gradient calculator type.
Definition at line 119 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef FixedImageType::IndexType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::IndexType |
Definition at line 89 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef InterpolatorType::Pointer itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorPointer |
Definition at line 111 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef InterpolateImageFunction< MovingImageType, CoordRepType > itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorType |
Definition at line 110 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::MovingImagePointer itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer |
Definition at line 84 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::MovingImageType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType |
MovingImage image type.
Definition at line 80 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::NeighborhoodType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::NeighborhoodType |
Definition at line 104 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::PixelType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PixelType |
Inherit some enums from the superclass.
Definition at line 102 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef SmartPointer< Self > itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Pointer |
Definition at line 72 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef InterpolatorType::PointType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PointType |
Definition at line 112 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::RadiusType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::RadiusType |
Definition at line 103 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef SymmetricForcesDemonsRegistrationFunction itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Self |
Standard class typedefs.
Definition at line 68 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef FixedImageType::SizeType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SizeType |
Definition at line 90 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef FixedImageType::SpacingType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SpacingType |
Definition at line 91 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass |
Definition at line 71 of file itkSymmetricForcesDemonsRegistrationFunction.h.
typedef Superclass::TimeStepType itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType |
Definition at line 106 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
protected |
|
inlineprotected |
Definition at line 178 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
|
inlineoverridevirtual |
This class uses a constant timestep of 1.
Implements itk::FiniteDifferenceFunction< TDisplacementField >.
Definition at line 131 of file itkSymmetricForcesDemonsRegistrationFunction.h.
References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep.
|
overridevirtual |
This method is called by a finite difference solver image filter at each pixel that does not lie on a data set boundary
Implements itk::FiniteDifferenceFunction< TDisplacementField >.
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::LightObject.
|
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 136 of file itkSymmetricForcesDemonsRegistrationFunction.h.
References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GlobalDataStruct::m_NumberOfPixelsProcessed, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GlobalDataStruct::m_SumOfSquaredChange, and itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GlobalDataStruct::m_SumOfSquaredDifference.
|
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 the overlapping region between the two images.
Definition at line 161 of file itkSymmetricForcesDemonsRegistrationFunction.h.
References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Metric.
|
inline |
Get the moving image interpolator.
Definition at line 127 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.
|
inlinevirtual |
Get the rms change in displacement field.
Definition at line 165 of file itkSymmetricForcesDemonsRegistrationFunction.h.
References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_RMSChange.
|
overridevirtual |
Set the object's state before each iteration.
Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.
|
static |
Method for creation through the object factory.
|
private |
|
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.
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 123 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
static |
Inherit some enums from the superclass.
Definition at line 99 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Threshold below which the denominator term is considered zero.
Definition at line 214 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Function to compute derivatives of the fixed image.
Definition at line 205 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Definition at line 201 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Cache fixed image information.
Definition at line 200 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Threshold below which two intensity value are assumed to match.
Definition at line 217 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 222 of file itkSymmetricForcesDemonsRegistrationFunction.h.
Referenced by itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMetric().
|
mutableprivate |
Mutex lock to protect modification to metric.
Definition at line 229 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
Function to interpolate the moving image.
Definition at line 208 of file itkSymmetricForcesDemonsRegistrationFunction.h.
Referenced by itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImageInterpolator(), and itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageInterpolator().
|
private |
Definition at line 202 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Definition at line 224 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Definition at line 225 of file itkSymmetricForcesDemonsRegistrationFunction.h.
Referenced by itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange().
|
mutableprivate |
Definition at line 226 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
mutableprivate |
Definition at line 223 of file itkSymmetricForcesDemonsRegistrationFunction.h.
|
private |
The global timestep.
Definition at line 211 of file itkSymmetricForcesDemonsRegistrationFunction.h.
Referenced by itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep().