ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField > Class Template Reference

#include <itkWarpVectorImageFilter.h>

Detailed Description

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

Warps an image using an input displacement field.

WarpVectorImageFilter warps an existing image with respect to a given displacement field. The input image is expected to have vector-like pixel types.

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

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

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

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

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

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

The LargestPossibleRegion for the output is inherited from the input displacement field. The output image spacing, origin and direction 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.
WarpVectorImageFilter works only with input images of the type Image< Vector< T, D >, N > and not VectorImage< T, N >.
Author
Corinne Mattmann

Definition at line 89 of file itkWarpVectorImageFilter.h.

+ Inheritance diagram for itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >:
+ Collaboration diagram for itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = double
 
using DefaultInterpolatorType = VectorLinearInterpolateImageFunction< InputImageType, CoordRepType >
 
using DirectionType = typename TOutputImage::DirectionType
 
using DisplacementFieldPointer = typename DisplacementFieldType::Pointer
 
using DisplacementFieldType = TDisplacementField
 
using DisplacementType = typename DisplacementFieldType::PixelType
 
using IndexType = typename OutputImageType::IndexType
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = VectorInterpolateImageFunction< InputImageType, CoordRepType >
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using PixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< CoordRepType, Self::ImageDimension >
 
using Self = WarpVectorImageFilter
 
using SizeType = typename OutputImageType::SizeType
 
using SpacingType = typename OutputImageType::SpacingType
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
using ValueType = typename OutputImageType::PixelType::ValueType
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void BeforeThreadedGenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
DisplacementFieldTypeGetDisplacementField ()
 
virtual PixelType GetEdgePaddingValue () const
 
const char * GetNameOfClass () const override
 
virtual const PointTypeGetOutputOrigin () const
 
virtual const SpacingTypeGetOutputSpacing () const
 
void SetDisplacementField (const DisplacementFieldType *field)
 
void SetDisplacementField (DisplacementFieldType *field)
 
virtual void SetEdgePaddingValue (PixelType _arg)
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual void SetOutputSpacing (SpacingType _arg)
 
virtual void SetOutputSpacing (const double *spacing)
 
virtual void SetOutputOrigin (PointType _arg)
 
virtual void SetOutputOrigin (const double *origin)
 
virtual void SetOutputDirection (DirectionType _arg)
 
virtual const DirectionTypeGetOutputDirection () const
 
- 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 *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
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) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension
 
static constexpr unsigned int PixelDimension = PixelType::Dimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 WarpVectorImageFilter ()
 
 ~WarpVectorImageFilter () override=default
 
- 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 ()
 
void VerifyInputInformation () const override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

PixelType m_EdgePaddingValue {}
 
InterpolatorPointer m_Interpolator {}
 
DirectionType m_OutputDirection {}
 
PointType m_OutputOrigin {}
 
SpacingType m_OutputSpacing {}
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading { true }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 98 of file itkWarpVectorImageFilter.h.

◆ CoordRepType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::CoordRepType = double

Interpolator type alias support

Definition at line 134 of file itkWarpVectorImageFilter.h.

◆ DefaultInterpolatorType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::DefaultInterpolatorType = VectorLinearInterpolateImageFunction<InputImageType, CoordRepType>

Definition at line 137 of file itkWarpVectorImageFilter.h.

◆ DirectionType

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

Type for representing the direction of the output image

Definition at line 143 of file itkWarpVectorImageFilter.h.

◆ DisplacementFieldPointer

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

Definition at line 130 of file itkWarpVectorImageFilter.h.

◆ DisplacementFieldType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::DisplacementFieldType = TDisplacementField

Displacement field type alias support

Definition at line 129 of file itkWarpVectorImageFilter.h.

◆ DisplacementType

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

Definition at line 131 of file itkWarpVectorImageFilter.h.

◆ IndexType

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

Definition at line 116 of file itkWarpVectorImageFilter.h.

◆ InterpolatorPointer

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

Definition at line 136 of file itkWarpVectorImageFilter.h.

◆ InterpolatorType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::InterpolatorType = VectorInterpolateImageFunction<InputImageType, CoordRepType>

Definition at line 135 of file itkWarpVectorImageFilter.h.

◆ OutputImageRegionType

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

Typedef to describe the output image region type.

Definition at line 107 of file itkWarpVectorImageFilter.h.

