ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
#include <itkPDEDeformableRegistrationFilter.h>
Deformably register two images using a PDE algorithm.
PDEDeformableRegistrationFilter is a base case for filter implementing a PDE deformable algorithm that register two images by computing the displacement field which will map a moving image onto a fixed image.
A displacement field is represented as a image whose pixel type is some vector type with at least N elements, where N is the dimension of the fixed image. The vector type must support element access via operator []. It is assumed that the vector elements behave like floating point scalars.
This class is templated over the fixed image type, moving image type and the displacement Field type.
The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial displacement field maybe set via SetInitialDisplacementField or SetInput. If no initial field is set, a zero field is used as the initial condition.
The output displacement field can be obtained via methods GetOutput or GetDisplacementField.
The PDE algorithm is run for a user defined number of iterations. Typically the PDE algorithm requires period Gaussin smoothing of the displacement field to enforce an elastic-like condition. The amount of smoothing is governed by a set of user defined standard deviations (one for each dimension).
In terms of memory, this filter keeps two internal buffers: one for storing the intermediate updates to the field and one for double-buffering when smoothing the displacement field. Both buffers are the same type and size as the output displacement field.
This class make use of the finite difference solver hierarchy. Update for each iteration is computed using a PDEDeformableRegistrationFunction.
Definition at line 73 of file itkPDEDeformableRegistrationFilter.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | DisplacementFieldPointer = typename DisplacementFieldType::Pointer |
using | DisplacementFieldType = TDisplacementField |
using | FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType |
using | FixedImageConstPointer = typename FixedImageType::ConstPointer |
using | FixedImagePointer = typename FixedImageType::Pointer |
using | FixedImageType = TFixedImage |
using | MovingImageConstPointer = typename MovingImageType::ConstPointer |
using | MovingImagePointer = typename MovingImageType::Pointer |
using | MovingImageType = TMovingImage |
using | OutputImageType = typename Superclass::OutputImageType |
using | PDEDeformableRegistrationFunctionType = PDEDeformableRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType > |
using | Pointer = SmartPointer< Self > |
using | Self = PDEDeformableRegistrationFilter |
using | StandardDeviationsType = FixedArray< double, ImageDimension > |
using | Superclass = DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField > |
Public Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField > | |
using | ConstPointer = SmartPointer< const Self > |
using | FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType |
using | InputImageType = typename Superclass::InputImageType |
using | OutputImageType = typename Superclass::OutputImageType |
using | PixelType = typename Superclass::PixelType |
using | Pointer = SmartPointer< Self > |
using | Self = DenseFiniteDifferenceImageFilter |
using | Superclass = FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField > |
using | TimeStepType = typename Superclass::TimeStepType |
using | UpdateBufferType = OutputImageType |
Public Types inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField > | |
using | ConstPointer = SmartPointer< const Self > |
using | FiniteDifferenceFunctionType = FiniteDifferenceFunction< TDisplacementField > |
using | InputImageType = TDisplacementField |
using | InputPixelType = typename TDisplacementField::PixelType |
using | InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType |
using | NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType |
using | OutputImageType = TDisplacementField |
using | OutputPixelType = typename TDisplacementField::PixelType |
using | OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType |
using | PixelType = OutputPixelType |
using | Pointer = SmartPointer< Self > |
using | RadiusType = typename FiniteDifferenceFunctionType::RadiusType |
using | Self = FiniteDifferenceImageFilter |
using | Superclass = InPlaceImageFilter< TDisplacementField, TDisplacementField > |
using | TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType |
Public Types inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField > | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageType = TDisplacementField |
using | OutputImagePixelType = typename Superclass::OutputImagePixelType |
using | OutputImagePointer = typename Superclass::OutputImagePointer |
using | OutputImageRegionType = typename Superclass::OutputImageRegionType |
using | OutputImageType = typename Superclass::OutputImageType |
using | Pointer = SmartPointer< Self > |
using | Self = InPlaceImageFilter |
using | Superclass = ImageToImageFilter< TDisplacementField, TDisplacementField > |
Public Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField > | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageType = TDisplacementField |
using | OutputImagePixelType = typename Superclass::OutputImagePixelType |
using | OutputImageRegionType = typename Superclass::OutputImageRegionType |
using | Pointer = SmartPointer< Self > |
using | Self = ImageToImageFilter |
using | Superclass = ImageSource< TDisplacementField > |
Public Types inherited from itk::ImageSource< TDisplacementField > | |
using | ConstPointer = SmartPointer< const Self > |
using | DataObjectIdentifierType = Superclass::DataObjectIdentifierType |
using | DataObjectPointer = DataObject::Pointer |
using | DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType |
using | OutputImagePixelType = typename OutputImageType::PixelType |
using | OutputImagePointer = typename OutputImageType::Pointer |
using | OutputImageRegionType = typename OutputImageType::RegionType |
using | OutputImageType = TDisplacementField |
using | Pointer = SmartPointer< Self > |
using | Self = ImageSource |
using | Superclass = ProcessObject |
Public Types inherited from itk::ProcessObject | |
using | ConstPointer = SmartPointer< const Self > |
using | DataObjectIdentifierType = DataObject::DataObjectIdentifierType |
using | DataObjectPointer = DataObject::Pointer |
using | DataObjectPointerArray = std::vector< DataObjectPointer > |
using | DataObjectPointerArraySizeType = DataObjectPointerArray::size_type |
using | MultiThreaderType = MultiThreaderBase |
using | NameArray = std::vector< DataObjectIdentifierType > |
using | Pointer = SmartPointer< Self > |
using | Self = ProcessObject |
using | Superclass = Object |
Public Types inherited from itk::Object | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = Object |
using | Superclass = LightObject |
Public Types inherited from itk::LightObject | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = LightObject |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
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::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField > | |
static constexpr unsigned int | ImageDimension |
Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField > | |
static constexpr unsigned int | ImageDimension |
Static Public Attributes inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField > | |
static constexpr unsigned int | InputImageDimension |
static constexpr unsigned int | OutputImageDimension |
Static Public Attributes inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField > | |
static constexpr unsigned int | InputImageDimension |
static constexpr unsigned int | OutputImageDimension |
Static Public Attributes inherited from itk::ImageSource< TDisplacementField > | |
static constexpr unsigned int | OutputImageDimension |
Private Attributes | |
double | m_MaximumError |
unsigned int | m_MaximumKernelWidth |
bool | m_SmoothDisplacementField |
bool | m_SmoothUpdateField |
StandardDeviationsType | m_StandardDeviations |
bool | m_StopRegistrationFlag |
DisplacementFieldPointer | m_TempField |
StandardDeviationsType | m_UpdateFieldStandardDeviations |
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer = SmartPointer< const Self > |
Definition at line 83 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldPointer = typename DisplacementFieldType::Pointer |
Definition at line 104 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType = TDisplacementField |
Deformation field type.
Definition at line 103 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType |
FiniteDifferenceFunction type.
Definition at line 110 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImageConstPointer = typename FixedImageType::ConstPointer |
Definition at line 95 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer = typename FixedImageType::Pointer |
Definition at line 94 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType = TFixedImage |
FixedImage image type.
Definition at line 93 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImageConstPointer = typename MovingImageType::ConstPointer |
Definition at line 100 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer = typename MovingImageType::Pointer |
Definition at line 99 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType = TMovingImage |
MovingImage image type.
Definition at line 98 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::OutputImageType = typename Superclass::OutputImageType |
Types inherithed from the superclass
Definition at line 107 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunctionType = PDEDeformableRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType > |
PDEDeformableRegistrationFilterFunction type.
Definition at line 114 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Pointer = SmartPointer< Self > |
Definition at line 82 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Self = PDEDeformableRegistrationFilter |
Standard class type aliases.
Definition at line 80 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::StandardDeviationsType = FixedArray< double, ImageDimension > |
Definition at line 158 of file itkPDEDeformableRegistrationFilter.h.
using itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Superclass = DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField > |
Definition at line 81 of file itkPDEDeformableRegistrationFilter.h.
|
protected |
|
overrideprotecteddefault |
|
overrideprotectedvirtual |
A simple method to copy the data from the input to the output. If the input does not exist, a zero field is written to the output.
Implements itk::FiniteDifferenceImageFilter< TDisplacementField, 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::Object.
Reimplemented in itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.
|
overrideprotectedvirtual |
It is difficult to compute in advance the input moving image region required to compute the requested output region. Thus the safest thing to do is to request for the whole moving image.
For the fixed image and displacement field, the input requested region set to be the same as that of the output requested region.
Reimplemented from itk::ProcessObject.
|
overrideprotectedvirtual |
By default the output displacement field has the same Spacing, Origin and LargestPossibleRegion as the input/initial displacement field. If the initial displacement field is not set, the output information is copied from the fixed image.
Reimplemented from itk::ProcessObject.
|
inline |
Get output displacement field.
Definition at line 138 of file itkPDEDeformableRegistrationFilter.h.
|
virtual |
Get the fixed image.
|
virtual |
Get initial displacement field.
|
virtual |
Set/Get the desired maximum error of the Gaussian kernel approximate.
|
virtual |
Set/Get the desired limits of the Gaussian kernel width.
|
virtual |
Get the moving image.
|
virtual |
Run-time type information (and related methods)
Reimplemented from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.
Reimplemented in itk::CurvatureRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TImageForceFunction >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DiffeomorphicDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, and itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.
|
overridevirtual |
Get the number of valid inputs. For PDEDeformableRegistration, this checks whether the fixed and moving images have been set. While PDEDeformableRegistration can take a third input as an initial displacement field, this input is not a required input.
Reimplemented from itk::ProcessObject.
|
virtual |
Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()
|
virtual |
Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()
|
virtual |
Get the Gaussian smoothing standard deviations use for smoothing the displacement field.
|
virtual |
Get the Gaussian smoothing standard deviations used for smoothing the update field.
|
inlineoverrideprotectedvirtual |
Supplies the halting criteria for this class of filters. The algorithm will stop after a user-specified number of iterations.
Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.
Definition at line 214 of file itkPDEDeformableRegistrationFilter.h.
|
overrideprotectedvirtual |
This method is called before iterating the solution.
Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.
|
overrideprotectedvirtual |
Initialize the state of filter and equation before each iteration. Progress feeback is implemented as part of this method.
Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.
Reimplemented in itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
This method is called after the solution has been generated. In this case, the filter release the memory of the internal buffers.
Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.
|
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::ProcessObject.
Reimplemented in itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.
|
virtual |
Set the fixed image.
|
virtual |
Set initial displacement field.
|
virtual |
Set/Get the desired maximum error of the Gaussian kernel approximate.
|
virtual |
Set/Get the desired limits of the Gaussian kernel width.
|
virtual |
Set the moving image.
|
virtual |
Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()
|
virtual |
Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()
|
virtual |
Set the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates.
|
virtual |
Set the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates.
|
virtual |
Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.
|
virtual |
Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.
|
protectedvirtual |
Utility to smooth the displacement field (represented in the Output) using a Gaussian operator. The amount of smoothing can be specified by setting the StandardDeviations.
|
virtual |
Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()
|
virtual |
Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()
|
protectedvirtual |
Utility to smooth the UpdateBuffer using a Gaussian operator. The amount of smoothing can be specified by setting the UpdateFieldStandardDeviations.
|
virtual |
Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()
|
virtual |
Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()
|
inlinevirtual |
Stop the registration after the current iteration.
Definition at line 192 of file itkPDEDeformableRegistrationFilter.h.
|
static |
Inherit some enums and type alias from the superclass.
Definition at line 117 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Maximum error for Gaussian operator approximation.
Definition at line 278 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Limits of Gaussian kernel width.
Definition at line 281 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Modes to control smoothing of the update and displacement fields
Definition at line 269 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Definition at line 270 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Standard deviation for Gaussian smoothing
Definition at line 265 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Flag to indicate user stop registration request.
Definition at line 284 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Temporary displacement field use for smoothing the the displacement field.
Definition at line 274 of file itkPDEDeformableRegistrationFilter.h.
|
private |
Definition at line 266 of file itkPDEDeformableRegistrationFilter.h.