#include <itkWarpImageFilter.h>

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

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

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

Wiki Examples:

Examples:: Examples/Filtering/WarpImageFilter1.cxx, Examples/RegistrationITKv3/DeformableRegistration10.cxx, Examples/RegistrationITKv3/DeformableRegistration16.cxx, Examples/RegistrationITKv3/DeformableRegistration17.cxx, Examples/RegistrationITKv3/DeformableRegistration2.cxx, Examples/RegistrationITKv3/DeformableRegistration3.cxx, Examples/RegistrationITKv3/DeformableRegistration5.cxx, Examples/RegistrationITKv3/DeformableRegistration9.cxx, Examples/RegistrationITKv3/LandmarkWarping2.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, Examples/RegistrationITKv4/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/LandmarkWarping2.cxx, and WikiExamples/Registration/WarpImageFilter.cxx.

Definition at line 88 of file itkWarpImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef double	CoordRepType

typedef LinearInterpolateImageFunction < InputImageType, CoordRepType >	DefaultInterpolatorType

typedef TOutputImage::DirectionType	DirectionType

typedef DisplacementFieldType::Pointer	DisplacementFieldPointer

typedef TDisplacementField	DisplacementFieldType

typedef DisplacementFieldType::PixelType	DisplacementType

typedef ImageBase < itkGetStaticConstMacro(ImageDimension) >	ImageBaseType

typedef OutputImageType::IndexType	IndexType

typedef OutputImageType::IndexValueType	IndexValueType

typedef Superclass::InputImageConstPointer	InputImageConstPointer

typedef Superclass::InputImagePointer	InputImagePointer

typedef Superclass::InputImageType	InputImageType

typedef InterpolatorType::Pointer	InterpolatorPointer

typedef InterpolateImageFunction < InputImageType, CoordRepType >	InterpolatorType

typedef Superclass::OutputImagePointer	OutputImagePointer

typedef TOutputImage::RegionType	OutputImageRegionType

typedef Superclass::OutputImageType	OutputImageType

typedef OutputImageType::InternalPixelType	PixelComponentType

typedef OutputImageType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef Point< CoordRepType, itkGetStaticConstMacro(ImageDimension) >	PointType

typedef WarpImageFilter	Self

typedef OutputImageType::SizeType	SizeType

typedef OutputImageType::SpacingType	SpacingType

typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	AfterThreadedGenerateData () override

virtual void	BeforeThreadedGenerateData () override

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	GenerateInputRequestedRegion () override

virtual void	GenerateOutputInformation () override

DisplacementFieldType *	GetDisplacementField ()

virtual PixelType	GetEdgePaddingValue () const

virtual const char *	GetNameOfClass () const

virtual const PointType &	GetOutputOrigin () const

virtual const SizeType &	GetOutputSize () const

virtual const SpacingType &	GetOutputSpacing () const

virtual const IndexType &	GetOutputStartIndex () const

void	SetDisplacementField (const DisplacementFieldType *field)

virtual void	SetEdgePaddingValue (PixelType _arg)

void	SetOutputParametersFromImage (const ImageBaseType *image)

virtual void	SetOutputSize (SizeType _arg)

virtual void	SetOutputStartIndex (IndexType _arg)

	typedef (Concept::SameDimension< ImageDimension, InputImageDimension >) SameDimensionCheck1

	typedef (Concept::SameDimension< ImageDimension, DisplacementFieldDimension >) SameDimensionCheck2

	typedef (Concept::HasNumericTraits< typename TInputImage::InternalPixelType >) InputHasNumericTraitsCheck

	typedef (Concept::HasNumericTraits< typename TDisplacementField::PixelType::ValueType >) DisplacementFieldHasNumericTraitsCheck


virtual void	SetInterpolator (InterpolatorType *_arg)

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual const InterpolatorType *	GetInterpolator () const


virtual void	SetOutputSpacing (SpacingType _arg)

virtual void	SetOutputSpacing (const double *values)


virtual void	SetOutputOrigin (PointType _arg)

virtual void	SetOutputOrigin (const double *values)


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

virtual void	PopBackInput () override

virtual 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 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 >
OutputImageType *	GetOutput (unsigned int idx)

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

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

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

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

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

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () 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)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (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	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () 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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

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

static const unsigned int	ImageDimension = TOutputImage::ImageDimension

static const unsigned int	InputImageDimension = TInputImage::ImageDimension

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

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	EvaluateDisplacementAtPhysicalPoint (const PointType &p, DisplacementType &output)

void	EvaluateDisplacementAtPhysicalPoint (const PointType &p, const DisplacementFieldType *fieldPtr, DisplacementType &output)

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

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

virtual void	VerifyInputInformation () 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)

	ImageToImageFilter ()

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AllocateOutputs ()

virtual void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual	~ImageSource ()

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

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

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

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

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions ()

	~ProcessObject ()

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) 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)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

virtual	~LightObject ()

Protected Attributes
bool	m_DefFieldSameInformation

IndexType	m_EndIndex

