#include <itkWarpImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TDisplacementField>
class itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >

Warps an image using an input displacement field.

WarpImageFilter warps an existing image with respect to a given displacement field.

A displacement field is represented as a image whose pixel type is some vector type with at least N elements, where N is the dimension of the input image. The vector type must support element access via operator [].

The output image is produced by inverse mapping: the output pixels are mapped back onto the input image. This scheme avoids the creation of any holes and overlaps in the output image.

Each vector in the displacement field represent the distance between a geometric point in the input space and a point in the output space such that:

\[ p_{in} = p_{out} + d \]

Typically the mapped position does not correspond to an integer pixel position in the input image. Interpolation via an image function is used to compute values at non-integer positions. The default interpolation typed used is the LinearInterpolateImageFunction. The user can specify a particular interpolation function via SetInterpolator(). Note that the input interpolator must derive from base class InterpolateImageFunction.

Position mapped to outside of the input image buffer are assigned a edge padding value.

The LargestPossibleRegion for the output is inherited from the input displacement field. The output image spacing, origin and orientation may be set via SetOutputSpacing, SetOutputOrigin and SetOutputDirection. The default are respectively a vector of 1's, a vector of 0's and an identity matrix.

This class is templated over the type of the input image, the type of the output image and the type of the displacement field.

The input image is set via SetInput. The input displacement field is set via SetDisplacementField.

This filter is implemented as a multithreaded filter.

Warning: This filter assumes that the input type, output type and displacement field type all have the same number of dimensions.

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 85 of file itkWarpImageFilter.h.

Inheritance diagram for itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >:

Collaboration diagram for itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CoordRepType = double

using	DefaultInterpolatorType = LinearInterpolateImageFunction< InputImageType, CoordRepType >

using	DirectionType = typename TOutputImage::DirectionType

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = TDisplacementField

using	DisplacementType = typename DisplacementFieldType::PixelType

using	ImageBaseType = ImageBase< Self::ImageDimension >

using	IndexType = typename OutputImageType::IndexType

using	IndexValueType = typename OutputImageType::IndexValueType

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorType = InterpolateImageFunction< InputImageType, CoordRepType >

using	OutputImageRegionType = typename TOutputImage::RegionType

using	PixelComponentType = typename OutputImageType::InternalPixelType

using	PixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = Point< CoordRepType, Self::ImageDimension >

using	Self = WarpImageFilter

using	SizeType = typename OutputImageType::SizeType

using	SpacingType = typename OutputImageType::SpacingType

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

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	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
void	AfterThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

virtual PixelType	GetEdgePaddingValue () const

const char *	GetNameOfClass () const override

virtual const PointType &	GetOutputOrigin () const

virtual const SizeType &	GetOutputSize () const

virtual const SpacingType &	GetOutputSpacing () const

virtual const IndexType &	GetOutputStartIndex () const

	itkGetInputMacro (DisplacementField, DisplacementFieldType)

	itkSetInputMacro (DisplacementField, DisplacementFieldType)

virtual void	SetEdgePaddingValue (PixelType _arg)

void	SetOutputParametersFromImage (const ImageBaseType *image)

virtual void	SetOutputSize (SizeType _arg)

virtual void	SetOutputStartIndex (IndexType _arg)


virtual void	SetInterpolator (InterpolatorType *_arg)

virtual InterpolatorType *	GetModifiableInterpolator ()


virtual void	SetOutputSpacing (SpacingType _arg)

virtual void	SetOutputSpacing (const double *spacing)


virtual void	SetOutputOrigin (PointType _arg)

virtual void	SetOutputOrigin (const double *origin)


virtual void	SetOutputDirection (DirectionType _arg)

virtual const DirectionType &	GetOutputDirection () const

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

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

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

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *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< TOutputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

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

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

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

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

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

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 DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

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

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

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

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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	DisplacementFieldDimension = TDisplacementField::ImageDimension

static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

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	EvaluateDisplacementAtPhysicalPoint (const PointType &point, const DisplacementFieldType *fieldPtr, DisplacementType &output)

