itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar > Class Template Reference

Extends MultiResolutionDeformableImageRegistrationMethod to sort out interpolating the BSpline grid in between resolution levels. More...

Inheritance diagram for itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >:

Collaboration diagram for itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >:

Public Types
typedef FFDMultiResolutionMethod	Self
typedef MultiResolutionDeformableImageRegistrationMethod < TInputImageType, TScalarType, NDimensions, TDeformationScalar >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImageType	InputImageType
typedef InputImageType::SpacingType	InputImageSpacingType
typedef UCLBSplineTransform < TInputImageType, TScalarType, NDimensions, TDeformationScalar >	UCLBSplineTransformType
typedef UCLBSplineTransformType::Pointer	UCLBSplineTransformPointer
typedef LocalSimilarityMeasureGradientDescentOptimizer < TInputImageType, TInputImageType, TScalarType, TDeformationScalar >	OptimizerType
typedef OptimizerType *	OptimizerPointer
Public Types inherited from itk::MultiResolutionDeformableImageRegistrationMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >
typedef MultiResolutionDeformableImageRegistrationMethod	Self
typedef MultiResolutionImageRegistrationWrapper < TInputImageType, TPyramidFilter >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImageType	InputImageType
typedef DeformableTransform < TInputImageType, TScalarType, NDimensions, TDeformationScalar >	DeformableTransformType
typedef DeformableTransformType *	DeformableTransformPointer
Public Types inherited from itk::MultiResolutionImageRegistrationWrapper< TInputImageType, TPyramidFilter >
typedef MultiResolutionImageRegistrationWrapper	Self
typedef ProcessObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef MaskedImageRegistrationMethod < TInputImageType >	SingleResType
typedef SingleResType::Pointer	SingleResPointer
typedef TInputImageType	InputImageType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::RegionType	InputImageRegionType
typedef ImageToImageMetric < InputImageType, InputImageType >	MetricType
typedef MetricType::Pointer	MetricPointer
typedef MetricType::TransformType	TransformType
typedef TransformType::Pointer	TransformPointer
typedef DataObjectDecorator < TransformType >	TransformOutputType
typedef TransformOutputType::Pointer	TransformOutputPointer
typedef TransformOutputType::ConstPointer	TransformOutputConstPointer
typedef MetricType::InterpolatorType	InterpolatorType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef SingleValuedNonLinearOptimizer	OptimizerType
typedef BinaryThresholdImageFilter < InputImageType, InputImageType >	ThresholdFilterType
typedef ThresholdFilterType::Pointer	ThresholdFilterPointer
typedef TPyramidFilter	ImagePyramidType
typedef ImagePyramidType::Pointer	ImagePyramidPointer
typedef ImagePyramidType::ScheduleType	ImagePyramidScheduleType
typedef MetricType::TransformParametersType	ParametersType
typedef DataObject::Pointer	DataObjectPointer
typedef ImagePyramidType::ScheduleType	ScheduleType

Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetTransform (UCLBSplineTransformType *_arg)
virtual UCLBSplineTransformType *	GetTransform ()
virtual void	SetMaxStepSizeFactor (TScalarType _arg)
virtual TScalarType	GetMaxStepSizeFactor ()
virtual void	SetMinStepSizeFactor (TScalarType _arg)
virtual TScalarType	GetMinStepSizeFactor ()
void	WriteControlPointImage (std::string filename)
virtual void	SetFinalControlPointSpacing (InputImageSpacingType _arg)
virtual InputImageSpacingType	GetFinalControlPointSpacing ()
Public Member Functions inherited from itk::MultiResolutionDeformableImageRegistrationMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >
virtual void	SetJacobianImageFileName (std::string _arg)
virtual std::string	GetJacobianImageFileName ()
virtual void	SetJacobianImageFileExtension (std::string _arg)
virtual std::string	GetJacobianImageFileExtension ()
virtual void	SetWriteJacobianImageAtEachLevel (bool _arg)
virtual bool	GetWriteJacobianImageAtEachLevel ()
virtual void	SetVectorImageFileName (std::string _arg)
virtual std::string	GetVectorImageFileName ()
virtual void	SetVectorImageFileExtension (std::string _arg)
virtual std::string	GetVectorImageFileExtension ()
virtual void	SetWriteVectorImageAtEachLevel (bool _arg)
virtual bool	GetWriteVectorImageAtEachLevel ()
virtual void	SetParameterFileName (std::string _arg)
virtual std::string	GetParameterFileName ()
virtual void	SetParameterFileExt (std::string _arg)
virtual std::string	GetParameterFileExt ()
virtual void	SetWriteParametersAtEachLevel (bool _arg)
virtual bool	GetWriteParametersAtEachLevel ()
virtual void	WriteJacobianImageForLevel ()
virtual void	WriteJacobianImage ()
virtual void	WriteVectorImageForLevel ()
virtual void	WriteVectorImage ()
virtual void	WriteParametersForLevel ()
virtual void	WriteParameters ()
Public Member Functions inherited from itk::MultiResolutionImageRegistrationWrapper< TInputImageType, TPyramidFilter >
virtual void	StartRegistration ()
virtual void	StopRegistration ()
virtual void	SetSingleResMethod (SingleResType *_arg)
virtual SingleResType *	GetSingleResMethod ()
virtual void	SetFixedImage (const InputImageType *_arg)
virtual const InputImageType *	GetFixedImage ()
virtual void	SetFixedMask (const InputImageType *_arg)
virtual const InputImageType *	GetFixedMask ()
virtual void	SetMovingImage (const InputImageType *_arg)
virtual const InputImageType *	GetMovingImage ()
virtual void	SetMovingMask (const InputImageType *_arg)
virtual const InputImageType *	GetMovingMask ()
virtual void	SetNumberOfLevels (unsigned int _arg)
virtual unsigned int	GetNumberOfLevels ()
virtual void	SetStartLevel (unsigned int _arg)
virtual unsigned int	GetStartLevel ()
virtual void	SetStopLevel (unsigned int _arg)
virtual unsigned int	GetStopLevel ()
virtual unsigned int	GetCurrentLevel ()
virtual void	SetInitialTransformParameters (const ParametersType &parameters)
virtual const ParametersType &	GetInitialTransformParameters () const
virtual void	SetInitialTransformParametersOfNextLevel (ParametersType _arg)
virtual const ParametersType &	GetInitialTransformParametersOfNextLevel ()
virtual const ParametersType &	GetLastTransformParameters () const
const TransformOutputType *	GetOutput () const
virtual DataObjectPointer	MakeOutput (unsigned int idx)
unsigned long	GetMTime () const override
ScheduleType *	GetSchedule ()
void	SetSchedule (ScheduleType *schedule)
virtual void	SetMaskBeforePyramid (bool _arg)
virtual bool	GetMaskBeforePyramid ()
virtual void	SetUseOriginalImageAtFinalLevel (bool _arg)
virtual bool	GetUseOriginalImageAtFinalLevel ()
virtual void	SetIsAutoAdjustMovingSamping (bool _arg)
virtual bool	GetIsAutoAdjustMovingSamping ()

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::MultiResolutionDeformableImageRegistrationMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >
static Pointer	New ()
Static Public Member Functions inherited from itk::MultiResolutionImageRegistrationWrapper< TInputImageType, TPyramidFilter >
static Pointer	New ()

