#include <itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.h>

Inheritance diagram for itk::TimeVaryingBSplineVelocityFieldImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >:

Collaboration diagram for itk::TimeVaryingBSplineVelocityFieldImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >:

Public Types
using	BSplineFilterType = BSplineScatteredDataPointSetToImageFilter< VelocityFieldPointSetType, TimeVaryingVelocityFieldType >

using	CompositeTransformType = typename Superclass::CompositeTransformType

using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< typename DisplacementFieldPointType::CoordRepType, ImageDimension >

using	DecoratedOutputTransformPointer = typename DecoratedOutputTransformType::Pointer

using	DecoratedOutputTransformType = typename Superclass::DecoratedOutputTransformType

using	DerivativeType = typename OutputTransformType::DerivativeType

using	DerivativeValueType = typename DerivativeType::ValueType

using	DisplacementFieldPointType = typename DisplacementFieldType::PointType

using	DisplacementFieldTransformPointer = typename DisplacementFieldTransformType::Pointer

using	DisplacementFieldTransformType = DisplacementFieldTransform< RealType, ImageDimension >

using	DisplacementFieldType = typename OutputTransformType::DisplacementFieldType

using	DisplacementVectorType = typename TimeVaryingVelocityFieldControlPointLatticeType::PixelType

using	FixedImageMasksContainerType = typename Superclass::FixedImageMasksContainerType

using	FixedImageMaskType = typename Superclass::FixedImageMaskType

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImagesContainerType = typename Superclass::FixedImagesContainerType

using	FixedImageType = TFixedImage

using	FixedMaskImageType = typename ImageMaskSpatialObjectType::ImageType

using	ImageMaskSpatialObjectType = ImageMaskSpatialObject< ImageDimension >

using	ImageMetricPointer = typename ImageMetricType::Pointer

using	ImageMetricType = typename Superclass::ImageMetricType

using	InitialTransformType = typename Superclass::InitialTransformType

using	InputPointSetPointer = typename InputPointSetType::Pointer

using	InputPointSetType = TPointSet

using	MaskImageType = typename ImageMaskSpatialObjectType::ImageType

using	MeasureType = typename ImageMetricType::MeasureType

using	MetricDerivativeType = typename ImageMetricType::DerivativeType

using	MetricPointer = typename MetricType::Pointer

using	MetricType = typename Superclass::MetricType

using	MovingImageMasksContainerType = typename Superclass::MovingImageMasksContainerType

using	MovingImageMaskType = typename Superclass::MovingImageMaskType

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImagesContainerType = typename Superclass::MovingImagesContainerType

using	MovingImageType = TMovingImage

using	MovingMaskImageType = typename ImageMaskSpatialObjectType::ImageType

using	MultiMetricType = typename Superclass::MultiMetricType

using	NumberOfIterationsArrayType = Array< SizeValueType >

using	OutputTransformPointer = typename OutputTransformType::Pointer

using	OutputTransformType = TOutputTransform

using	Pointer = SmartPointer< Self >

using	PointSetMetricType = typename Superclass::PointSetMetricType

using	PointSetsContainerType = typename Superclass::PointSetsContainerType

using	RealType = typename OutputTransformType::ScalarType

using	Self = TimeVaryingBSplineVelocityFieldImageRegistrationMethod

using	Superclass = ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >

using	TimeVaryingVelocityFieldControlPointLatticePointer = typename OutputTransformType::TimeVaryingVelocityFieldControlPointLatticePointer

using	TimeVaryingVelocityFieldControlPointLatticeType = typename OutputTransformType::TimeVaryingVelocityFieldControlPointLatticeType

using	TimeVaryingVelocityFieldPointer = typename OutputTransformType::TimeVaryingVelocityFieldControlPointLatticePointer

using	TimeVaryingVelocityFieldType = typename OutputTransformType::TimeVaryingVelocityFieldControlPointLatticeType

using	TimeVaryingWeightedMaskImageType = Image< WeightsElementType, ImageDimension+1 >

using	TransformBaseType = typename CompositeTransformType::TransformType

using	VelocityFieldPointSetPointer = typename VelocityFieldPointSetType::Pointer

using	VelocityFieldPointSetType = PointSet< DisplacementVectorType, ImageDimension+1 >

using	VirtualImageBaseConstPointer = typename Superclass::VirtualImageBaseConstPointer

using	VirtualImageBaseType = typename Superclass::VirtualImageBaseType

using	VirtualImageType = typename Superclass::VirtualImageType

using	WeightedMaskImageType = Image< WeightsElementType, ImageDimension >

using	WeightsContainerType = typename BSplineFilterType::WeightsContainerType

using	WeightsElementType = typename WeightsContainerType::Element

Public Types inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
using	CompositeTransformPointer = typename CompositeTransformType::Pointer

