#include <itkVariationalDiffeomorphicRegistrationFilter.h>

Inheritance diagram for itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >:

Collaboration diagram for itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >:

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Diffeomorphic deformable registration of two images using static velocity fields.

VariationalDiffeomorphicRegistrationFilter is derived from VariationalRegistrationFilter and aims to minimize the functional

$(1)\quad J( \phi ) = D[R, T\circ\phi] + \alpha S[\phi] \rightarrow \min$

with $\phi(x)=exp(v(x))$ and $ v(x)$ is a static velocity field. Let $ f $ denote the force term corresponding to the similarity measure $ D$ and $ A$ denote the linear differential operator associated with the regularization term $ S $ , VariationalDiffeomorphicRegistrationFilter implements the following iterative scheme to compute $ v$ (and $\phi$ ):

initialize (default ) and $\phi^0=exp(v)$ (default $\phi^0=Id$ )
do
- compute the update field using and the warped image $T\circ\phi^k$
- compute the next velocity field by $v^{k+1} = (Id - \tau\alpha A)^{-1}(v^k + \tau f^k)$
- compute the next transformation $\phi^{k+1}=exp(v^{k+1})$
until is fulfilled or

The force term $ f $ is implemented in a subclass of VariationalRegistrationFunction. The computation of the regularization with $(Id - \tau\alpha A)^{-1}$ is implemented in a subclass of VariationalRegistrationRegularizer. The exponentiation of the velocity field $\phi(x)=exp(v(x))$ is done using the ExponentialDisplacementFieldImageFilter.

You can set SmoothUpdateFieldOn() to smooth the velocity field before exponentiation.

See Also: VariationalRegistrationFilter; VariationalRegistrationFunction; VariationalRegistrationRegularizer; ExponentialDisplacementFieldImageFilter; DenseFiniteDifferenceImageFilter

Note: This class was developed with funding from the German Research Foundation (DFG: EH 224/3-1 and HA 235/9-1).

Author: Alexander Schmidt-Richberg; Rene Werner; Jan Ehrhardt

For details see:

Alexander Schmidt-Richberg, Rene Werner, Heinz Handels and Jan Ehrhardt: A Flexible Variational Registration Framework, Insight Journal, 2014 http://hdl.handle.net/10380/3460
Rene Werner, Alexander Schmidt-Richberg, Heinz Handels and Jan Ehrhardt: Estimation of lung motion fields in 4D CT data by variational non-linear intensity-based registration: A comparison and evaluation study, Phys. Med. Biol., 2014
Jan Ehrhardt, Rene Werner, Alexander Schmidt-Richberg and Heinz Handels: Statistical modeling of 4D respiratory lung motion using diffeomorphic image registration. IEEE Trans. Med. Imaging, 30(2), 2011

Definition at line 80 of file itkVariationalDiffeomorphicRegistrationFilter.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = TDisplacementField

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	Pointer = SmartPointer< Self >

using	RegistrationFunctionType = typename Superclass::RegistrationFunctionType

using	RegularizerType = typename Superclass::RegularizerType

using	Self = VariationalDiffeomorphicRegistrationFilter

using	Superclass = VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

using	TimeStepType = typename Superclass::TimeStepType

Public Types inherited from itk::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	DefaultRegistrationFunctionType = VariationalRegistrationDemonsFunction< FixedImageType, MovingImageType, DisplacementFieldType >

using	DefaultRegularizerType = VariationalRegistrationDiffusionRegularizer< DisplacementFieldType >

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = TDisplacementField

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImageType = TFixedImage

using	MaskImageConstPointer = typename MaskImageType::ConstPointer

using	MaskImagePixelType = unsigned char

using	MaskImagePointer = typename MaskImageType::Pointer

using	MaskImageType = Image< MaskImagePixelType, ImageDimension >

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImageType = TMovingImage

using	OutputImageType = typename Superclass::OutputImageType

using	Pointer = SmartPointer< Self >

using	RegistrationFunctionType = VariationalRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >

using	RegularizerPointer = typename RegularizerType::Pointer

using	RegularizerType = VariationalRegistrationRegularizer< DisplacementFieldType >

using	Self = VariationalRegistrationFilter

using	Superclass = DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >

using	TimeStepType = typename Superclass::TimeStepType

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

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

DisplacementFieldType *	GetDisplacementField () override

virtual const char *	GetNameOfClass () const

virtual unsigned int	GetNumberOfExponentiatorIterations () const

virtual DisplacementFieldType *	GetVelocityField ()

void	SetInitialDisplacementField (DisplacementFieldType *ptr) override

virtual void	SetInitialVelocityField (DisplacementFieldType *ptr)

virtual void	SetNumberOfExponentiatorIterations (unsigned int _arg)