Protected Member Functions
	FFDMultiResolutionMethod ()
virtual	~FFDMultiResolutionMethod ()
virtual void	BeforeSingleResolutionRegistration ()
Protected Member Functions inherited from itk::MultiResolutionDeformableImageRegistrationMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >
virtual void	WriteJacobianImage (std::string filename)
virtual void	WriteVectorImage (std::string filename)
virtual void	WriteParameters (std::string filename)
	MultiResolutionDeformableImageRegistrationMethod ()
virtual	~MultiResolutionDeformableImageRegistrationMethod ()
virtual void	AfterSingleResolutionRegistration ()
Protected Member Functions inherited from itk::MultiResolutionImageRegistrationWrapper< TInputImageType, TPyramidFilter >
	MultiResolutionImageRegistrationWrapper ()
virtual	~MultiResolutionImageRegistrationWrapper ()
void	PrintSelf (std::ostream &os, Indent indent) const override
void	GenerateData () override
virtual void	PreparePyramids ()
virtual void	Initialize () throw (ExceptionObject)

Additional Inherited Members
Protected Attributes inherited from itk::MultiResolutionImageRegistrationWrapper< TInputImageType, TPyramidFilter >
unsigned int	m_NumberOfLevels
unsigned int	m_StartLevel
unsigned int	m_StopLevel
unsigned int	m_CurrentLevel
ParametersType	m_InitialTransformParametersOfNextLevel
SingleResPointer	m_SingleResMethod
bool	m_UseOriginalImageAtFinalLevel
bool	m_UserSpecifiedSchedule
InputImageConstPointer	m_FixedImage
InputImageConstPointer	m_FixedMask
InputImageConstPointer	m_MovingImage
InputImageConstPointer	m_MovingMask
ImagePyramidPointer	m_FixedImagePyramid
ImagePyramidPointer	m_FixedMaskPyramid
ImagePyramidPointer	m_MovingImagePyramid
ImagePyramidPointer	m_MovingMaskPyramid
ThresholdFilterPointer	m_FixedMaskThresholder
ThresholdFilterPointer	m_MovingMaskThresholder
bool	m_Stop
ScheduleType *	m_Schedule
bool	m_MaskBeforePyramid
bool	m_IsAutoAdjustMovingSamping