using	CompositeTransformType = CompositeTransform< RealType, ImageDimension >

using	ConstPointer = SmartPointer< const Self >

using	DecoratedInitialTransformPointer = typename DecoratedInitialTransformType::Pointer

using	DecoratedInitialTransformType = DataObjectDecorator< InitialTransformType >

using	DecoratedOutputTransformPointer = typename DecoratedOutputTransformType::Pointer

using	DecoratedOutputTransformType = DataObjectDecorator< OutputTransformType >

using	DerivativeType = typename OutputTransformType::DerivativeType

using	DerivativeValueType = typename DerivativeType::ValueType

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer

using	FixedImageMasksContainerType = std::vector< FixedImageMaskConstPointer >

using	FixedImageMaskType = typename ImageMetricType::FixedImageMaskType

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImagesContainerType = std::vector< FixedImageConstPointer >

using	FixedImageType = TFixedImage

using	ImageMetricType = ImageToImageMetricv4< FixedImageType, MovingImageType, VirtualImageType, RealType >

using	InitialTransformPointer = typename InitialTransformType::Pointer

using	InitialTransformType = Transform< RealType, ImageDimension, ImageDimension >

using	MetricPointer = typename MetricType::Pointer

using	MetricSamplePointSetType = typename ImageMetricType::FixedSampledPointSetType

using	MetricSamplingPercentageArrayType = Array< RealType >

using	MetricSamplingStrategyEnum = ImageRegistrationMethodv4Enums::MetricSamplingStrategy

using	MetricType = ObjectToObjectMetricBaseTemplate< RealType >

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer

using	MovingImageMasksContainerType = std::vector< MovingImageMaskConstPointer >

using	MovingImageMaskType = typename ImageMetricType::MovingImageMaskType

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImagesContainerType = std::vector< MovingImageConstPointer >

using	MovingImageType = TMovingImage

using	MultiMetricType = ObjectToObjectMultiMetricv4< ImageDimension, ImageDimension, VirtualImageType, RealType >

using	OptimizerPointer = typename OptimizerType::Pointer

using	OptimizerType = ObjectToObjectOptimizerBaseTemplate< RealType >

using	OptimizerWeightsType = typename OptimizerType::ScalesType

using	OutputTransformPointer = typename OutputTransformType::Pointer

using	OutputTransformType = TOutputTransform

using	Pointer = SmartPointer< Self >

using	PointSetConstPointer = typename PointSetType::ConstPointer

using	PointSetMetricType = PointSetToPointSetMetricWithIndexv4< PointSetType, PointSetType, RealType >

using	PointSetsContainerType = std::vector< PointSetConstPointer >

using	PointSetType = TPointSet

using	RealType = typename OutputTransformType::ScalarType

using	Self = ImageRegistrationMethodv4

using	ShrinkFactorsArrayType = Array< SizeValueType >

using	ShrinkFactorsPerDimensionContainerType = typename ShrinkFilterType::ShrinkFactorsType

using	ShrinkFilterType = ShrinkImageFilter< FixedImageType, VirtualImageType >

using	SmoothingSigmasArrayType = Array< RealType >

using	Superclass = ProcessObject

using	TransformParametersAdaptorPointer = typename TransformParametersAdaptorType::Pointer

using	TransformParametersAdaptorsContainerType = std::vector< TransformParametersAdaptorPointer >

using	TransformParametersAdaptorType = TransformParametersAdaptorBase< InitialTransformType >

using	VectorType = Vector< RealType, ImageDimension >

using	VirtualImageBaseConstPointer = typename VirtualImageBaseType::ConstPointer

using	VirtualImageBaseType = ImageBase< ImageDimension >

using	VirtualImagePointer = typename VirtualImageType::Pointer

using	VirtualImageType = TVirtualImage

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

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

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
virtual void	SetFixedImage (const FixedImageType *image)

virtual const FixedImageType *	GetFixedImage () const

virtual void	SetFixedImage (SizeValueType, const FixedImageType *)

virtual const FixedImageType *	GetFixedImage (SizeValueType) const

virtual void	SetMovingImage (const MovingImageType *image)

virtual const MovingImageType *	GetMovingImage () const

virtual void	SetMovingImage (SizeValueType, const MovingImageType *)

virtual const MovingImageType *	GetMovingImage (SizeValueType) const

virtual void	SetFixedPointSet (const PointSetType *pointSet)

virtual const PointSetType *	GetFixedPointSet () const

virtual void	SetFixedPointSet (SizeValueType, const PointSetType *)

virtual const PointSetType *	GetFixedPointSet (SizeValueType) const

virtual void	SetMovingPointSet (const PointSetType *pointSet)

virtual const PointSetType *	GetMovingPointSet () const

virtual void	SetMovingPointSet (SizeValueType, const PointSetType *)

