ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::Path< TInput, TOutput, VDimension > Class Template Reference

#include <itkPath.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual InputType EndOfInput () const
virtual OutputType Evaluate (const InputType &input) const =0
virtual IndexType EvaluateToIndex (const InputType &input) const =0
virtual const char * GetNameOfClass () const
virtual OffsetType IncrementInput (InputType &input) const =0
virtual InputType StartOfInput () const

Static Public Attributes

static const unsigned int PathDimension = VDimension

Protected Member Functions

virtual IndexType GetZeroIndex () const
virtual OffsetType GetZeroOffset () const
 Path ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~Path ()

Private Member Functions

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

Private Attributes

IndexType m_ZeroIndex
OffsetType m_ZeroOffset

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 48 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
template<class TInput, class TOutput, unsigned int VDimension>
typedef Index< VDimension > itk::Path< TInput, TOutput, VDimension >::IndexType
template<class TInput, class TOutput, unsigned int VDimension>
typedef TInput itk::Path< TInput, TOutput, VDimension >::InputType
template<class TInput, class TOutput, unsigned int VDimension>
typedef Offset< VDimension > itk::Path< TInput, TOutput, VDimension >::OffsetType
template<class TInput, class TOutput, unsigned int VDimension>
typedef TOutput itk::Path< TInput, TOutput, VDimension >::OutputType
template<class TInput, class TOutput, unsigned int VDimension>
typedef SmartPointer< Self > itk::Path< TInput, TOutput, VDimension >::Pointer
template<class TInput, class TOutput, unsigned int VDimension>
typedef Path itk::Path< TInput, TOutput, VDimension >::Self
template<class TInput, class TOutput, unsigned int VDimension>
typedef DataObject itk::Path< TInput, TOutput, VDimension >::Superclass

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 107 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
itk::Path< TInput, TOutput, VDimension >::Path ( const Self ) [private]

Member Function Documentation

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::PolyLineParametricPath< VDimension >, itk::HilbertPath< TIndexValue, VDimension >, itk::OrthogonallyCorrected2DParametricPath, itk::ChainCodePath< VDimension >, and itk::ChainCodePath< 2 >.

Definition at line 83 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.

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

template<class TInput, class TOutput, unsigned int VDimension>
virtual const char* itk::Path< TInput, TOutput, VDimension >::GetNameOfClass ( ) const [virtual]
template<class TInput, class TOutput, unsigned int VDimension>
virtual IndexType itk::Path< TInput, TOutput, VDimension >::GetZeroIndex ( ) const [protected, virtual]
template<class TInput, class TOutput, unsigned int VDimension>
virtual OffsetType itk::Path< TInput, TOutput, VDimension >::GetZeroOffset ( ) const [protected, virtual]
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.

template<class TInput, class TOutput, unsigned int VDimension>
void itk::Path< TInput, TOutput, VDimension >::operator= ( const Self ) [private]
template<class TInput, class TOutput, unsigned int VDimension>
void itk::Path< TInput, TOutput, VDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Reimplemented from itk::DataObject.

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

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 76 of file itkPath.h.


Member Data Documentation

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

Definition at line 119 of file itkPath.h.

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

Definition at line 118 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>
const unsigned int itk::Path< TInput, TOutput, VDimension >::PathDimension = VDimension [static]

Path dimension. The dimension of a path is fixed at construction.

Definition at line 58 of file itkPath.h.


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