IndexType	m_StartIndex

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
void	operator= (const Self &) ITK_DELETE_FUNCTION

	WarpImageFilter (const Self &) ITK_DELETE_FUNCTION

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 >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

Definition at line 96 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef double itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::CoordRepType

Interpolator typedef support.

Definition at line 143 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

Definition at line 147 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef TOutputImage::DirectionType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DirectionType

Type for representing the direction of the output image

Definition at line 153 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef DisplacementFieldType::Pointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementFieldPointer

Definition at line 133 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef TDisplacementField itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementFieldType

Displacement field typedef support.

Definition at line 132 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef DisplacementFieldType::PixelType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementType

Definition at line 134 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef ImageBase< itkGetStaticConstMacro(ImageDimension) > itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::ImageBaseType

typedef for base image type at the current ImageDimension

Definition at line 129 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef OutputImageType::IndexType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::IndexType

Definition at line 113 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef OutputImageType::IndexValueType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::IndexValueType

Definition at line 114 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef Superclass::InputImageConstPointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InputImageConstPointer

Definition at line 112 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef Superclass::InputImagePointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InputImagePointer

Definition at line 109 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef Superclass::InputImageType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InputImageType

Inherit some types from the superclass.

Definition at line 108 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef InterpolatorType::Pointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InterpolatorPointer

Definition at line 145 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

Definition at line 144 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef Superclass::OutputImagePointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::OutputImagePointer

Definition at line 111 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef TOutputImage::RegionType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::OutputImageRegionType

Typedef to describe the output image region type.

Definition at line 102 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef Superclass::OutputImageType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::OutputImageType

Definition at line 110 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef OutputImageType::InternalPixelType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::PixelComponentType

Definition at line 117 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef OutputImageType::PixelType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::PixelType

Definition at line 116 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

Definition at line 95 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef Point< CoordRepType, itkGetStaticConstMacro(ImageDimension) > itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::PointType

Point type

Definition at line 150 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef WarpImageFilter itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::Self

Standard class typedefs.

Definition at line 93 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef OutputImageType::SizeType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SizeType

Definition at line 115 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef OutputImageType::SpacingType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SpacingType

Definition at line 118 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::Superclass

Definition at line 94 of file itkWarpImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

protected

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::WarpImageFilter ( const Self & )

private

Member Function Documentation

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual::itk::LightObject::Pointer itk::WarpImageFilter< TInputImage, TOutputImage, 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::ContinuousBorderWarpImageFilter< TInputImage, TOutputImage, TDisplacementField >.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::EvaluateDisplacementAtPhysicalPoint	(	const PointType &	p,
		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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::EvaluateDisplacementAtPhysicalPoint	(	const PointType &	p,
		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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

virtual 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 implemenation for GenerateOutputInformation() which set the output information according the OutputSpacing, OutputOrigin and the displacement field's LargestPossibleRegion.

Reimplemented from itk::ProcessObject.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

DisplacementFieldType* itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetDisplacementField ( )

Get a pointer the displacement field.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Get the edge padding value

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Get/Set the interpolator function.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Get/Set the interpolator function.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Run-time type information (and related methods)

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

Reimplemented in itk::ContinuousBorderWarpImageFilter< TInputImage, TOutputImage, TDisplacementField >.

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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Get the output image origin.

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.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Get the output image spacing.

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.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::operator= ( const Self & )

private

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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetDisplacementField ( const DisplacementFieldType * field )

Set the displacement field.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Set the edge padding value

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Get/Set the interpolator function.

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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Set the output image origin.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Set the output image origin.

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

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.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Set the output image spacing.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

virtual

Set the output image spacing.

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.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::ContinuousBorderWarpImageFilter< TInputImage, TOutputImage, TDisplacementField >.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::typedef ( Concept::SameDimension< ImageDimension, InputImageDimension > )

This class requires SameDimensionCheck1 in the form of ( Concept::SameDimension< ImageDimension, InputImageDimension > )

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::typedef ( Concept::SameDimension< ImageDimension, DisplacementFieldDimension > )

This class requires SameDimensionCheck2 in the form of ( Concept::SameDimension< ImageDimension, DisplacementFieldDimension > )

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::typedef ( Concept::HasNumericTraits< typename TInputImage::InternalPixelType > )

This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< typename TInputImage::InternalPixelType > )

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::typedef ( Concept::HasNumericTraits< typename TDisplacementField::PixelType::ValueType > )

This class requires DisplacementFieldHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< typename TDisplacementField::PixelType::ValueType > )

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

overrideprotectedvirtual

Override VeriyInputInformation() since this filter's inputs do not need to occoupy 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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

static

Definition at line 126 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

static

Determine the image dimension.

Definition at line 122 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

static

Definition at line 124 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

protected

Definition at line 292 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

private

Definition at line 300 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

protected

Definition at line 294 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

private

Definition at line 305 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

private

Definition at line 303 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

private

Definition at line 302 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

private

Definition at line 306 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

private

Definition at line 301 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

private

Definition at line 307 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >

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

protected

Definition at line 294 of file itkWarpImageFilter.h.

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

itkWarpImageFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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