virtual const PointSetType *	GetMovingPointSet (SizeValueType) const

virtual void	SetOptimizer (OptimizerType *_arg)

virtual OptimizerType *	GetModifiableOptimizer ()

virtual const OptimizerType *	GetOptimizer () const

void	SetOptimizerWeights (OptimizerWeightsType &)

virtual OptimizerWeightsType	GetOptimizerWeights () const

virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual const MetricType *	GetMetric () const

virtual void	SetMetricSamplingStrategy (const MetricSamplingStrategyEnum _arg)

virtual MetricSamplingStrategyEnum	GetMetricSamplingStrategy () const

void	MetricSamplingReinitializeSeed ()

void	MetricSamplingReinitializeSeed (int seed)

void	SetMetricSamplingPercentage (const RealType)

virtual void	SetMetricSamplingPercentagePerLevel (const MetricSamplingPercentageArrayType &samplingPercentages)

virtual MetricSamplingPercentageArrayType	GetMetricSamplingPercentagePerLevel () const

virtual void	SetFixedInitialTransformInput (const DataObjectDecorator< InitialTransformType > *_arg)

virtual void	SetInputnumber (const DataObjectDecorator< InitialTransformType > *_arg)

virtual const DataObjectDecorator< InitialTransformType > *	GetFixedInitialTransformInput () const

virtual const DataObjectDecorator< InitialTransformType > *	GetInputnumber () const

virtual void	SetFixedInitialTransform (const InitialTransformType *_arg)

virtual const DataObjectDecorator< InitialTransformType > *	GetFixedInitialTransformInput () const

virtual const InitialTransformType *	GetFixedInitialTransform () const

virtual void	SetMovingInitialTransformInput (const DataObjectDecorator< InitialTransformType > *_arg)

virtual void	SetInputnumber (const DataObjectDecorator< InitialTransformType > *_arg)

virtual const DataObjectDecorator< InitialTransformType > *	GetMovingInitialTransformInput () const

virtual const DataObjectDecorator< InitialTransformType > *	GetInputnumber () const

virtual void	SetMovingInitialTransform (const InitialTransformType *_arg)

virtual const DataObjectDecorator< InitialTransformType > *	GetMovingInitialTransformInput () const

virtual const InitialTransformType *	GetMovingInitialTransform () const

virtual void	SetInitialTransformInput (const DataObjectDecorator< InitialTransformType > *_arg)

virtual void	SetInputnumber (const DataObjectDecorator< InitialTransformType > *_arg)

virtual const DataObjectDecorator< InitialTransformType > *	GetInitialTransformInput () const

virtual const DataObjectDecorator< InitialTransformType > *	GetInputnumber () const

virtual void	SetInitialTransform (const InitialTransformType *_arg)

virtual const DataObjectDecorator< InitialTransformType > *	GetInitialTransformInput () const

virtual const InitialTransformType *	GetInitialTransform () const

void	SetTransformParametersAdaptorsPerLevel (TransformParametersAdaptorsContainerType &)

const TransformParametersAdaptorsContainerType &	GetTransformParametersAdaptorsPerLevel () const

void	SetNumberOfLevels (const SizeValueType)

virtual SizeValueType	GetNumberOfLevels () const

void	SetShrinkFactorsPerLevel (ShrinkFactorsArrayType factors)

ShrinkFactorsPerDimensionContainerType	GetShrinkFactorsPerDimension (const unsigned int level) const

void	SetShrinkFactorsPerDimension (unsigned int level, ShrinkFactorsPerDimensionContainerType factors)

virtual void	SetSmoothingSigmasPerLevel (SmoothingSigmasArrayType _arg)

virtual SmoothingSigmasArrayType	GetSmoothingSigmasPerLevel () const

virtual void	SetSmoothingSigmasAreSpecifiedInPhysicalUnits (bool _arg)

virtual bool	GetSmoothingSigmasAreSpecifiedInPhysicalUnits () const

virtual void	SmoothingSigmasAreSpecifiedInPhysicalUnitsOn ()

virtual void	SmoothingSigmasAreSpecifiedInPhysicalUnitsOff ()

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType) override

virtual DecoratedOutputTransformType *	GetOutput ()

virtual const DecoratedOutputTransformType *	GetOutput () const

virtual DecoratedOutputTransformType *	GetTransformOutput ()

virtual const DecoratedOutputTransformType *	GetTransformOutput () const

virtual OutputTransformType *	GetModifiableTransform ()

virtual const OutputTransformType *	GetTransform () const

virtual SizeValueType	GetCurrentLevel () const

virtual const SizeValueType &	GetCurrentIteration () const

virtual const RealType &	GetCurrentMetricValue () const

virtual const RealType &	GetCurrentConvergenceValue () const