Public Member Functions inherited from itk::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const FixedImageType *	GetFixedImage (void) const

virtual const MaskImageType *	GetMaskImage (void) const

virtual double	GetMetric () const

virtual const MovingImageType *	GetMovingImage (void) const

std::vector< SmartPointer < DataObject > >::size_type	GetNumberOfValidRequiredInputs () const override

virtual const RegularizerType::Pointer &	GetRegularizer () const

virtual bool	GetSmoothDisplacementField () const

virtual bool	GetSmoothUpdateField () const

virtual void	SetFixedImage (const FixedImageType *ptr)

virtual void	SetMaskImage (const MaskImageType *ptr)

virtual void	SetMovingImage (const MovingImageType *ptr)

virtual void	SetRegularizer (RegularizerType *_arg)

virtual void	SetSmoothDisplacementField (bool _arg)

virtual void	SetSmoothUpdateField (bool _arg)

virtual void	SmoothDisplacementFieldOff ()

virtual void	SmoothDisplacementFieldOn ()

virtual void	SmoothUpdateFieldOff ()

virtual void	SmoothUpdateFieldOn ()

virtual void	StopRegistration ()

Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const

virtual const IdentifierType &	GetElapsedIterations () const

virtual bool	GetIsInitialized ()

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

virtual void	SetIsInitialized (bool _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)

virtual const IdentifierType &	GetNumberOfIterations () const

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual void	UseImageSpacingOff ()

virtual const bool &	GetUseImageSpacing () const

virtual void	SetMaximumRMSError (double _arg)

virtual const double &	GetMaximumRMSError () const

virtual void	SetRMSChange (double _arg)

virtual const double &	GetRMSChange () const

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization () const

virtual void	ManualReinitializationOn ()

virtual void	ManualReinitializationOff ()

Public Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TDisplacementField *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TDisplacementField >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

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

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

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 noexceptoverride

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
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 Member Functions inherited from itk::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
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::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
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

Protected Types
using	FieldExponentiatorPointer = typename FieldExponentiatorType::Pointer

using	FieldExponentiatorType = itk::ExponentialDisplacementFieldImageFilter< DisplacementFieldType, DisplacementFieldType >

Protected Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using	ThreadRegionType = typename UpdateBufferType::RegionType

Protected Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Protected Member Functions
void	ApplyUpdate (const TimeStepType &dt) override

virtual void	CalcDeformationFromVelocityField (const DisplacementFieldType *velocityField)

virtual FieldExponentiatorPointer	GetExponentiator ()

void	Initialize () override

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

	VariationalDiffeomorphicRegistrationFilter ()

	~VariationalDiffeomorphicRegistrationFilter () override

Protected Member Functions inherited from itk::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
void	ApplyUpdate (const TimeStepType &dt) override

void	CopyInputToOutput () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

bool	Halt () override

void	Initialize () override

void	InitializeIteration () override

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

	VariationalRegistrationFilter ()

void	VerifyInputInformation () const override

	~VariationalRegistrationFilter () override

RegistrationFunctionType *	DownCastDifferenceFunctionType ()

const RegistrationFunctionType *	DownCastDifferenceFunctionType () const

Protected Member Functions inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

TimeStepType	CalculateChange () override

void	CopyInputToOutput () override

	DenseFiniteDifferenceImageFilter ()

virtual UpdateBufferType *	GetUpdateBuffer ()

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

virtual void	ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)

virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)

	~DenseFiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual void	ApplyUpdate (const TimeStepType &dt)=0

	FiniteDifferenceImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual void	PostProcessOutput ()

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

virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const

virtual void	SetElapsedIterations (IdentifierType _arg)

virtual bool	ThreadedHalt (void *)

	~FiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
void	AllocateOutputs () override

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

void	VerifyInputInformation () ITKv5_CONST override

	~ImageToImageFilter () override

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

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

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

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

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

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 Attributes
DisplacementFieldPointer	m_DisplacementField

FieldExponentiatorPointer	m_Exponentiator

unsigned int	m_NumberOfExponentiatorIterations

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
IdentifierType	m_ElapsedIterations

bool	m_IsInitialized

bool	m_ManualReinitialization

double	m_MaximumRMSError

IdentifierType	m_NumberOfIterations

double	m_RMSChange

Protected Attributes inherited from itk::ImageSource< TDisplacementField >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

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

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer = SmartPointer<const Self>

Definition at line 91 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldPointer = typename DisplacementFieldType::Pointer

Definition at line 114 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType = TDisplacementField

Deformation field type.

Definition at line 113 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FieldExponentiatorPointer = typename FieldExponentiatorType::Pointer

protected

Typename for the exponentiator.

Definition at line 171 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FieldExponentiatorType = itk::ExponentialDisplacementFieldImageFilter< DisplacementFieldType, DisplacementFieldType>

