ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField > Class Template Reference

#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:
Filtering/WarpImageFilter1.cxx, RegistrationITKv3/DeformableRegistration10.cxx, RegistrationITKv3/DeformableRegistration16.cxx, RegistrationITKv3/DeformableRegistration17.cxx, RegistrationITKv3/DeformableRegistration2.cxx, RegistrationITKv3/DeformableRegistration3.cxx, RegistrationITKv3/DeformableRegistration5.cxx, RegistrationITKv3/DeformableRegistration9.cxx, RegistrationITKv3/LandmarkWarping2.cxx, RegistrationITKv4/DeformableRegistration10.cxx, RegistrationITKv4/DeformableRegistration16.cxx, RegistrationITKv4/DeformableRegistration17.cxx, RegistrationITKv4/DeformableRegistration2.cxx, RegistrationITKv4/DeformableRegistration3.cxx, RegistrationITKv4/DeformableRegistration5.cxx, RegistrationITKv4/DeformableRegistration9.cxx, and RegistrationITKv4/LandmarkWarping2.cxx.

Definition at line 88 of file itkWarpImageFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
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::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
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 SelfConstPointer
 
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< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
DisplacementFieldTypeGetDisplacementField (void)
 
virtual PixelType GetEdgePaddingValue () const
 
virtual const char * GetNameOfClass () const
 
virtual const PointTypeGetOutputOrigin () const
 
virtual const SizeTypeGetOutputSize () const
 
virtual const SpacingTypeGetOutputSpacing () const
 
virtual const IndexTypeGetOutputStartIndex () 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::PixelType >) InputHasNumericTraitsCheck
 
 typedef (Concept::HasNumericTraits< typename TDisplacementField::PixelType::ValueType >) DisplacementFieldHasNumericTraitsCheck
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual const InterpolatorTypeGetInterpolator () 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 DirectionTypeGetOutputDirection () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
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 >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput (void)
 
const OutputImageTypeGetOutput (void) const
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) ITK_OVERRIDE
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
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)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
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 ThreadIdTypeGetNumberOfThreads () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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 PrintSelf (std::ostream &os, Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void VerifyInputInformation ()
 
 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)
 
void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AllocateOutputs ()
 
virtual void GenerateData () ITK_OVERRIDE
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) 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)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (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)
 
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 SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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 ()
 

Private Member Functions

void EvaluateDisplacementAtPhysicalPoint (const PointType &p, DisplacementType &output)
 
void operator= (const Self &)
 
 WarpImageFilter (const Self &)
 

Private Attributes

bool m_DefFieldSizeSame
 
PixelType m_EdgePaddingValue
 
IndexType m_EndIndex
 
InterpolatorPointer m_Interpolator
 
DirectionType m_OutputDirection
 
PointType m_OutputOrigin
 
SizeType m_OutputSize
 
SpacingType m_OutputSpacing
 
IndexType m_OutputStartIndex
 
IndexType m_StartIndex
 

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
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

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 142 of file itkWarpImageFilter.h.

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

Definition at line 146 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 152 of file itkWarpImageFilter.h.

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

Definition at line 132 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 131 of file itkWarpImageFilter.h.

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

Definition at line 133 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 128 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 144 of file itkWarpImageFilter.h.

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

Definition at line 143 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::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 149 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 117 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 ( )
virtual

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

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

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::EvaluateDisplacementAtPhysicalPoint ( const PointType p,
DisplacementType output 
)
private

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

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

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

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

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
protectedvirtual

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

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

Reimplemented from itk::ImageSource< TOutputImage >.

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::PixelType >  )

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

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

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 125 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 121 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 123 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
bool itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_DefFieldSizeSame
private

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 284 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
IndexType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_EndIndex
private

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 289 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
DirectionType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputDirection
private

Definition at line 287 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
PointType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputOrigin
private

Definition at line 286 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
SizeType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputSize
private

Definition at line 290 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
SpacingType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputSpacing
private

Definition at line 285 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
IndexType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputStartIndex
private

Definition at line 291 of file itkWarpImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
IndexType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_StartIndex
private

Definition at line 294 of file itkWarpImageFilter.h.


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