◆ PixelType

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

Definition at line 118 of file itkWarpVectorImageFilter.h.

◆ Pointer

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

Definition at line 97 of file itkWarpVectorImageFilter.h.

◆ PointType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::PointType = Point<CoordRepType, Self::ImageDimension>

Point type

Definition at line 140 of file itkWarpVectorImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::Self = WarpVectorImageFilter

Standard class type aliases.

Definition at line 95 of file itkWarpVectorImageFilter.h.

◆ SizeType

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

Definition at line 117 of file itkWarpVectorImageFilter.h.

◆ SpacingType

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

Definition at line 119 of file itkWarpVectorImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 96 of file itkWarpVectorImageFilter.h.

◆ ValueType

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
using itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::ValueType = typename OutputImageType::PixelType::ValueType

Definition at line 120 of file itkWarpVectorImageFilter.h.

Constructor & Destructor Documentation

◆ WarpVectorImageFilter()

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

◆ ~WarpVectorImageFilter()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::~WarpVectorImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::BeforeThreadedGenerateData ( )
overridevirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
void itk::WarpVectorImageFilter< 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::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::GenerateOutputInformation ( )
overridevirtual

WarpVectorImageFilter 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 >
DisplacementFieldType* itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetDisplacementField ( )

Get a pointer the displacement field.

◆ GetEdgePaddingValue()

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

Get the edge padding value

◆ GetModifiableInterpolator()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual InterpolatorType* itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetModifiableInterpolator ( )
virtual

Get/Set the interpolator function.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
const char* itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetNameOfClass ( ) const
overridevirtual

◆ GetOutputDirection()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual const DirectionType& itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputDirection ( ) const
virtual

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

◆ GetOutputOrigin()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual const PointType& itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputOrigin ( ) const
virtual

Get the output image origin.

◆ GetOutputSpacing()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual const SpacingType& itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::GetOutputSpacing ( ) const
virtual

Get the output image spacing.

◆ New()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
static Pointer itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
void itk::WarpVectorImageFilter< 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 >.

◆ SetDisplacementField() [1/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetDisplacementField ( const DisplacementFieldType field)

Set the displacement field.

◆ SetDisplacementField() [2/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetDisplacementField ( DisplacementFieldType field)

Set the displacement field (non const for backward compatibility).

◆ SetEdgePaddingValue()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetEdgePaddingValue ( PixelType  _arg)
virtual

Set the edge padding value

◆ SetInterpolator()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetInterpolator ( InterpolatorType _arg)
virtual

Get/Set the interpolator function.

◆ SetOutputDirection()

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual void itk::WarpVectorImageFilter< 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::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputOrigin ( const double *  origin)
virtual

Set the output image origin.

◆ SetOutputOrigin() [2/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputOrigin ( PointType  _arg)
virtual

Set the output image origin.

◆ SetOutputSpacing() [1/2]

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

Set the output image spacing.

◆ SetOutputSpacing() [2/2]

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
virtual void itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputSpacing ( SpacingType  _arg)
virtual

Set the output image spacing.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
constexpr unsigned int itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::ImageDimension = TOutputImage::ImageDimension
staticconstexpr

Determine the image dimension.

Definition at line 123 of file itkWarpVectorImageFilter.h.

◆ m_EdgePaddingValue

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
PixelType itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_EdgePaddingValue {}
private

Definition at line 236 of file itkWarpVectorImageFilter.h.

◆ m_Interpolator

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
InterpolatorPointer itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_Interpolator {}
private

Definition at line 241 of file itkWarpVectorImageFilter.h.

◆ m_OutputDirection

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
DirectionType itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputDirection {}
private

Definition at line 239 of file itkWarpVectorImageFilter.h.

◆ m_OutputOrigin

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
PointType itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputOrigin {}
private

Definition at line 238 of file itkWarpVectorImageFilter.h.

◆ m_OutputSpacing

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
SpacingType itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::m_OutputSpacing {}
private

Definition at line 237 of file itkWarpVectorImageFilter.h.

◆ PixelDimension

template<typename TInputImage , typename TOutputImage , typename TDisplacementField >
constexpr unsigned int itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDisplacementField >::PixelDimension = PixelType::Dimension
staticconstexpr

Dimension of the Vector pixel type.

Definition at line 126 of file itkWarpVectorImageFilter.h.


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