void	EvaluateDisplacementAtPhysicalPoint (const PointType &point, DisplacementType &output)

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

void	VerifyInputInformation () const override

	WarpImageFilter ()

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

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

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

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

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

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

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

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

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

	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	SetThreaderUpdateProgress (bool arg)

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

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

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

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
bool	m_DefFieldSameInformation {}

IndexType	m_EndIndex {}

IndexType	m_StartIndex

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 {}

Private Attributes
PixelType	m_EdgePaddingValue {}

InterpolatorPointer	m_Interpolator {}

DirectionType	m_OutputDirection {}

PointType	m_OutputOrigin {}

SizeType	m_OutputSize {}

SpacingType	m_OutputSpacing {}

IndexType	m_OutputStartIndex {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

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

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)

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::ConstPointer = SmartPointer<const Self>

Definition at line 95 of file itkWarpImageFilter.h.

◆ CoordRepType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::CoordRepType = double

Interpolator type alias support

Definition at line 133 of file itkWarpImageFilter.h.

◆ DefaultInterpolatorType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DefaultInterpolatorType = LinearInterpolateImageFunction<InputImageType, CoordRepType>

Definition at line 136 of file itkWarpImageFilter.h.

◆ DirectionType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DirectionType = typename TOutputImage::DirectionType

Type for representing the direction of the output image

Definition at line 142 of file itkWarpImageFilter.h.

◆ DisplacementFieldPointer

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementFieldPointer = typename DisplacementFieldType::Pointer

Definition at line 129 of file itkWarpImageFilter.h.

◆ DisplacementFieldType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementFieldType = TDisplacementField

Displacement field type alias support

Definition at line 128 of file itkWarpImageFilter.h.

◆ DisplacementType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementType = typename DisplacementFieldType::PixelType

Definition at line 130 of file itkWarpImageFilter.h.

◆ ImageBaseType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::ImageBaseType = ImageBase<Self::ImageDimension>

type alias for base image type at the current ImageDimension

Definition at line 125 of file itkWarpImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::IndexType = typename OutputImageType::IndexType

Definition at line 112 of file itkWarpImageFilter.h.

◆ IndexValueType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::IndexValueType = typename OutputImageType::IndexValueType

Definition at line 113 of file itkWarpImageFilter.h.

◆ InterpolatorPointer

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InterpolatorPointer = typename InterpolatorType::Pointer

Definition at line 135 of file itkWarpImageFilter.h.

◆ InterpolatorType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InterpolatorType = InterpolateImageFunction<InputImageType, CoordRepType>

Definition at line 134 of file itkWarpImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::OutputImageRegionType = typename TOutputImage::RegionType

Typedef to describe the output image region type.

Definition at line 104 of file itkWarpImageFilter.h.

◆ PixelComponentType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::PixelComponentType = typename OutputImageType::InternalPixelType

Definition at line 116 of file itkWarpImageFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::PixelType = typename OutputImageType::PixelType

Definition at line 115 of file itkWarpImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::Pointer = SmartPointer<Self>

Definition at line 94 of file itkWarpImageFilter.h.

◆ PointType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::PointType = Point<CoordRepType, Self::ImageDimension>

Point type

Definition at line 139 of file itkWarpImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::Self = WarpImageFilter

Standard class type aliases.

Definition at line 92 of file itkWarpImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SizeType = typename OutputImageType::SizeType

Definition at line 114 of file itkWarpImageFilter.h.

◆ SpacingType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SpacingType = typename OutputImageType::SpacingType

Definition at line 117 of file itkWarpImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 93 of file itkWarpImageFilter.h.

Constructor & Destructor Documentation

◆ WarpImageFilter()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::WarpImageFilter ( )

protected

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::AfterThreadedGenerateData ( )

overridevirtual

This method is used to set the state of the filter after multi-threading.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::BeforeThreadedGenerateData ( )

overridevirtual

This method is used to set the state of the filter before multi-threading.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

WarpImageFilter is implemented as a multi-threaded filter. As such, it needs to provide and implementation for DynamicThreadedGenerateData().

Reimplemented from itk::ImageSource< TOutputImage >.