Detailed Description

template<typename TInputImageType, class TScalarType, unsigned int NDimensions, class TDeformationScalar>
class itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >

Extends MultiResolutionDeformableImageRegistrationMethod to sort out interpolating the BSpline grid in between resolution levels.

See also

MultiResolutionDeformableImageRegistrationMethod

Member Typedef Documentation

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef SmartPointer<const Self> itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::ConstPointer

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef InputImageType::SpacingType itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::InputImageSpacingType

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef TInputImageType itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::InputImageType

Type of the input image.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef OptimizerType* itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::OptimizerPointer

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef LocalSimilarityMeasureGradientDescentOptimizer<TInputImageType, TInputImageType, TScalarType, TDeformationScalar> itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::OptimizerType

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef SmartPointer<Self> itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::Pointer

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef FFDMultiResolutionMethod itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::Self

Standard class typedefs.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef MultiResolutionDeformableImageRegistrationMethod<TInputImageType, TScalarType, NDimensions, TDeformationScalar> itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::Superclass

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef UCLBSplineTransformType::Pointer itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::UCLBSplineTransformPointer

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

typedef UCLBSplineTransform<TInputImageType, TScalarType, NDimensions, TDeformationScalar > itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::UCLBSplineTransformType

Type of the Transform .

Constructor & Destructor Documentation

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::FFDMultiResolutionMethod ( )

protected

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::~FFDMultiResolutionMethod ( )

inlineprotectedvirtual

Member Function Documentation

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual void itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::BeforeSingleResolutionRegistration ( )

protectedvirtual

In here, we sort out initialising the BSpline grid at first resolution level, and then interpolating the BSpline grid inbetween resolution levels.

Reimplemented from itk::MultiResolutionImageRegistrationWrapper< TInputImageType, TPyramidFilter >.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual const char* itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::MultiResolutionDeformableImageRegistrationMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual InputImageSpacingType itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::GetFinalControlPointSpacing ( )

virtual

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual TScalarType itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::GetMaxStepSizeFactor ( )

virtual

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual TScalarType itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::GetMinStepSizeFactor ( )

virtual

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual UCLBSplineTransformType* itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::GetTransform ( )

virtual

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

static Pointer itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::New ( )

static

Method for creation through the object factory.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual void itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::SetFinalControlPointSpacing ( InputImageSpacingType  _arg )

virtual

Sets the final control point spacing.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual void itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::SetMaxStepSizeFactor ( TScalarType  _arg )

virtual

The max step size = max voxel size * MaxStepSizeFactor

and indicates the maximum step size taken per iteration at a given control point. Default is 1.0, so the initial step size will equal the maximum voxel dimension. Then as the registration progresses, this is reduced accordingly.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual void itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::SetMinStepSizeFactor ( TScalarType  _arg )

virtual

The min step size = max step size * MinStepSizeFactor

and indicates the minimum step size taken per iteration at a given control point. Defaults to 0.01, so the initial minimum step size is 0.01 times the max step size. As registration progresses, the step size is reduced accordingly, and once it is below this calculated threshold, registration will stop.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

virtual void itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::SetTransform ( UCLBSplineTransformType *  _arg )

virtual

Set/Get the Transfrom.

template<typename TInputImageType , class TScalarType , unsigned int NDimensions, class TDeformationScalar >

void itk::FFDMultiResolutionMethod< TInputImageType, TScalarType, NDimensions, TDeformationScalar >::WriteControlPointImage

(

std::string

filename

)

Write out the current transformation as an image of vectors.

---

The documentation for this class was generated from the following file:

• itkFFDMultiResolutionMethod.h