virtual const bool &	GetIsConverged () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual void	InitializeCenterOfLinearOutputTransformOn ()

virtual void	InitializeCenterOfLinearOutputTransformOff ()

virtual void	SetInitializeCenterOfLinearOutputTransform (bool _arg)

virtual bool	GetInitializeCenterOfLinearOutputTransform () const

void	InitializeCenterOfLinearOutputTransform ()

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TFixedImage::ImageDimension

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

DisplacementFieldTransformPointer	m_IdentityDisplacementFieldTransform

RealType	m_LearningRate

RealType	m_ConvergenceThreshold

unsigned int	m_ConvergenceWindowSize { 10 }

NumberOfIterationsArrayType	m_NumberOfIterationsPerLevel

SizeValueType	m_NumberOfTimePointSamples { 4 }

WeightsElementType	m_BoundaryWeight

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

virtual void	SetNumberOfTimePointSamples (SizeValueType _arg)

virtual SizeValueType	GetNumberOfTimePointSamples () const

	TimeVaryingBSplineVelocityFieldImageRegistrationMethod ()

	~TimeVaryingBSplineVelocityFieldImageRegistrationMethod () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

void	GenerateData () override

virtual void	StartOptimization ()

void	GetMetricDerivativePointSetForAllTimePoints (VelocityFieldPointSetType , WeightsContainerType )

void	AttachMetricGradientPointSetAtSpecificTimePoint (const RealType, VelocityFieldPointSetType , WeightsContainerType , const FixedImagesContainerType, const PointSetsContainerType, const TransformBaseType , const MovingImagesContainerType, const PointSetsContainerType, const TransformBaseType , const FixedImageMasksContainerType)

Additional Inherited Members
Protected Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
	ImageRegistrationMethodv4 ()

	~ImageRegistrationMethodv4 () override=default

virtual void	AllocateOutputs ()

virtual void	InitializeRegistrationAtEachLevel (const SizeValueType)

virtual VirtualImageBaseConstPointer	GetCurrentLevelVirtualDomainImage ()

virtual void	SetMetricSamplePoints ()

Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	PushBackInput (const DataObject *input)

virtual void	PopBackInput ()

virtual void	PushFrontInput (const DataObject *input)

virtual void	PopFrontInput ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 ()

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
SizeValueType	m_CurrentLevel

SizeValueType	m_NumberOfLevels

SizeValueType	m_CurrentIteration

RealType	m_CurrentMetricValue

RealType	m_CurrentConvergenceValue

bool	m_IsConverged

FixedImagesContainerType	m_FixedSmoothImages

MovingImagesContainerType	m_MovingSmoothImages

FixedImageMasksContainerType	m_FixedImageMasks

MovingImageMasksContainerType	m_MovingImageMasks

VirtualImagePointer	m_VirtualDomainImage

PointSetsContainerType	m_FixedPointSets

PointSetsContainerType	m_MovingPointSets

SizeValueType	m_NumberOfFixedObjects

SizeValueType	m_NumberOfMovingObjects

OptimizerPointer	m_Optimizer

OptimizerWeightsType	m_OptimizerWeights

bool	m_OptimizerWeightsAreIdentity

MetricPointer	m_Metric

MetricSamplingStrategyEnum	m_MetricSamplingStrategy

MetricSamplingPercentageArrayType	m_MetricSamplingPercentagePerLevel

SizeValueType	m_NumberOfMetrics

int	m_FirstImageMetricIndex

std::vector< ShrinkFactorsPerDimensionContainerType >	m_ShrinkFactorsPerLevel

SmoothingSigmasArrayType	m_SmoothingSigmasPerLevel

bool	m_SmoothingSigmasAreSpecifiedInPhysicalUnits

bool	m_ReseedIterator

int	m_RandomSeed

int	m_CurrentRandomSeed

TransformParametersAdaptorsContainerType	m_TransformParametersAdaptorsPerLevel

CompositeTransformPointer	m_CompositeTransform

OutputTransformPointer	m_OutputTransform

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TOutputTransform = TimeVaryingBSplineVelocityFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
class itk::TimeVaryingBSplineVelocityFieldImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >

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 SimpleImageRegistrationMethod class is specialized to handle time-varying velocity field transforms of which there are currently 3:

TimeVaryingDisplacementFieldTransform
GaussianSmoothingOnUpdateTimeVaryingDisplacementFieldTransform
BSplineSmoothingOnUpdateTimeVaryingDisplacementFieldTransform

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 itkTimeVaryingBSplineVelocityFieldIntegrationImageFilter.

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} = B_1( v_{total} + \lambda * B_2( v_{update} ) )$

where

$ B_1 = $ bspline smoothing on the total field $ B_2 = $ bspline 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.

Author: Nick Tustison; Brian Avants

Definition at line 91 of file itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.h.