ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members

#include <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 InputImageConstPointer = typename Superclass::InputImageConstPointer
 
using InputImagePointer = typename Superclass::InputImagePointer
 
using InputImageType = typename Superclass::InputImageType
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = InterpolateImageFunction< InputImageType, CoordRepType >
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
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 OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const DisplacementFieldTypeGetDisplacementField () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetDisplacementField (const DisplacementFieldType *input)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
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 ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual void ResetPipeline ()
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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 ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
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
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::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int 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
 
bool m_DefFieldSameInformation
 
IndexType m_StartIndex
 
IndexType m_EndIndex
 
PixelType m_EdgePaddingValue
 
SpacingType m_OutputSpacing
 
PointType m_OutputOrigin
 
DirectionType m_OutputDirection
 
InterpolatorPointer m_Interpolator
 
SizeType m_OutputSize
 
IndexType m_OutputStartIndex
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual const InterpolatorTypeGetInterpolator () const
 
virtual void SetOutputSpacing (SpacingType _arg)
 
virtual void SetOutputSpacing (const double *values)
 
virtual const SpacingTypeGetOutputSpacing () const
 
virtual void SetOutputOrigin (PointType _arg)
 
virtual void SetOutputOrigin (const double *values)
 
virtual const PointTypeGetOutputOrigin () const
 
virtual void SetOutputDirection (DirectionType _arg)
 
virtual const DirectionTypeGetOutputDirection () const
 
void SetOutputParametersFromImage (const ImageBaseType *image)
 
virtual void SetOutputStartIndex (IndexType _arg)
 
virtual const IndexTypeGetOutputStartIndex () const
 
virtual void SetOutputSize (SizeType _arg)
 
virtual const SizeTypeGetOutputSize () const
 
virtual void SetEdgePaddingValue (PixelType _arg)
 
virtual PixelType GetEdgePaddingValue () const
 
void GenerateOutputInformation () override
 
void GenerateInputRequestedRegion () override
 
void BeforeThreadedGenerateData () override
 
void AfterThreadedGenerateData () override
 
 WarpImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void VerifyInputInformation () ITKv5_CONST override
 
void EvaluateDisplacementAtPhysicalPoint (const PointType &p, DisplacementType &output)
 
void EvaluateDisplacementAtPhysicalPoint (const PointType &p, const DisplacementFieldType *fieldPtr, DisplacementType &output)
 

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 >
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void GenerateData () override
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void AllocateOutputs ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.
ITK Sphinx Examples:
\li All ITK Sphinx Examples
Examples
Examples/Filtering/WarpImageFilter1.cxx, and SphinxExamples/src/Filtering/ImageGrid/WarpAnImageUsingADeformationField/Code.cxx.

Definition at line 84 of file itkWarpImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 93 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 131 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 134 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 140 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 127 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 126 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 128 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 123 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 110 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 111 of file itkWarpImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InputImageConstPointer = typename Superclass::InputImageConstPointer

Definition at line 109 of file itkWarpImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InputImagePointer = typename Superclass::InputImagePointer

Definition at line 106 of file itkWarpImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::InputImageType = typename Superclass::InputImageType

Inherit some types from the superclass.

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

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::OutputImagePointer = typename Superclass::OutputImagePointer

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

◆ OutputImageType

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

Definition at line 107 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 114 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 113 of file itkWarpImageFilter.h.

◆ Pointer

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

Definition at line 92 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 137 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 90 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 112 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 115 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 91 of file itkWarpImageFilter.h.

Constructor & Destructor Documentation

◆ WarpImageFilter()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::WarpImageFilter ( )
protected

Get/Set the interpolator function.

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

◆ CreateAnother()

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.

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

◆ EvaluateDisplacementAtPhysicalPoint() [2/2]

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

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

◆ GetDisplacementField()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual const DisplacementFieldType* itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetDisplacementField ( ) const
virtual

Get a pointer the displacement field.

◆ GetEdgePaddingValue()

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

Get the edge padding value

◆ GetInterpolator()

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

Get/Set the interpolator function.

◆ 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 >
virtual const char* itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

Get/Set the interpolator function.

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

◆ 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

Get/Set the interpolator function.

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

◆ SetDisplacementField()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual void itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetDisplacementField ( const DisplacementFieldType input)
virtual

Set the displacement field.

◆ 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 *  values)
virtual

Get/Set the interpolator function.

◆ 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 *  values)
virtual

Get/Set the interpolator function.

◆ 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 ( )
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 120 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 118 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 119 of file itkWarpImageFilter.h.

◆ m_DefFieldSameInformation

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
bool itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_DefFieldSameInformation
protected

Get/Set the interpolator function.

Definition at line 279 of file itkWarpImageFilter.h.

◆ m_EdgePaddingValue

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
PixelType itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_EdgePaddingValue
private

Get/Set the interpolator function.

Definition at line 284 of file itkWarpImageFilter.h.

◆ m_EndIndex

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

Get/Set the interpolator function.

Definition at line 281 of file itkWarpImageFilter.h.

◆ m_Interpolator

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
InterpolatorPointer itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_Interpolator
private

Get/Set the interpolator function.

Definition at line 289 of file itkWarpImageFilter.h.

◆ m_OutputDirection

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

Get/Set the interpolator function.

Definition at line 287 of file itkWarpImageFilter.h.

◆ m_OutputOrigin

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

Get/Set the interpolator function.

Definition at line 286 of file itkWarpImageFilter.h.

◆ m_OutputSize

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

Get/Set the interpolator function.

Definition at line 290 of file itkWarpImageFilter.h.

◆ m_OutputSpacing

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

Get/Set the interpolator function.

Definition at line 285 of file itkWarpImageFilter.h.

◆ m_OutputStartIndex

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

Get/Set the interpolator function.

Definition at line 291 of file itkWarpImageFilter.h.

◆ m_StartIndex

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

Get/Set the interpolator function.

Definition at line 281 of file itkWarpImageFilter.h.


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