protected

Exponential field calculator type.

Definition at line 168 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImageConstPointer = typename FixedImageType::ConstPointer

Definition at line 105 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer = typename FixedImageType::Pointer

Definition at line 104 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType = TFixedImage

FixedImage image type.

Definition at line 103 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImageConstPointer = typename MovingImageType::ConstPointer

Definition at line 110 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer = typename MovingImageType::Pointer

Definition at line 109 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType = TMovingImage

MovingImage image type.

Definition at line 108 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::OutputImageType = typename Superclass::OutputImageType

Types inherited from the superclass

Definition at line 117 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Pointer = SmartPointer<Self>

Definition at line 90 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::RegistrationFunctionType = typename Superclass::RegistrationFunctionType

VariationalRegistrationFunction type.

Definition at line 120 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::RegularizerType = typename Superclass::RegularizerType

Regularizer type.

Definition at line 123 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Self = VariationalDiffeomorphicRegistrationFilter

Standard class type alias

Definition at line 87 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Superclass = VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Definition at line 89 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType = typename Superclass::TimeStepType

The value type of a time step. Inherited from the superclass.

Definition at line 126 of file itkVariationalDiffeomorphicRegistrationFilter.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::VariationalDiffeomorphicRegistrationFilter ( )

protected

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::~VariationalDiffeomorphicRegistrationFilter ( )

inlineoverrideprotected

Definition at line 151 of file itkVariationalDiffeomorphicRegistrationFilter.h.

Member Function Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ApplyUpdate ( const TimeStepType & dt )

overrideprotected

Apply update.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::CalcDeformationFromVelocityField ( const DisplacementFieldType * velocityField )

protectedvirtual

Calculates the deformation field by calculating the exponential of the velocity field.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual::itk::LightObject::Pointer itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::CreateAnother ( ) const

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::VariationalSymmetricDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

DisplacementFieldType* itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetDisplacementField ( )

inlineoverridevirtual

Get output deformation field. Returns the displacement field of the current transformation.

Reimplemented from itk::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

Definition at line 138 of file itkVariationalDiffeomorphicRegistrationFilter.h.

References itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_DisplacementField.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual FieldExponentiatorPointer itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetExponentiator ( )

inlineprotectedvirtual

Get the exponentiator used to compute a displacement from a velocity field.

Definition at line 174 of file itkVariationalDiffeomorphicRegistrationFilter.h.

References itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_Exponentiator.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual const char* itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

Reimplemented in itk::VariationalSymmetricDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual unsigned int itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetNumberOfExponentiatorIterations ( ) const

virtual

Get the desired number of iterations for the exponentiator.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual DisplacementFieldType* itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetVelocityField ( )

inlinevirtual

Get output velocity field.

Definition at line 146 of file itkVariationalDiffeomorphicRegistrationFilter.h.

References itk::ImageSource< TDisplacementField >::GetOutput().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Initialize ( )

overrideprotectedvirtual

This method is called before iterating the solution.

Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.

Reimplemented in itk::VariationalSymmetricDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

static Pointer itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::New ( )

static

Method for creation through the object factory.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Print information about the filter.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VariationalSymmetricDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetInitialDisplacementField ( DisplacementFieldType * ptr )

overridevirtual

Set initial deformation field.

Warning: This can't be used for diffeomorphic registration.

Reimplemented from itk::VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetInitialVelocityField ( DisplacementFieldType * ptr )

inlinevirtual

Set initial deformation field.

Definition at line 142 of file itkVariationalDiffeomorphicRegistrationFilter.h.

References itk::ImageToImageFilter< TDisplacementField, TDisplacementField >::SetInput().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetNumberOfExponentiatorIterations ( unsigned int _arg )

virtual

Set the desired number of iterations for the exponentiator.

Member Data Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

constexpr unsigned int itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ImageDimension = Superclass::ImageDimension

static

Get image dimension.

Definition at line 100 of file itkVariationalDiffeomorphicRegistrationFilter.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

DisplacementFieldPointer itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_DisplacementField

private

Definition at line 180 of file itkVariationalDiffeomorphicRegistrationFilter.h.

Referenced by itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetDisplacementField().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

FieldExponentiatorPointer itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_Exponentiator

private

The deformation field.

Definition at line 179 of file itkVariationalDiffeomorphicRegistrationFilter.h.

Referenced by itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetExponentiator().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

unsigned int itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_NumberOfExponentiatorIterations

private

Number of iterations for exponentiation (self composing) of velocity field.

Definition at line 183 of file itkVariationalDiffeomorphicRegistrationFilter.h.

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

itkVariationalDiffeomorphicRegistrationFilter.h

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField> class itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class itk::VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >