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

#include <itkGridForwardWarpImageFilter.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer
 
using DisplacementFieldType = TDisplacementField
 
using DisplacementType = typename DisplacementFieldType::PixelType
 
using IndexType = typename OutputImageType::IndexType
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
using PixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = GridForwardWarpImageFilter
 
using SizeType = typename OutputImageType::SizeType
 
using SpacingType = typename OutputImageType::SpacingType
 
using Superclass = ImageToImageFilter< TDisplacementField, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TDisplacementField, 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 = TDisplacementField
 
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 PixelType GetBackgroundValue () const
 
virtual PixelType GetForegroundValue () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetBackgroundValue (PixelType _arg)
 
virtual void SetForegroundValue (PixelType _arg)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, 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 TDisplacementField *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< TDisplacementField, 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 Public Attributes inherited from itk::ImageToImageFilter< TDisplacementField, TOutputImage >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void GenerateData () override
 
 GridForwardWarpImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GridForwardWarpImageFilter () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TOutputImage >
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyInputInformation () ITKv5_CONST override
 
void GenerateInputRequestedRegion () override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
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 GenerateOutputInformation ()
 
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 ()
 

Private Attributes

PixelType m_BackgroundValue
 
PixelType m_ForegroundValue
 
unsigned int m_GridPixSpacing
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TDisplacementField, 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)
 
- 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 TDisplacementField, typename TOutputImage>
class itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >

Warps a grid using an input deformation field.

GridForwardWarpImageFilter warps a grid with respect to a given deformation 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 forward mapping.

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 output image. We round it.

Warning: the functionality provided by this class is currently implemented with more options and multi-threaded in itk::GridImageSource by setting up an appropriate itk::ResampleImageFilter instance to such an object.

Author
Tom Vercauteren, INRIA & Mauna Kea Technologies

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/510

Definition at line 59 of file itkGridForwardWarpImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 68 of file itkGridForwardWarpImageFilter.h.

◆ DisplacementFieldConstPointer

template<typename TDisplacementField , typename TOutputImage >
using itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer

Definition at line 93 of file itkGridForwardWarpImageFilter.h.

◆ DisplacementFieldType

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

Deformation field type alias support

Definition at line 92 of file itkGridForwardWarpImageFilter.h.

◆ DisplacementType

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

Definition at line 94 of file itkGridForwardWarpImageFilter.h.

◆ IndexType

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

Definition at line 82 of file itkGridForwardWarpImageFilter.h.

◆ OutputImagePointer

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

Definition at line 81 of file itkGridForwardWarpImageFilter.h.

◆ OutputImageRegionType

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

Typedef to describe the output image region type.

Definition at line 77 of file itkGridForwardWarpImageFilter.h.

◆ OutputImageType

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

Inherit some types from the superclass.

Definition at line 80 of file itkGridForwardWarpImageFilter.h.

◆ PixelType

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

Definition at line 84 of file itkGridForwardWarpImageFilter.h.

◆ Pointer

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

Definition at line 67 of file itkGridForwardWarpImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 65 of file itkGridForwardWarpImageFilter.h.

◆ SizeType

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

Definition at line 83 of file itkGridForwardWarpImageFilter.h.

◆ SpacingType

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

Definition at line 85 of file itkGridForwardWarpImageFilter.h.

◆ Superclass

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

Definition at line 66 of file itkGridForwardWarpImageFilter.h.

Constructor & Destructor Documentation

◆ GridForwardWarpImageFilter()

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

◆ ~GridForwardWarpImageFilter()

template<typename TDisplacementField , typename TOutputImage >
itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::~GridForwardWarpImageFilter ( )
inlineoverrideprotected

Definition at line 118 of file itkGridForwardWarpImageFilter.h.

Member Function Documentation

◆ CreateAnother()

template<typename TDisplacementField , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::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.

◆ GenerateData()

template<typename TDisplacementField , typename TOutputImage >
void itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetBackgroundValue()

template<typename TDisplacementField , typename TOutputImage >
virtual PixelType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::GetBackgroundValue ( ) const
virtual

Get the background value

◆ GetForegroundValue()

template<typename TDisplacementField , typename TOutputImage >
virtual PixelType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::GetForegroundValue ( ) const
virtual

Get the foreground value

◆ GetNameOfClass()

template<typename TDisplacementField , typename TOutputImage >
virtual const char* itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TDisplacementField , typename TOutputImage >
void itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );
anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();
image->Update();
someFilter->Update();
image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ SetBackgroundValue()

template<typename TDisplacementField , typename TOutputImage >
virtual void itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::SetBackgroundValue ( PixelType  _arg)
virtual

Set the background value

◆ SetForegroundValue()

template<typename TDisplacementField , typename TOutputImage >
virtual void itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::SetForegroundValue ( PixelType  _arg)
virtual

Set the foreground value

Member Data Documentation

◆ DisplacementFieldDimension

template<typename TDisplacementField , typename TOutputImage >
constexpr unsigned int itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::DisplacementFieldDimension = TDisplacementField::ImageDimension
staticconstexpr

Definition at line 89 of file itkGridForwardWarpImageFilter.h.

◆ ImageDimension

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

Determine the image dimension.

Definition at line 88 of file itkGridForwardWarpImageFilter.h.

◆ m_BackgroundValue

template<typename TDisplacementField , typename TOutputImage >
PixelType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::m_BackgroundValue
private

Definition at line 127 of file itkGridForwardWarpImageFilter.h.

◆ m_ForegroundValue

template<typename TDisplacementField , typename TOutputImage >
PixelType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::m_ForegroundValue
private

Definition at line 128 of file itkGridForwardWarpImageFilter.h.

◆ m_GridPixSpacing

template<typename TDisplacementField , typename TOutputImage >
unsigned int itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::m_GridPixSpacing
private

Definition at line 129 of file itkGridForwardWarpImageFilter.h.


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