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

#include <itkGridForwardWarpImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
DisplacementFieldType::ConstPointer 
DisplacementFieldConstPointer
typedef TDisplacementField DisplacementFieldType
typedef
DisplacementFieldType::PixelType 
DisplacementType
typedef OutputImageType::IndexType IndexType
typedef
Superclass::OutputImagePointer 
OutputImagePointer
typedef TOutputImage::RegionType OutputImageRegionType
typedef Superclass::OutputImageType OutputImageType
typedef OutputImageType::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef GridForwardWarpImageFilter Self
typedef OutputImageType::SizeType SizeType
typedef
OutputImageType::SpacingType 
SpacingType
typedef ImageToImageFilter
< TDisplacementField,
TOutputImage > 
Superclass
- Public Types inherited from itk::ImageToImageFilter< TDisplacementField, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TDisplacementField InputImageType
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual PixelType GetBackgroundValue () const
virtual PixelType GetForegroundValue () const
virtual const char * GetNameOfClass () const
virtual void SetBackgroundValue (PixelType _arg)
virtual void SetForegroundValue (PixelType _arg)
 typedef (Concept::SameDimension< ImageDimension, DisplacementFieldDimension >) SameDimensionCheck
 typedef (Concept::HasNumericTraits< typename TDisplacementField::PixelType::ValueType >) DisplacementFieldHasNumericTraitsCheck
- Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TOutputImage >
const InputImageTypeGetInput (void) const
const InputImageTypeGetInput (unsigned int idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void SetInput (const InputImageType *image)
virtual void SetInput (unsigned int, const TDisplacementField *image)
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (void) const
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension
static const unsigned int DisplacementFieldDimension = TDisplacementField::ImageDimension
- Static Public Attributes inherited from itk::ImageToImageFilter< TDisplacementField, TOutputImage >
static const unsigned int InputImageDimension
static const unsigned int OutputImageDimension
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions

void GenerateData ()
 GridForwardWarpImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~GridForwardWarpImageFilter ()
- Protected Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void GenerateInputRequestedRegion ()
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

 GridForwardWarpImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

PixelType m_BackgroundValue
PixelType m_ForegroundValue
unsigned int m_GridPixSpacing

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TDisplacementField, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType

Detailed Description

template<class TDisplacementField, class 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.

Author:
Tom Vercauteren, INRIA & Mauna Kea Technologies

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

Definition at line 58 of file itkGridForwardWarpImageFilter.h.


Member Typedef Documentation

template<class TDisplacementField , class TOutputImage >
typedef SmartPointer< const Self > itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::ConstPointer
template<class TDisplacementField , class TOutputImage >
typedef DisplacementFieldType::ConstPointer itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::DisplacementFieldConstPointer

Definition at line 94 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef TDisplacementField itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::DisplacementFieldType

Deformation field typedef support.

Definition at line 93 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef DisplacementFieldType::PixelType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::DisplacementType

Definition at line 95 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef OutputImageType::IndexType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::IndexType

Definition at line 80 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef Superclass::OutputImagePointer itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 79 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef TOutputImage::RegionType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type.

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

Definition at line 72 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef Superclass::OutputImageType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::OutputImageType

Inherit some types from the superclass.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 78 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef OutputImageType::PixelType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::PixelType

Definition at line 82 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef SmartPointer< Self > itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::Pointer
template<class TDisplacementField , class TOutputImage >
typedef GridForwardWarpImageFilter itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 63 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef OutputImageType::SizeType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::SizeType

Definition at line 81 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef OutputImageType::SpacingType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::SpacingType

Definition at line 83 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
typedef ImageToImageFilter< TDisplacementField, TOutputImage > itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::Superclass

Constructor & Destructor Documentation

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

End concept checking

template<class TDisplacementField , class TOutputImage >
itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::~GridForwardWarpImageFilter ( )
inlineprotected

Definition at line 120 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::GridForwardWarpImageFilter ( const Self )
private

Member Function Documentation

template<class TDisplacementField , class TOutputImage >
virtual::itk::LightObject::Pointer itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TDisplacementField , class TOutputImage >
void itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::GenerateData ( )
protectedvirtual
template<class TDisplacementField , class TOutputImage >
virtual PixelType itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::GetBackgroundValue ( ) const
virtual

Get the background value

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

Get the foreground value

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

Run-time type information (and related methods)

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

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TDisplacementField , class TOutputImage >
void itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::operator= ( const Self )
private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

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

Set the background value

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

Set the foreground value

template<class TDisplacementField , class TOutputImage >
itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::typedef ( Concept::SameDimension< ImageDimension, DisplacementFieldDimension )

Begin concept checking This class requires SameDimensionCheck in the form of ( Concept::SameDimension< ImageDimension, DisplacementFieldDimension > )

template<class TDisplacementField , class TOutputImage >
itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::typedef ( Concept::HasNumericTraits< typename TDisplacementField::PixelType::ValueType >  )

This class requires DisplacementFieldHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< typename TDisplacementField::PixelType::ValueType > )


Member Data Documentation

template<class TDisplacementField , class TOutputImage >
const unsigned int itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::DisplacementFieldDimension = TDisplacementField::ImageDimension
static

Determine the image dimension.

Definition at line 89 of file itkGridForwardWarpImageFilter.h.

template<class TDisplacementField , class TOutputImage >
const unsigned int itk::GridForwardWarpImageFilter< TDisplacementField, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
static

Determine the image dimension.

Definition at line 87 of file itkGridForwardWarpImageFilter.h.

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

Definition at line 133 of file itkGridForwardWarpImageFilter.h.

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

Definition at line 134 of file itkGridForwardWarpImageFilter.h.

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

Definition at line 135 of file itkGridForwardWarpImageFilter.h.


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