#include <itkTimeVaryingVelocityFieldImageRegistrationMethodv4.h>

Inheritance diagram for itk::TimeVaryingVelocityFieldImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >:

Collaboration diagram for itk::TimeVaryingVelocityFieldImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >:

List of all members.

Public Types
typedef Superclass::CompositeTransformType	CompositeTransformType
typedef SmartPointer< const Self >	ConstPointer
typedef DecoratedOutputTransformType::Pointer	DecoratedOutputTransformPointer
typedef Superclass::DecoratedOutputTransformType	DecoratedOutputTransformType
typedef OutputTransformType::DerivativeType	DerivativeType
typedef DerivativeType::ValueType	DerivativeValueType
typedef DisplacementFieldType::Pointer	DisplacementFieldPointer
typedef OutputTransformType::DisplacementFieldType	DisplacementFieldType
typedef TimeVaryingVelocityFieldType::PixelType	DisplacementVectorType
typedef FixedImageType::Pointer	FixedImagePointer
typedef TFixedImage	FixedImageType
typedef MetricType::MeasureType	MeasureType
typedef MetricType::Pointer	MetricPointer
typedef Superclass::MetricType	MetricType
typedef MovingImageType::Pointer	MovingImagePointer
typedef TMovingImage	MovingImageType
typedef Array< SizeValueType >	NumberOfIterationsArrayType
typedef OutputTransformType::Pointer	OutputTransformPointer
typedef TOutputTransform	OutputTransformType
typedef SmartPointer< Self >	Pointer
typedef OutputTransformType::ScalarType	RealType
typedef MovingImageType::RegionType	RegionType
typedef TimeVaryingVelocityFieldImageRegistrationMethodv4	Self
typedef ImageRegistrationMethodv4 < TFixedImage, TMovingImage, TOutputTransform >	Superclass
typedef TimeVaryingVelocityFieldType::Pointer	TimeVaryingVelocityFieldPointer
typedef OutputTransformType::TimeVaryingVelocityFieldType	TimeVaryingVelocityFieldType
typedef MetricType::VirtualImageType	VirtualImageType
Public Types inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
typedef CompositeTransformType::Pointer	CompositeTransformPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef FixedInterpolatorType::Pointer	FixedInterpolatorPointer
typedef InterpolateImageFunction < FixedImageType, RealType >	FixedInterpolatorType
typedef InitialTransformType::Pointer	InitialTransformPointer
typedef Transform< RealType, ImageDimension, ImageDimension >	InitialTransformType
typedef MetricType::FixedSampledPointSetType	MetricSamplePointSetType
typedef Array< RealType >	MetricSamplingPercentageArrayType
enum	MetricSamplingStrategyType { NONE, REGULAR, RANDOM }
typedef MovingInterpolatorType::Pointer	MovingInterpolatorPointer
typedef InterpolateImageFunction < MovingImageType, RealType >	MovingInterpolatorType
typedef OptimizerType::Pointer	OptimizerPointer
typedef ObjectToObjectOptimizerBase	OptimizerType
typedef Array< SizeValueType >	ShrinkFactorsArrayType
typedef Array< RealType >	SmoothingSigmasArrayType
typedef TransformParametersAdaptorType::Pointer	TransformParametersAdaptorPointer
typedef std::vector < TransformParametersAdaptorPointer >	TransformParametersAdaptorsContainerType
typedef TransformParametersAdaptor < OutputTransformType >	TransformParametersAdaptorType
Public Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

virtual void	SetLearningRate (RealType _arg)
virtual RealType	GetLearningRate () const

virtual void	SetNumberOfIterationsPerLevel (NumberOfIterationsArrayType _arg)
virtual NumberOfIterationsArrayType	GetNumberOfIterationsPerLevel () const

virtual void	SetConvergenceThreshold (RealType _arg)
virtual RealType	GetConvergenceThreshold () const

virtual void	SetConvergenceWindowSize (unsigned int _arg)
virtual unsigned int	GetConvergenceWindowSize () const
Public Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
virtual const RealType &	GetCurrentConvergenceValue ()
virtual const SizeValueType &	GetCurrentIteration ()
virtual SizeValueType	GetCurrentLevel () const
virtual const RealType &	GetCurrentMetricValue ()
virtual const bool &	GetIsConverged ()
virtual const DecoratedOutputTransformType *	GetOutput () const
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType)
void	SetMetricSamplingPercentage (const RealType)
void	StartRegistration ()
virtual void	SetFixedImage (const FixedImageType *input)
virtual const FixedImageType *	GetFixedImage () const
virtual void	SetMovingImage (const MovingImageType *input)
virtual const MovingImageType *	GetMovingImage () const
virtual void	SetFixedInitialTransform (InitialTransformType *_arg)
virtual const InitialTransformType *	GetFixedInitialTransform ()
virtual void	SetMovingInitialTransform (InitialTransformType *_arg)
virtual const InitialTransformType *	GetMovingInitialTransform ()
virtual void	SetFixedInterpolator (FixedInterpolatorType *_arg)
virtual const FixedInterpolatorType *	GetFixedInterpolator ()
virtual void	SetMovingInterpolator (MovingInterpolatorType *_arg)
virtual const MovingInterpolatorType *	GetMovingInterpolator ()
virtual void	SetMetric (MetricType *_arg)
virtual MetricType *	GetMetric ()
virtual void	SetMetricSamplingStrategy (MetricSamplingStrategyType _arg)
virtual MetricSamplingStrategyType	GetMetricSamplingStrategy () const
virtual void	SetMetricSamplingPercentagePerLevel (MetricSamplingPercentageArrayType _arg)
virtual MetricSamplingPercentageArrayType	GetMetricSamplingPercentagePerLevel () const
virtual void	SetOptimizer (OptimizerType *_arg)
virtual OptimizerType *	GetOptimizer ()
void	SetTransformParametersAdaptorsPerLevel (TransformParametersAdaptorsContainerType &)
const TransformParametersAdaptorsContainerType &	GetTransformParametersAdaptorsPerLevel () const
void	SetNumberOfLevels (const SizeValueType)
virtual SizeValueType	GetNumberOfLevels () const
virtual void	SetShrinkFactorsPerLevel (ShrinkFactorsArrayType _arg)
virtual ShrinkFactorsArrayType	GetShrinkFactorsPerLevel () const
virtual void	SetSmoothingSigmasPerLevel (SmoothingSigmasArrayType _arg)
virtual SmoothingSigmasArrayType	GetSmoothingSigmasPerLevel () const
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TFixedImage::ImageDimension
Static Public Attributes inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >

Protected Member Functions
virtual void	GenerateData ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	StartOptimization ()
void	ThreadedGenerateData (const RegionType &, ThreadIdType)
	TimeVaryingVelocityFieldImageRegistrationMethodv4 ()
virtual	~TimeVaryingVelocityFieldImageRegistrationMethodv4 ()
Protected Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
	ImageRegistrationMethodv4 ()
virtual void	InitializeRegistrationAtEachLevel (const SizeValueType)
virtual void	SetMetricSamplePoints ()
virtual	~ImageRegistrationMethodv4 ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 &)
	TimeVaryingVelocityFieldImageRegistrationMethodv4 (const Self &)

Private Attributes
RealType	m_ConvergenceThreshold
unsigned int	m_ConvergenceWindowSize
RealType	m_LearningRate
NumberOfIterationsArrayType	m_NumberOfIterationsPerLevel

Additional Inherited Members
Protected Attributes inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
CompositeTransformPointer	m_CompositeTransform
RealType	m_CurrentConvergenceValue
SizeValueType	m_CurrentIteration
SizeValueType	m_CurrentLevel
RealType	m_CurrentMetricValue
InitialTransformPointer	m_FixedInitialTransform
FixedInterpolatorPointer	m_FixedInterpolator
FixedImagePointer	m_FixedSmoothImage
bool	m_IsConverged
MetricPointer	m_Metric
MetricSamplingPercentageArrayType	m_MetricSamplingPercentagePerLevel
MetricSamplingStrategyType	m_MetricSamplingStrategy
InitialTransformPointer	m_MovingInitialTransform
MovingInterpolatorPointer	m_MovingInterpolator
MovingImagePointer	m_MovingSmoothImage
SizeValueType	m_NumberOfLevels
OptimizerPointer	m_Optimizer
OutputTransformPointer	m_OutputTransform
ShrinkFactorsArrayType	m_ShrinkFactorsPerLevel
SmoothingSigmasArrayType	m_SmoothingSigmasPerLevel
TransformParametersAdaptorsContainerType	m_TransformParametersAdaptorsPerLevel
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TOutputTransform = GaussianSmoothingOnUpdateTimeVaryingVelocityFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
class itk::TimeVaryingVelocityFieldImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >

Interface method for the current registration framework using the time varying velocity field transform.

Output: The output is the updated transform which has been added to the composite transform.

This derived class from the ImageRegistrationMethodv4 class is specialized to handle time-varying velocity field transforms of which there are currently 2:

TimeVaryingDisplacementFieldTransform
GaussianSmoothingOnUpdateTimeVaryingDisplacementFieldTransform

The latter is derived from the former and performs an optional spatial and temporal smoothing on the update and total velocity fields. Integration of the velocity field is performed using 4th order Runge Kutta and is performed using the class itkTimeVaryingVelocityFieldIntegrationImageFilter.

Optimization occurs in an iterative fashion where for each sample time point, t, in the velocity field, we integrate the velocity field in the range [0, t] to yield the displacement field which warps fixed image to time point t. Simultaneously, we integrate the velocity field in the range [t, 1] to yield the displacement field transform which warps the moving image to time point t. The metric derivative for each time point of the velocity field calculated in this way produces the normalized update field (or gradient) of the velocity field to be added to the total field at each iteration after being multiplied by the learning rate and optionally smoothed. Mathematically, this can be described as

$v_{total} = G_1( v_{total} + \lambda * G_2( v_{update} ) )$

where

$ G_1 = $ gaussian smoothing on the total field $ G_2 = $ gaussian smoothing on the update field $\lambda =$ learning rate $v_{update} =$ the normalized velocity field where we normalize the velocity field at each time point separately by the max norm of the field at that time point. This is done due to a weakly necessary (but not sufficient) condition being that the velocity field have a constant norm for all time points.