ITK  5.4.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::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkInverseDisplacementFieldImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >

Computes the inverse of a displacement field.

InverseDisplacementFieldImageFilter takes a displacement field as input and computes the displacement field that is its inverse. If the input displacement field was mapping coordinates from a space A into a space B, the output of this filter will map coordinates from the space B into the space A.

Given that both the input and output displacement field are represented as discrete images with pixel type vector, the inverse will be only an estimation and will probably not correspond to a perfect inverse. The precision of the inverse can be improved at the price of increasing the computation time and memory consumption in this filter.

The method used for computing the inverse displacement field is to subsample the input field using a regular grid and create Kerned-Base Spline in which the reference landmarks are the coordinates of the deformed point and the target landmarks are the negative of the displacement vectors. The kernel-base spline is then used for regularly sampling the output space and recover vector values for every single pixel.

The subsampling factor used for the regular grid of the input field will determine the number of landmarks in the KernelBased spline and therefore it will have a dramatic effect on both the precision of output displacement field and the computational time required for the filter to complete the estimation. A large subsampling factor will result in few landmarks in the KernelBased spline, therefore on fast computation and low precision. A small subsampling factor will result in a large number of landmarks in the KernelBased spline, therefore a large memory consumption, long computation time and high precision for the inverse estimation.

This filter expects both the input and output images to be of pixel type Vector.

Definition at line 65 of file itkInverseDisplacementFieldImageFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename OutputImageType::IndexType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using KernelTransformPointerType = typename KernelTransformType::Pointer
 
using KernelTransformType = KernelTransform< double, Self::ImageDimension >
 
using OriginPointType = typename TOutputImage::PointType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelComponentType = typename OutputPixelType::ValueType
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = InverseDisplacementFieldImageFilter
 
using SizeType = typename OutputImageType::SizeType
 
using SpacingType = typename TOutputImage::SpacingType
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
ModifiedTimeType GetMTime () const override
 
const char * GetNameOfClass () const override
 
virtual const OriginPointTypeGetOutputOrigin () const
 
virtual const SpacingTypeGetOutputSpacing () const
 
virtual const SizeTypeGetSize () const
 
virtual void SetSize (SizeType _arg)
 
virtual void SetKernelTransform (KernelTransformType *_arg)
 
virtual KernelTransformTypeGetModifiableKernelTransform ()
 
virtual void SetOutputSpacing (SpacingType _arg)
 
virtual void SetOutputSpacing (const double *spacing)
 
virtual void SetOutputOrigin (OriginPointType _arg)
 
virtual void SetOutputOrigin (const double *origin)
 
virtual void SetSubsamplingFactor (unsigned int _arg)
 
virtual unsigned int GetSubsamplingFactor () 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 *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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 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
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 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 GenerateData () override
 
 InverseDisplacementFieldImageFilter ()
 
void PrepareKernelBaseSpline ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~InverseDisplacementFieldImageFilter () 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 () ITKv5_CONST override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
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 void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
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 () ITKv5_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

KernelTransformPointerType m_KernelTransform {}
 
OriginPointType m_OutputOrigin {}
 
SpacingType m_OutputSpacing {}
 
SizeType m_Size {}
 
unsigned int m_SubsamplingFactor {}
 

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
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading {}
 
- 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 >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 74 of file itkInverseDisplacementFieldImageFilter.h.

◆ IndexType

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

Image index type alias.

Definition at line 103 of file itkInverseDisplacementFieldImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 78 of file itkInverseDisplacementFieldImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 77 of file itkInverseDisplacementFieldImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 79 of file itkInverseDisplacementFieldImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Definition at line 76 of file itkInverseDisplacementFieldImageFilter.h.

◆ KernelTransformPointerType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::KernelTransformPointerType = typename KernelTransformType::Pointer

Definition at line 97 of file itkInverseDisplacementFieldImageFilter.h.

◆ KernelTransformType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::KernelTransformType = KernelTransform<double, Self::ImageDimension>

Transform type alias.

Todo:
Check that input and output images have the same number of dimensions; this is required for consistency.

Definition at line 96 of file itkInverseDisplacementFieldImageFilter.h.

◆ OriginPointType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::OriginPointType = typename TOutputImage::PointType

Definition at line 114 of file itkInverseDisplacementFieldImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 81 of file itkInverseDisplacementFieldImageFilter.h.

◆ OutputImageRegionType

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

Typedef to describe the output image region type.

Definition at line 110 of file itkInverseDisplacementFieldImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 80 of file itkInverseDisplacementFieldImageFilter.h.

◆ OutputPixelComponentType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::OutputPixelComponentType = typename OutputPixelType::ValueType

Definition at line 107 of file itkInverseDisplacementFieldImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

Image pixel value type alias.

Definition at line 106 of file itkInverseDisplacementFieldImageFilter.h.

◆ Pointer

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

Definition at line 73 of file itkInverseDisplacementFieldImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 71 of file itkInverseDisplacementFieldImageFilter.h.

◆ SizeType

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

Image size type alias.

Definition at line 100 of file itkInverseDisplacementFieldImageFilter.h.

◆ SpacingType

template<typename TInputImage , typename TOutputImage >
using itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::SpacingType = typename TOutputImage::SpacingType

Image spacing type alias

Definition at line 113 of file itkInverseDisplacementFieldImageFilter.h.

◆ Superclass

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

Definition at line 72 of file itkInverseDisplacementFieldImageFilter.h.

Constructor & Destructor Documentation

◆ InverseDisplacementFieldImageFilter()

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

◆ ~InverseDisplacementFieldImageFilter()

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

Member Function Documentation

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

GenerateData() computes the internal KernelBase spline and resamples the displacement field.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >
void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overridevirtual

InverseDisplacementFieldImageFilter needs a different input requested region than the output requested region. As such, InverseDisplacementFieldImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also
ProcessObject::GenerateInputRequestedRegion()

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

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage >
void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
overridevirtual

InverseDisplacementFieldImageFilter produces an image which is a different size than its input. As such, it needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also
ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::ProcessObject.

◆ GetModifiableKernelTransform()

template<typename TInputImage , typename TOutputImage >
virtual KernelTransformType* itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetModifiableKernelTransform ( )
virtual

Get/Set the coordinate transformation. Set the KernelBase spline used for resampling the displacement grid.

◆ GetMTime()

template<typename TInputImage , typename TOutputImage >
ModifiedTimeType itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMTime ( ) const
overridevirtual

Method Compute the Modified Time based on changed to the components.

Reimplemented from itk::Object.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

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

◆ GetOutputOrigin()

template<typename TInputImage , typename TOutputImage >
virtual const OriginPointType& itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetOutputOrigin ( ) const
virtual

Get the output image origin.

◆ GetOutputSpacing()

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

Get the output image spacing.

◆ GetSize()

template<typename TInputImage , typename TOutputImage >
virtual const SizeType& itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetSize ( ) const
virtual

Get the size of the output image.

◆ GetSubsamplingFactor()

template<typename TInputImage , typename TOutputImage >
virtual unsigned int itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetSubsamplingFactor ( ) const
virtual

Set/Get the factor used for subsampling the input displacement field. A large value in this factor will produce a fast computation of the inverse field but with low precision. A small value of this factor will produce a precise computation of the inverse field at the price of large memory consumption and long computational time.

◆ New()

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

Method for creation through the object factory.

◆ PrepareKernelBaseSpline()

template<typename TInputImage , typename TOutputImage >
void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::PrepareKernelBaseSpline ( )
protected

Subsample the input displacement field and generate the landmarks for the kernel base spline

◆ PrintSelf()

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

◆ SetKernelTransform()

template<typename TInputImage , typename TOutputImage >
virtual void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetKernelTransform ( KernelTransformType _arg)
virtual

Get/Set the coordinate transformation. Set the KernelBase spline used for resampling the displacement grid.

◆ SetOutputOrigin() [1/2]

template<typename TInputImage , typename TOutputImage >
virtual void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetOutputOrigin ( const double *  origin)
virtual

Set the output image origin.

◆ SetOutputOrigin() [2/2]

template<typename TInputImage , typename TOutputImage >
virtual void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetOutputOrigin ( OriginPointType  _arg)
virtual

Set the output image origin.

◆ SetOutputSpacing() [1/2]

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

Set the output image spacing.

◆ SetOutputSpacing() [2/2]

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

Set the output image spacing.

◆ SetSize()

template<typename TInputImage , typename TOutputImage >
virtual void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetSize ( SizeType  _arg)
virtual

Set the size of the output image.

◆ SetSubsamplingFactor()

template<typename TInputImage , typename TOutputImage >
virtual void itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetSubsamplingFactor ( unsigned int  _arg)
virtual

Set/Get the factor used for subsampling the input displacement field. A large value in this factor will produce a fast computation of the inverse field but with low precision. A small value of this factor will produce a precise computation of the inverse field at the price of large memory consumption and long computational time.

Member Data Documentation

◆ ImageDimension

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

Number of dimensions.

Definition at line 90 of file itkInverseDisplacementFieldImageFilter.h.

◆ m_KernelTransform

template<typename TInputImage , typename TOutputImage >
KernelTransformPointerType itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_KernelTransform {}
private

Definition at line 203 of file itkInverseDisplacementFieldImageFilter.h.

◆ m_OutputOrigin

template<typename TInputImage , typename TOutputImage >
OriginPointType itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_OutputOrigin {}
private

Definition at line 206 of file itkInverseDisplacementFieldImageFilter.h.

◆ m_OutputSpacing

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

Definition at line 205 of file itkInverseDisplacementFieldImageFilter.h.

◆ m_Size

template<typename TInputImage , typename TOutputImage >
SizeType itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_Size {}
private

Definition at line 202 of file itkInverseDisplacementFieldImageFilter.h.

◆ m_SubsamplingFactor

template<typename TInputImage , typename TOutputImage >
unsigned int itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_SubsamplingFactor {}
private

Definition at line 208 of file itkInverseDisplacementFieldImageFilter.h.


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