itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField > Class Template Reference
[Finite Difference Functions]
#include <itkNCCRegistrationFunction.h>
Detailed Description
template<class TFixedImage, class TMovingImage, class TDeformationField>
class itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >
This class encapsulate the PDE which drives the demons registration algorithm. It is used by NCCRegistrationFilter to compute the output deformation field which will map a moving image onto a a fixed image.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 deformation field type.
- Warning:
- This filter assumes that the fixed image type, moving image type and deformation field type all have the same number of dimensions.
- See also:
- NCCRegistrationFilter
Definition at line 53 of file itkNCCRegistrationFunction.h.
Member Typedef Documentation
| typedef SmartPointer<const Self> itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ConstPointer |
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 64 of file itkNCCRegistrationFunction.h.
| typedef double itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::CoordRepType |
Interpolator type.
Definition at line 101 of file itkNCCRegistrationFunction.h.
| typedef CovariantVector<double,itkGetStaticConstMacro(ImageDimension)> itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::CovariantVectorType |
Covariant vector type.
Definition at line 110 of file itkNCCRegistrationFunction.h.
typedef ZeroFluxNeumannBoundaryCondition<ImageType> itk::FiniteDifferenceFunction< TDeformationField >::DefaultBoundaryConditionType [inherited] |
The default boundary condition for finite difference functions that is used unless overridden in the Evaluate() method.
Definition at line 92 of file itkFiniteDifferenceFunction.h.
| typedef LinearInterpolateImageFunction<MovingImageType,CoordRepType> itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::DefaultInterpolatorType |
Definition at line 107 of file itkNCCRegistrationFunction.h.
| typedef Superclass::DeformationFieldType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::DeformationFieldType |
Deformation field type.
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 85 of file itkNCCRegistrationFunction.h.
| typedef Superclass::DeformationFieldTypePointer itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::DeformationFieldTypePointer |
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 87 of file itkNCCRegistrationFunction.h.
typedef ConstNeighborhoodIterator<FixedImageType> itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::FixedImageNeighborhoodIteratorType [protected] |
FixedImage image neighborhood iterator type.
Definition at line 156 of file itkNCCRegistrationFunction.h.
| typedef Superclass::FixedImagePointer itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::FixedImagePointer |
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 79 of file itkNCCRegistrationFunction.h.
| typedef Superclass::FixedImageType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::FixedImageType |
FixedImage image type.
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 78 of file itkNCCRegistrationFunction.h.
| typedef Superclass::FloatOffsetType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::FloatOffsetType |
A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.
Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 97 of file itkNCCRegistrationFunction.h.
| typedef GradientCalculatorType::Pointer itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GradientCalculatorPointer |
Definition at line 114 of file itkNCCRegistrationFunction.h.
| typedef CentralDifferenceImageFunction<FixedImageType> itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GradientCalculatorType |
Gradient calculator type.
Definition at line 113 of file itkNCCRegistrationFunction.h.
typedef TDeformationField itk::FiniteDifferenceFunction< TDeformationField >::ImageType [inherited] |
Extract some parameters from the image type
Definition at line 76 of file itkFiniteDifferenceFunction.h.
| typedef FixedImageType::IndexType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::IndexType |
Definition at line 80 of file itkNCCRegistrationFunction.h.
typedef int itk::LightObject::InternalReferenceCountType [protected, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
Definition at line 139 of file itkLightObject.h.
| typedef InterpolatorType::Pointer itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::InterpolatorPointer |
Definition at line 104 of file itkNCCRegistrationFunction.h.
| typedef InterpolateImageFunction<MovingImageType,CoordRepType> itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::InterpolatorType |
Definition at line 102 of file itkNCCRegistrationFunction.h.
| typedef Superclass::MovingImagePointer itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::MovingImagePointer |
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 75 of file itkNCCRegistrationFunction.h.
| typedef Superclass::MovingImageType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::MovingImageType |
MovingImage image type.
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 71 of file itkNCCRegistrationFunction.h.
typedef Vector<PixelRealType,itkGetStaticConstMacro(ImageDimension)> itk::FiniteDifferenceFunction< TDeformationField >::NeighborhoodScalesType [inherited] |
The type of data structure that holds the scales with which the neighborhood is weighted to properly account for spacing and neighborhood radius.
Definition at line 103 of file itkFiniteDifferenceFunction.h.
| typedef Superclass::NeighborhoodType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::NeighborhoodType |
The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.
Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 95 of file itkNCCRegistrationFunction.h.
typedef double itk::FiniteDifferenceFunction< TDeformationField >::PixelRealType [inherited] |
Definition at line 81 of file itkFiniteDifferenceFunction.h.
| typedef Superclass::PixelType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::PixelType |
Inherit some enums from the superclass.
Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 93 of file itkNCCRegistrationFunction.h.
| typedef SmartPointer<Self> itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::Pointer |
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 63 of file itkNCCRegistrationFunction.h.
| typedef InterpolatorType::PointType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::PointType |
Definition at line 105 of file itkNCCRegistrationFunction.h.
| typedef Superclass::RadiusType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::RadiusType |
Neighborhood radius type
Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 94 of file itkNCCRegistrationFunction.h.
| typedef NCCRegistrationFunction itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::Self |
Standard class typedefs.
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 60 of file itkNCCRegistrationFunction.h.
| typedef FixedImageType::SizeType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SizeType |
Definition at line 81 of file itkNCCRegistrationFunction.h.
| typedef FixedImageType::SpacingType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SpacingType |
Definition at line 82 of file itkNCCRegistrationFunction.h.
| typedef PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField > itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::Superclass |
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 62 of file itkNCCRegistrationFunction.h.
| typedef Superclass::TimeStepType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::TimeStepType |
Define the TimeStepType to always be double.
Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 98 of file itkNCCRegistrationFunction.h.
Constructor & Destructor Documentation
| itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::NCCRegistrationFunction | ( | ) | [protected] |
| itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::~NCCRegistrationFunction | ( | ) | [inline, protected] |
Definition at line 152 of file itkNCCRegistrationFunction.h.
Member Function Documentation
| static void itk::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when itkExceptionMacro executes. It allows the debugger to break on error.
| virtual TimeStepType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeGlobalTimeStep | ( | void * | ) | const [inline, virtual] |
This class uses a constant timestep of 1.
Implements itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 125 of file itkNCCRegistrationFunction.h.
| const NeighborhoodScalesType itk::FiniteDifferenceFunction< TDeformationField >::ComputeNeighborhoodScales | ( | ) | const [inherited] |
Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius
| virtual PixelType itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate | ( | const NeighborhoodType & | neighborhood, | |
| void * | globalData, | |||
| const FloatOffsetType & | offset = FloatOffsetType(0.0) | |||
| ) | [virtual] |
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< TDeformationField >.
| virtual Pointer itk::LightObject::CreateAnother | ( | ) | const [virtual, inherited] |
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 in itk::Object.
| virtual void itk::LightObject::Delete | ( | ) | [virtual, inherited] |
Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.
| DeformationFieldType* itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::GetDeformationField | ( | void | ) | [inline, inherited] |
Get the deformation field. This function should have been declared const. It is not for backward compatibility reasons.
Definition at line 88 of file itkPDEDeformableRegistrationFunction.h.
| double itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::GetEnergy | ( | ) | const [inline, inherited] |
Definition at line 92 of file itkPDEDeformableRegistrationFunction.h.
| const FixedImageType* itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::GetFixedImage | ( | void | ) | const [inline, inherited] |
Get the fixed image.
Definition at line 79 of file itkPDEDeformableRegistrationFunction.h.
| virtual void* itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetGlobalDataPointer | ( | ) | const [inline, virtual] |
Return a pointer to a global data structure that is passed to this object from the solver at each calculation.
Implements itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 130 of file itkNCCRegistrationFunction.h.
| double itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::GetGradientStep | ( | ) | const [inline, inherited] |
Definition at line 94 of file itkPDEDeformableRegistrationFunction.h.
| const MovingImageType* itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::GetMovingImage | ( | void | ) | const [inline, inherited] |
Get the moving image.
Definition at line 71 of file itkPDEDeformableRegistrationFunction.h.
| InterpolatorType* itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetMovingImageInterpolator | ( | void | ) | [inline] |
Get the moving image interpolator.
Definition at line 121 of file itkNCCRegistrationFunction.h.
| virtual const char* itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
| bool itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::GetNormalizeGradient | ( | ) | const [inline, inherited] |
Definition at line 96 of file itkPDEDeformableRegistrationFunction.h.
| const RadiusType& itk::FiniteDifferenceFunction< TDeformationField >::GetRadius | ( | void | ) | const [inline, inherited] |
Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.
Definition at line 146 of file itkFiniteDifferenceFunction.h.
| virtual int itk::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 106 of file itkLightObject.h.
| virtual void itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::InitializeIteration | ( | ) | [virtual] |
Set the object's state before each iteration.
Reimplemented from itk::FiniteDifferenceFunction< TDeformationField >.
| itk::FiniteDifferenceFunction< TDeformationField >::itkStaticConstMacro | ( | ImageDimension | , | |
| unsigned | int, | |||
| ImageType::ImageDimension | ||||
| ) | [inherited] |
Save image dimension.
| itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::itkStaticConstMacro | ( | ImageDimension | , | |
| unsigned | int, | |||
| Superclass::ImageDimension | ||||
| ) |
Inherit some enums from the superclass.
| static Pointer itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::LightObject.
| void itk::LightObject::Print | ( | std::ostream & | os, | |
| Indent | indent = 0 | |||
| ) | const [inherited] |
Cause the object to print itself out.
Referenced by itk::WeakPointer< ProcessObject >::Print().
| virtual void itk::LightObject::PrintHeader | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| void itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::PrintSelf | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual] |
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, TDeformationField >.
| virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| virtual void itk::LightObject::Register | ( | ) | const [virtual, inherited] |
Increase the reference count (mark as used by another object).
Reimplemented in itk::Object.
| virtual void itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ReleaseGlobalDataPointer | ( | void * | GlobalData | ) | const [inline, virtual] |
Release memory for global data structure.
Implements itk::FiniteDifferenceFunction< TDeformationField >.
Definition at line 138 of file itkNCCRegistrationFunction.h.
| void itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::SetDeformationField | ( | DeformationFieldTypePointer | ptr | ) | [inline, inherited] |
Set the deformation field image.
Definition at line 83 of file itkPDEDeformableRegistrationFunction.h.
| void itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::SetEnergy | ( | double | e | ) | [inline, inherited] |
Definition at line 91 of file itkPDEDeformableRegistrationFunction.h.
| void itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::SetFixedImage | ( | const FixedImageType * | ptr | ) | [inline, inherited] |
Set the fixed image.
Definition at line 75 of file itkPDEDeformableRegistrationFunction.h.
| void itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::SetGradientStep | ( | double | e | ) | [inline, inherited] |
Definition at line 93 of file itkPDEDeformableRegistrationFunction.h.
| void itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::SetMovingImage | ( | const MovingImageType * | ptr | ) | [inline, inherited] |
Set the moving image.
Definition at line 67 of file itkPDEDeformableRegistrationFunction.h.
| void itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SetMovingImageInterpolator | ( | InterpolatorType * | ptr | ) | [inline] |
Set the moving image interpolator.
Definition at line 117 of file itkNCCRegistrationFunction.h.
| void itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::SetNormalizeGradient | ( | bool | e | ) | [inline, inherited] |
Definition at line 95 of file itkPDEDeformableRegistrationFunction.h.
| void itk::FiniteDifferenceFunction< TDeformationField >::SetRadius | ( | const RadiusType & | r | ) | [inline, inherited] |
Sets the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.
Definition at line 141 of file itkFiniteDifferenceFunction.h.
| virtual void itk::LightObject::SetReferenceCount | ( | int | ) | [virtual, inherited] |
Sets the reference count on this object. This is a dangerous method, use it with care.
Reimplemented in itk::Object.
| void itk::FiniteDifferenceFunction< TDeformationField >::SetScaleCoefficients | ( | PixelRealType | vals[ImageDimension] | ) | [inline, inherited] |
Set the ScaleCoefficients for the difference operators. The defaults a 1.0. These can be set to take the image spacing into account.
Definition at line 152 of file itkFiniteDifferenceFunction.h.
| virtual void itk::LightObject::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented in itk::Object.
Member Data Documentation
DeformationFieldTypePointer itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::m_DeformationField [protected, inherited] |
The deformation field.
Definition at line 128 of file itkPDEDeformableRegistrationFunction.h.
double itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::m_Energy [mutable, protected, inherited] |
Definition at line 130 of file itkPDEDeformableRegistrationFunction.h.
FixedImagePointer itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::m_FixedImage [protected, inherited] |
The fixed image.
Definition at line 125 of file itkPDEDeformableRegistrationFunction.h.
double itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::m_GradientStep [mutable, protected, inherited] |
Definition at line 132 of file itkPDEDeformableRegistrationFunction.h.
MovingImagePointer itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::m_MovingImage [protected, inherited] |
The moving image.
Definition at line 122 of file itkPDEDeformableRegistrationFunction.h.
bool itk::PDEDeformableRegistrationFunction< TFixedImage , TMovingImage , TDeformationField >::m_NormalizeGradient [protected, inherited] |
Definition at line 131 of file itkPDEDeformableRegistrationFunction.h.
RadiusType itk::FiniteDifferenceFunction< TDeformationField >::m_Radius [protected, inherited] |
Definition at line 203 of file itkFiniteDifferenceFunction.h.
InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 144 of file itkLightObject.h.
SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 147 of file itkLightObject.h.
PixelRealType itk::FiniteDifferenceFunction< TDeformationField >::m_ScaleCoefficients[ImageDimension] [protected, inherited] |
Definition at line 204 of file itkFiniteDifferenceFunction.h.
The documentation for this class was generated from the following file:
