itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType > Class Template Reference

#include <itkTransformToDisplacementFieldFilter.h>

Detailed Description

template<typename TOutputImage, typename TParametersValueType = double>
class itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >

Generate a displacement field from a coordinate transform.

Output information (spacing, size and direction) for the output image should be set. This information has the normal defaults of unit spacing, zero origin and identity direction. Optionally, the output information can be obtained from a reference image. If the reference image is provided and UseReferenceImage is On, then the spacing, origin and direction of the reference image will be used.

Since this filter produces an image which is a different size than its input, it needs to override several of the methods defined in ProcessObject in order to properly manage the pipeline execution model. In particular, this filter overrides ProcessObject::GenerateOutputInformation().

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

Author

Marius Staring, Leiden University Medical Center, The Netherlands.

This class was taken from the Insight Journal paper: https://doi.org/10.54294/4ids6q

Examples

Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, and Examples/RegistrationITKv4/DeformableRegistration8.cxx.

Definition at line 55 of file itkTransformToDisplacementFieldFilter.h.

Inheritance diagram for itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >:

Collaboration diagram for itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >:

Public Types
using	ConstPointer = SmartPointer<const Self>
using	DirectionType = typename OutputImageType::DirectionType
using	IndexType = typename OutputImageType::IndexType
using	OriginType = typename OutputImageType::PointType
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TOutputImage
using	PixelType = typename OutputImageType::PixelType
using	PixelValueType = typename PixelType::ValueType
using	Pointer = SmartPointer<Self>
using	PointType = typename OutputImageType::PointType
using	ReferenceImageBaseType = ImageBase<ImageDimension>
using	RegionType = typename OutputImageType::RegionType
using	Self = TransformToDisplacementFieldFilter
using	SizeType = typename RegionType::SizeType
using	SpacingType = typename OutputImageType::SpacingType
using	Superclass = ImageSource<TOutputImage>
using	TransformInputType = DataObjectDecorator<TransformType>
using	TransformType = Transform<TParametersValueType, ImageDimension, ImageDimension>
Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage
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	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
virtual const OriginType &	GetOutputOrigin () const
virtual const SpacingType &	GetOutputSpacing () const
	itkGetInputMacro (ReferenceImage, ReferenceImageBaseType)
	itkSetInputMacro (ReferenceImage, ReferenceImageBaseType)
virtual void	SetInput (const TransformInputType *input)
const TransformInputType *	GetInput () const
virtual void	SetTransformInput (const DataObjectDecorator< TransformType > *_arg)
virtual void	SetInputnumber (const DataObjectDecorator< TransformType > *_arg)
virtual const DataObjectDecorator< TransformType > *	GetTransformInput () const
virtual const DataObjectDecorator< TransformType > *	GetInputnumber () const
virtual void	SetTransform (const TransformType *_arg)
virtual const DataObjectDecorator< TransformType > *	GetTransformInput () const
virtual const TransformType *	GetTransform () const
virtual void	SetOutputStartIndex (IndexType _arg)
virtual const IndexType &	GetOutputStartIndex () const
virtual void	SetSize (SizeType _arg)
virtual const SizeType &	GetSize () const
virtual void	SetOutputSpacing (SpacingType _arg)
virtual void	SetOutputSpacing (const SpacePrecisionType *spacing)
virtual void	SetOutputOrigin (OriginType _arg)
virtual void	SetOutputOrigin (const SpacePrecisionType *origin)
virtual void	SetOutputDirection (DirectionType _arg)
virtual const DirectionType &	GetOutputDirection () const
virtual void	SetUseReferenceImage (bool _arg)
virtual void	UseReferenceImageOn ()
virtual void	UseReferenceImageOff ()
virtual bool	GetUseReferenceImage () const
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftOutput (DataObject *graft)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
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 *output)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderBase *	GetMultiThreader () const
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 void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetMultiThreader (MultiThreaderBase *threader)
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 ()
	itkVirtualSetClampMacro (NumberOfWorkUnits, ThreadIdType, 1, ITK_MAX_THREADS)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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) const
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::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 = TOutputImage::ImageDimension
static constexpr unsigned int	PixelDimension = PixelType::Dimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
void	GenerateOutputInformation () override
void	LinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
void	NonlinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
void	PrintSelf (std::ostream &os, Indent indent) const override
	TransformToDisplacementFieldFilter ()
	~TransformToDisplacementFieldFilter () override=default
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
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 &region, ThreadIdType threadId)
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	GenerateInputRequestedRegion ()
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
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
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 idx, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	SetPrimaryInput (DataObject *object)
virtual void	SetPrimaryOutput (DataObject *object)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation () const
virtual void	VerifyPreconditions () 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 i)
const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual bool	GetThreaderUpdateProgress () const
virtual void	ThreaderUpdateProgressOn ()
virtual void	ThreaderUpdateProgressOff ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~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
DirectionType	m_OutputDirection {}
OriginType	m_OutputOrigin {}
SpacingType	m_OutputSpacing {}
IndexType	m_OutputStartIndex {}
SizeType	m_Size {}
bool	m_UseReferenceImage { false }

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
static constexpr float	progressFixedToFloat (uint32_t fixed)
static uint32_t	progressFloatToFixed (float f)
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }
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

ConstPointer

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 64 of file itkTransformToDisplacementFieldFilter.h.

DirectionType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::DirectionType = typename OutputImageType::DirectionType

Definition at line 91 of file itkTransformToDisplacementFieldFilter.h.

IndexType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::IndexType = typename OutputImageType::IndexType

Definition at line 87 of file itkTransformToDisplacementFieldFilter.h.

OriginType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::OriginType = typename OutputImageType::PointType

Definition at line 90 of file itkTransformToDisplacementFieldFilter.h.

OutputImageRegionType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 67 of file itkTransformToDisplacementFieldFilter.h.

OutputImageType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::OutputImageType = TOutputImage

Definition at line 66 of file itkTransformToDisplacementFieldFilter.h.

PixelType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::PixelType = typename OutputImageType::PixelType

Typedefs for output image.

Definition at line 83 of file itkTransformToDisplacementFieldFilter.h.

PixelValueType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::PixelValueType = typename PixelType::ValueType

Definition at line 84 of file itkTransformToDisplacementFieldFilter.h.

Pointer

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::Pointer = SmartPointer<Self>

Definition at line 63 of file itkTransformToDisplacementFieldFilter.h.

PointType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::PointType = typename OutputImageType::PointType

Definition at line 88 of file itkTransformToDisplacementFieldFilter.h.

ReferenceImageBaseType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::ReferenceImageBaseType = ImageBase<ImageDimension>

Typedef the reference image ImageBase.

Definition at line 94 of file itkTransformToDisplacementFieldFilter.h.

RegionType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::RegionType = typename OutputImageType::RegionType

Definition at line 85 of file itkTransformToDisplacementFieldFilter.h.

Self

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::Self = TransformToDisplacementFieldFilter

Standard class type aliases.

Definition at line 61 of file itkTransformToDisplacementFieldFilter.h.

SizeType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SizeType = typename RegionType::SizeType

Definition at line 86 of file itkTransformToDisplacementFieldFilter.h.

SpacingType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SpacingType = typename OutputImageType::SpacingType

Definition at line 89 of file itkTransformToDisplacementFieldFilter.h.

Superclass

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::Superclass = ImageSource<TOutputImage>

Definition at line 62 of file itkTransformToDisplacementFieldFilter.h.

TransformInputType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::TransformInputType = DataObjectDecorator<TransformType>

Definition at line 80 of file itkTransformToDisplacementFieldFilter.h.

TransformType

template<typename TOutputImage, typename TParametersValueType = double>

using itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::TransformType = Transform<TParametersValueType, ImageDimension, ImageDimension>

Typedefs for transform.

Definition at line 79 of file itkTransformToDisplacementFieldFilter.h.

Constructor & Destructor Documentation

TransformToDisplacementFieldFilter()

template<typename TOutputImage, typename TParametersValueType = double>

itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::TransformToDisplacementFieldFilter ( )

protected

Referenced by GetNameOfClass().

~TransformToDisplacementFieldFilter()

template<typename TOutputImage, typename TParametersValueType = double>

itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::~TransformToDisplacementFieldFilter ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TOutputImage, typename TParametersValueType = double>

virtual::itk::LightObject::Pointer itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::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.

DynamicThreadedGenerateData()

template<typename TOutputImage, typename TParametersValueType = double>

void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

TransformToDisplacementFieldFilter is implemented as a multithreaded filter.

Reimplemented from itk::ImageSource< TOutputImage >.

GenerateOutputInformation()

template<typename TOutputImage, typename TParametersValueType = double>

void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GenerateOutputInformation ( )

overrideprotectedvirtual

Produces a Vector Image.

Reimplemented from itk::ProcessObject.

GetInput()

template<typename TOutputImage, typename TParametersValueType = double>

const TransformInputType * itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetInput

(

)

const

GetInputnumber()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const DataObjectDecorator< TransformType > * itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetInputnumber ( ) const

virtual

GetNameOfClass()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const char * itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetNameOfClass ( ) const

virtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ImageSource< TOutputImage >.

References TransformToDisplacementFieldFilter().

GetOutputDirection()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const DirectionType & itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetOutputDirection ( ) const

virtual

Set the output direction cosine matrix.

GetOutputOrigin()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const OriginType & itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetOutputOrigin ( ) const

virtual

Get the output image origin.

GetOutputSpacing()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const SpacingType & itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetOutputSpacing ( ) const

virtual

Get the output image spacing.

GetOutputStartIndex()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const IndexType & itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetOutputStartIndex ( ) const

virtual

Set/Get the start index of the output largest possible region. The default is an index of all zeros.

GetSize()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const SizeType & itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetSize ( ) const

virtual

Set/Get the size of the output image.

GetTransform()

template<typename TOutputImage, typename TParametersValueType = double>

virtual const TransformType * itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetTransform ( ) const

virtual

GetTransformInput() [1/2]

template<typename TOutputImage, typename TParametersValueType = double>

virtual const DataObjectDecorator< TransformType > * itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetTransformInput ( ) const

virtual

GetTransformInput() [2/2]

template<typename TOutputImage, typename TParametersValueType = double>

virtual const DataObjectDecorator< TransformType > * itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetTransformInput ( ) const

virtual

GetUseReferenceImage()

template<typename TOutputImage, typename TParametersValueType = double>

virtual bool itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::GetUseReferenceImage ( ) const

virtual

Turn on/off whether a specified reference image should be used to define the output information.

itkGetInputMacro()

template<typename TOutputImage, typename TParametersValueType = double>

itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::itkGetInputMacro	(	ReferenceImage	,
		ReferenceImageBaseType	)

Get the reference image that is defining the output information.

itkSetInputMacro()

template<typename TOutputImage, typename TParametersValueType = double>

itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::itkSetInputMacro	(	ReferenceImage	,
		ReferenceImageBaseType	)

Set a reference image to use to define the output information. By default, output information is specified through the SetOutputSpacing, Origin, and Direction methods. Alternatively, this method can be used to specify an image from which to copy the information. UseReferenceImageOn must be set to utilize the reference image.

LinearThreadedGenerateData()

template<typename TOutputImage, typename TParametersValueType = double>

void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::LinearThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

protected

Faster implementation for resampling that works for with linear transformation types.

New()

template<typename TOutputImage, typename TParametersValueType = double>

static Pointer itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::New ( )

static

Method for creation through the object factory.

NonlinearThreadedGenerateData()

template<typename TOutputImage, typename TParametersValueType = double>

void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::NonlinearThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

protected

Default implementation for resampling that works for any transformation type.

PrintSelf()

template<typename TOutputImage, typename TParametersValueType = double>

void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::PrintSelf ( std::ostream & os, Indent indent ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageSource< TOutputImage >.

SetInput()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetInput ( const TransformInputType * input )

virtual

SetInputnumber()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetInputnumber ( const DataObjectDecorator< TransformType > * _arg )

virtual

SetOutputDirection()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetOutputDirection ( DirectionType _arg )

virtual

Set the output direction cosine matrix.

SetOutputOrigin() [1/2]

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetOutputOrigin ( const SpacePrecisionType * origin )

virtual

Set the output image origin.

SetOutputOrigin() [2/2]

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetOutputOrigin ( OriginType _arg )

virtual

Set the output image origin.

SetOutputSpacing() [1/2]

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetOutputSpacing ( const SpacePrecisionType * spacing )

virtual

Set the output image spacing.

SetOutputSpacing() [2/2]

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetOutputSpacing ( SpacingType _arg )

virtual

Set the output image spacing.

SetOutputStartIndex()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetOutputStartIndex ( IndexType _arg )

virtual

Set/Get the start index of the output largest possible region. The default is an index of all zeros.

SetSize()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetSize ( SizeType _arg )

virtual

Set/Get the size of the output image.

SetTransform()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetTransform ( const TransformType * _arg )

virtual

SetTransformInput()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetTransformInput ( const DataObjectDecorator< TransformType > * _arg )

virtual

SetUseReferenceImage()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::SetUseReferenceImage ( bool _arg )

virtual

Turn on/off whether a specified reference image should be used to define the output information.

UseReferenceImageOff()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::UseReferenceImageOff ( )

virtual

Turn on/off whether a specified reference image should be used to define the output information.

UseReferenceImageOn()

template<typename TOutputImage, typename TParametersValueType = double>

virtual void itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::UseReferenceImageOn ( )

virtual

Turn on/off whether a specified reference image should be used to define the output information.

Member Data Documentation

ImageDimension

template<typename TOutputImage, typename TParametersValueType = double>

unsigned int itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Number of dimensions.

Definition at line 76 of file itkTransformToDisplacementFieldFilter.h.

m_OutputDirection

template<typename TOutputImage, typename TParametersValueType = double>

DirectionType itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::m_OutputDirection {}

private

Definition at line 197 of file itkTransformToDisplacementFieldFilter.h.

m_OutputOrigin

template<typename TOutputImage, typename TParametersValueType = double>

OriginType itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::m_OutputOrigin {}

private

Definition at line 196 of file itkTransformToDisplacementFieldFilter.h.

m_OutputSpacing

template<typename TOutputImage, typename TParametersValueType = double>

SpacingType itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::m_OutputSpacing {}

private

Definition at line 195 of file itkTransformToDisplacementFieldFilter.h.

m_OutputStartIndex

template<typename TOutputImage, typename TParametersValueType = double>

IndexType itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::m_OutputStartIndex {}

private

Definition at line 194 of file itkTransformToDisplacementFieldFilter.h.

m_Size

template<typename TOutputImage, typename TParametersValueType = double>

SizeType itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::m_Size {}

private

Member variables.

Definition at line 193 of file itkTransformToDisplacementFieldFilter.h.

m_UseReferenceImage

template<typename TOutputImage, typename TParametersValueType = double>

bool itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::m_UseReferenceImage { false }

private

Definition at line 198 of file itkTransformToDisplacementFieldFilter.h.

PixelDimension

template<typename TOutputImage, typename TParametersValueType = double>

unsigned int itk::TransformToDisplacementFieldFilter< TOutputImage, TParametersValueType >::PixelDimension = PixelType::Dimension

staticconstexpr

Definition at line 160 of file itkTransformToDisplacementFieldFilter.h.

---

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

• itkTransformToDisplacementFieldFilter.h