◆ EvaluateDisplacementAtPhysicalPoint() [1/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::EvaluateDisplacementAtPhysicalPoint	(	const PointType &	point,
		const DisplacementFieldType *	fieldPtr,
		DisplacementType &	output
	)

protected

This function should be in an interpolator but none of the ITK interpolators at this point handle edge conditions properly

◆ EvaluateDisplacementAtPhysicalPoint() [2/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::EvaluateDisplacementAtPhysicalPoint	(	const PointType &	point,
		DisplacementType &	output
	)

protected

This function should be in an interpolator but none of the ITK interpolators at this point handle edge conditions properly

If this method is called in a loop, the EvaluateDisplacementAtPhysicalPoint(const PointType &, const DisplacementFieldType *, DisplacementType &) overload will offer better performance. The displacement field can be obtained using the GetDisplacementField() method

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GenerateInputRequestedRegion ( )

overridevirtual

It is difficult to compute in advance the input image region required to compute the requested output region. Thus the safest thing to do is to request for the whole input image.

For the displacement field, the input requested region set to be the same as that of the output requested region.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GenerateOutputInformation ( )

overridevirtual

WarpImageFilter produces an image which is a different size than its input image. As such, it needs to provide an implementation for GenerateOutputInformation() which set the output information according the OutputSpacing, OutputOrigin and the displacement field's LargestPossibleRegion.

Reimplemented from itk::ProcessObject.

◆ GetEdgePaddingValue()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual PixelType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetEdgePaddingValue ( ) const

virtual

Get the edge padding value

◆ GetModifiableInterpolator()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual InterpolatorType * itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetModifiableInterpolator ( )

virtual

Get/Set the interpolator function.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

const char * itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GetOutputDirection()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual const DirectionType & itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputDirection ( ) const

virtual

Set/Get the direction (orientation) of the output image

◆ GetOutputOrigin()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual const PointType & itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputOrigin ( ) const

virtual

Get the output image origin.

◆ GetOutputSize()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual const SizeType & itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputSize ( ) const

virtual

Get the size of the output image.

◆ GetOutputSpacing()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual const SpacingType & itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputSpacing ( ) const

virtual

Get the output image spacing.

◆ GetOutputStartIndex()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual const IndexType & itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputStartIndex ( ) const

virtual

Get the start index of the output largest possible region.

◆ itkGetInputMacro()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::itkGetInputMacro	(	DisplacementField	,
		DisplacementFieldType
	)

Get a pointer the displacement field.

◆ itkSetInputMacro()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::itkSetInputMacro	(	DisplacementField	,
		DisplacementFieldType
	)

Set the displacement field.

◆ New()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

static Pointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::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::ImageToImageFilter< TInputImage, TOutputImage >.

◆ SetEdgePaddingValue()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetEdgePaddingValue ( PixelType _arg )

virtual

Set the edge padding value

◆ SetInterpolator()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetInterpolator ( InterpolatorType * _arg )

virtual

Get/Set the interpolator function.

◆ SetOutputDirection()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputDirection ( DirectionType _arg )

virtual

Set/Get the direction (orientation) of the output image

◆ SetOutputOrigin() [1/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputOrigin ( const double * origin )

virtual

Set the output image origin.

◆ SetOutputOrigin() [2/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputOrigin ( PointType _arg )

virtual

Set the output image origin.

◆ SetOutputParametersFromImage()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputParametersFromImage ( const ImageBaseType * image )

Helper method to set the output parameters based on this image

◆ SetOutputSize()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputSize ( SizeType _arg )

virtual

Set the size of the output image.

◆ SetOutputSpacing() [1/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputSpacing ( const double * spacing )

virtual

Set the output image spacing.

◆ SetOutputSpacing() [2/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputSpacing ( SpacingType _arg )

virtual

Set the output image spacing.

◆ SetOutputStartIndex()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputStartIndex ( IndexType _arg )

virtual

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

◆ VerifyInputInformation()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::VerifyInputInformation ( ) const

overrideprotectedvirtual

Override VerifyInputInformation() since this filter's inputs do not need to occupy the same physical space. But check the that deformation field has the same number of components as dimensions

See also: ProcessObject::VerifyInputInformation

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Member Data Documentation

◆ DisplacementFieldDimension

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

constexpr unsigned int itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementFieldDimension = TDisplacementField::ImageDimension

staticconstexpr

Definition at line 122 of file itkWarpImageFilter.h.

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

constexpr unsigned int itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Determine the image dimension.

Definition at line 120 of file itkWarpImageFilter.h.

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

constexpr unsigned int itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

Definition at line 121 of file itkWarpImageFilter.h.

◆ m_DefFieldSameInformation

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

bool itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_DefFieldSameInformation {}

protected

Definition at line 281 of file itkWarpImageFilter.h.

◆ m_EdgePaddingValue

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

PixelType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_EdgePaddingValue {}

private

Definition at line 286 of file itkWarpImageFilter.h.

◆ m_EndIndex

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

IndexType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_EndIndex {}

protected

Definition at line 283 of file itkWarpImageFilter.h.

◆ m_Interpolator

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

InterpolatorPointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_Interpolator {}

private

Definition at line 291 of file itkWarpImageFilter.h.

◆ m_OutputDirection

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

DirectionType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputDirection {}

private

Definition at line 289 of file itkWarpImageFilter.h.

◆ m_OutputOrigin

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

PointType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputOrigin {}

private

Definition at line 288 of file itkWarpImageFilter.h.

◆ m_OutputSize

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

SizeType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputSize {}

private

Definition at line 292 of file itkWarpImageFilter.h.

◆ m_OutputSpacing

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

SpacingType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputSpacing {}

private

Definition at line 287 of file itkWarpImageFilter.h.

◆ m_OutputStartIndex

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

IndexType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputStartIndex {}

private

Definition at line 293 of file itkWarpImageFilter.h.

◆ m_StartIndex

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

IndexType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_StartIndex

protected

Definition at line 283 of file itkWarpImageFilter.h.

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

itkWarpImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CoordRepType

◆ DefaultInterpolatorType

◆ DirectionType

◆ DisplacementFieldPointer

◆ DisplacementFieldType

◆ DisplacementType

◆ ImageBaseType

◆ IndexType

◆ IndexValueType

◆ InterpolatorPointer

◆ InterpolatorType

◆ OutputImageRegionType

◆ PixelComponentType

◆ PixelType

◆ Pointer

◆ PointType

◆ Self

◆ SizeType

◆ SpacingType

◆ Superclass

Constructor & Destructor Documentation

◆ WarpImageFilter()

Member Function Documentation

◆ AfterThreadedGenerateData()

◆ BeforeThreadedGenerateData()

◆ DynamicThreadedGenerateData()

◆ EvaluateDisplacementAtPhysicalPoint() [1/2]

◆ EvaluateDisplacementAtPhysicalPoint() [2/2]

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetEdgePaddingValue()

◆ GetModifiableInterpolator()

◆ GetNameOfClass()

◆ GetOutputDirection()

◆ GetOutputOrigin()

◆ GetOutputSize()

◆ GetOutputSpacing()

◆ GetOutputStartIndex()

◆ itkGetInputMacro()

◆ itkSetInputMacro()

◆ New()

◆ PrintSelf()

◆ SetEdgePaddingValue()

◆ SetInterpolator()

◆ SetOutputDirection()

◆ SetOutputOrigin() [1/2]

◆ SetOutputOrigin() [2/2]

◆ SetOutputParametersFromImage()

◆ SetOutputSize()

◆ SetOutputSpacing() [1/2]

◆ SetOutputSpacing() [2/2]

◆ SetOutputStartIndex()

◆ VerifyInputInformation()

Member Data Documentation

◆ DisplacementFieldDimension

◆ ImageDimension

◆ InputImageDimension

◆ m_DefFieldSameInformation

◆ m_EdgePaddingValue

◆ m_EndIndex

◆ m_Interpolator

◆ m_OutputDirection

◆ m_OutputOrigin

◆ m_OutputSize

◆ m_OutputSpacing

◆ m_OutputStartIndex

◆ m_StartIndex