Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::Path< TInput, TOutput, VDimension > Class Template Reference
[Path Representation Objects]

Represent a path through ND Space. More...

#include <itkPath.h>

Inheritance diagram for itk::Path< TInput, TOutput, VDimension >:

Inheritance graph
[legend]
Collaboration diagram for itk::Path< TInput, TOutput, VDimension >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef Path Self
typedef DataObject Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TInput InputType
typedef TOutput OutputType
typedef Index< VDimension > IndexType
typedef Offset< VDimension > OffsetType

Public Member Functions

virtual const char * GetClassName () const
virtual InputType StartOfInput () const
virtual InputType EndOfInput () const
virtual OutputType Evaluate (const InputType &input) const =0
virtual IndexType EvaluateToIndex (const InputType &input) const =0
virtual OffsetType IncrementInput (InputType &input) const =0
virtual void Initialize (void)
virtual void SetRequestedRegion (DataObject *data)
virtual void UpdateOutputInformation ()
virtual void SetRequestedRegionToLargestPossibleRegion ()
virtual void CopyInformation (const DataObject *data)
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual bool VerifyRequestedRegion ()

Protected Member Functions

 Path ()
 ~Path ()

Protected Attributes

OffsetType m_ZeroOffset
IndexType m_ZeroIndex

Detailed Description

template<class TInput, class TOutput, unsigned int VDimension>
class itk::Path< TInput, TOutput, VDimension >

Represent a path through ND Space.

This base class is intended to represent a path through an image. As a path, it maps a 1D parameter (such as time or arc length, etc) to an index (or possibly an offset or a point) in ND space. This mapping is done via the abstract Evaluate() method, which must be overridden in all instantiable subclasses. The only geometric requirement for a gerneral path is that it be continuous. A path may be open or closed, and may cross itself several times. A classic application of this class is the representation of contours in 2D images using chaincodes or freeman codes. Another use of a path is to guide the movement of an iterator through an image.

See also:
Index

Point

ContinuousIndex

Definition at line 51 of file itkPath.h.


Member Typedef Documentation

template<class TInput, class TOutput, unsigned int VDimension>
typedef SmartPointer<const Self> itk::Path< TInput, TOutput, VDimension >::ConstPointer
 

Reimplemented from itk::DataObject.

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 58 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
typedef Index< VDimension > itk::Path< TInput, TOutput, VDimension >::IndexType
 

All paths must be mapable to index space

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 71 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
typedef TInput itk::Path< TInput, TOutput, VDimension >::InputType
 

Input type

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 64 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
typedef Offset< VDimension > itk::Path< TInput, TOutput, VDimension >::OffsetType
 

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 72 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
typedef TOutput itk::Path< TInput, TOutput, VDimension >::OutputType
 

Output type

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 67 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
typedef SmartPointer<Self> itk::Path< TInput, TOutput, VDimension >::Pointer
 

Reimplemented from itk::DataObject.

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 57 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
typedef Path itk::Path< TInput, TOutput, VDimension >::Self
 

Standard class typedefs.

Reimplemented from itk::DataObject.

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 55 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
typedef DataObject itk::Path< TInput, TOutput, VDimension >::Superclass
 

Reimplemented from itk::DataObject.

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

Definition at line 56 of file itkPath.h.


Constructor & Destructor Documentation

template<class TInput, class TOutput, unsigned int VDimension>
itk::Path< TInput, TOutput, VDimension >::Path  )  [protected]
 

template<class TInput, class TOutput, unsigned int VDimension>
itk::Path< TInput, TOutput, VDimension >::~Path  )  [inline, protected]
 

Definition at line 139 of file itkPath.h.


Member Function Documentation

template<class TInput, class TOutput, unsigned int VDimension>
virtual void itk::Path< TInput, TOutput, VDimension >::CopyInformation const DataObject data  )  [virtual]
 

Methods to manage streaming.

Reimplemented from itk::DataObject.

template<class TInput, class TOutput, unsigned int VDimension>
virtual InputType itk::Path< TInput, TOutput, VDimension >::EndOfInput  )  const [inline, virtual]
 

Where does the path end (what is the last valid input value)? This value is sometimes used by IncrementInput() to go to the end of a path.

Reimplemented in itk::ChainCodePath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::PolyLineParametricPath< VDimension >, and itk::ChainCodePath< 2 >.

Definition at line 85 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
virtual OutputType itk::Path< TInput, TOutput, VDimension >::Evaluate const InputType input  )  const [pure virtual]
 

Evaluate the path at specified location along the path. Return data is the path's "natural" format.

Implemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::PolyLineParametricPath< VDimension >, and itk::ChainCodePath< 2 >.

template<class TInput, class TOutput, unsigned int VDimension>
virtual IndexType itk::Path< TInput, TOutput, VDimension >::EvaluateToIndex const InputType input  )  const [pure virtual]
 

Like Evaluate(), except always returns an index

Implemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::ParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

template<class TInput, class TOutput, unsigned int VDimension>
virtual const char* itk::Path< TInput, TOutput, VDimension >::GetClassName  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ParametricPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

template<class TInput, class TOutput, unsigned int VDimension>
virtual OffsetType itk::Path< TInput, TOutput, VDimension >::IncrementInput InputType input  )  const [pure virtual]
 

Increment the input variable passed by reference such that the ND index of the path moves to its next vertex-connected (8-connected in 2D) neighbor. Return the Index-space offset of the path from its prior input to its new input. If the path is unable to increment, input is not changed and an offset of Zero is returned. Children are not required to implement general bounds checking, but are required to return an offset of zero when trying to increment from the final valid input value.

Implemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath2D, itk::ParametricPath< VDimension >, itk::ChainCodePath< 2 >, and itk::ParametricPath< 2 >.

template<class TInput, class TOutput, unsigned int VDimension>
virtual void itk::Path< TInput, TOutput, VDimension >::Initialize void   )  [virtual]
 

Useful for data pipeline updates without memory re-allocation.

Reimplemented from itk::DataObject.

Reimplemented in itk::ChainCodePath< VDimension >, itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::PolyLineParametricPath< VDimension >, and itk::ChainCodePath< 2 >.

template<class TInput, class TOutput, unsigned int VDimension>
virtual bool itk::Path< TInput, TOutput, VDimension >::RequestedRegionIsOutsideOfTheBufferedRegion  )  [virtual]
 

Methods to manage streaming.

Implements itk::DataObject.

template<class TInput, class TOutput, unsigned int VDimension>
virtual void itk::Path< TInput, TOutput, VDimension >::SetRequestedRegion DataObject data  )  [virtual]
 

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to a PointSet.

Implements itk::DataObject.

template<class TInput, class TOutput, unsigned int VDimension>
virtual void itk::Path< TInput, TOutput, VDimension >::SetRequestedRegionToLargestPossibleRegion  )  [virtual]
 

Methods to manage streaming.

Implements itk::DataObject.

template<class TInput, class TOutput, unsigned int VDimension>
virtual InputType itk::Path< TInput, TOutput, VDimension >::StartOfInput  )  const [inline, virtual]
 

Where does the path begin? For most types of paths, the path will begin at zero. This value can be overridden in children, and is necessary for iterators to know how to go to the beginning of a path.

Reimplemented in itk::OrthogonallyCorrected2DParametricPath.

Definition at line 78 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
virtual void itk::Path< TInput, TOutput, VDimension >::UpdateOutputInformation  )  [virtual]
 

Methods to manage streaming.

Implements itk::DataObject.

template<class TInput, class TOutput, unsigned int VDimension>
virtual bool itk::Path< TInput, TOutput, VDimension >::VerifyRequestedRegion  )  [virtual]
 

Methods to manage streaming.

Implements itk::DataObject.


Member Data Documentation

template<class TInput, class TOutput, unsigned int VDimension>
IndexType itk::Path< TInput, TOutput, VDimension >::m_ZeroIndex [protected]
 

Definition at line 136 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
OffsetType itk::Path< TInput, TOutput, VDimension >::m_ZeroOffset [protected]
 

Definition at line 135 of file itkPath.h.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:58:45 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000