#include <itkPath.h>

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

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Index< VDimension >	IndexType
typedef TInput	InputType
typedef Offset< VDimension >	OffsetType
typedef TOutput	OutputType
typedef SmartPointer< Self >	Pointer
typedef Path	Self
typedef DataObject	Superclass
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

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
Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Initialize ()
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
virtual void	SetRequestedRegion (const DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()
void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
virtual void	Graft (const DataObject *)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () 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 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 ()
Protected Member Functions inherited from itk::DataObject
virtual void	PropagateResetPipeline ()
	DataObject ()
	~DataObject ()
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
void	operator= (const Self &)
	Path (const Self &)

Private Attributes
IndexType	m_ZeroIndex
OffsetType	m_ZeroOffset

Additional Inherited Members
Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	SetGlobalReleaseDataFlag (bool val)
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 ()

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.

Template Parameters:

TInput	Type of the 1D parameter of the path, e.g. unsigned int or double.
TOutput	Type of the path location at the given input, e.g. itk::Offset< VDimension > or itk::ContinuousIndex< VDimension >
VDimension	Dimension of the path.

See also:: Index; Point; ContinuousIndex

Definition at line 53 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::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath2D, itk::HilbertPath< TIndexValue, VDimension >, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.

Definition at line 60 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::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::HilbertPath< TIndexValue, VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath2D, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.

Definition at line 75 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::HilbertPath< TIndexValue, VDimension >, itk::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath2D, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.

Definition at line 66 of file itkPath.h.

template<class TInput, class TOutput, unsigned int VDimension>

typedef Offset< VDimension > itk::Path< TInput, TOutput, VDimension >::OffsetType

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

Definition at line 76 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::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::HilbertPath< TIndexValue, VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath2D, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.

Definition at line 72 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::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::ChainCodePath2D, itk::HilbertPath< TIndexValue, VDimension >, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.

Definition at line 59 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::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::HilbertPath< TIndexValue, VDimension >, itk::ChainCodePath2D, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.

Definition at line 57 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::ParametricPath< VDimension >, itk::ParametricPath< 2 >, itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, itk::HilbertPath< TIndexValue, VDimension >, itk::ChainCodePath2D, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, and itk::OrthogonallyCorrected2DParametricPath.

Definition at line 58 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 ( )

inlineprotected

Definition at line 112 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

inlinevirtual

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 88 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

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

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

template<class TInput, class TOutput, unsigned int VDimension>

virtual IndexType itk::Path< TInput, TOutput, VDimension >::GetZeroIndex ( ) const

protectedvirtual

template<class TInput, class TOutput, unsigned int VDimension>

virtual OffsetType itk::Path< TInput, TOutput, VDimension >::GetZeroOffset ( ) const

protectedvirtual

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

Reimplemented from itk::DataObject.

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

template<class TInput, class TOutput, unsigned int VDimension>

void itk::Path< TInput, TOutput, VDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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

inlinevirtual

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

template<class TInput, class TOutput, unsigned int VDimension>

OffsetType itk::Path< TInput, TOutput, VDimension >::m_ZeroOffset

private

Definition at line 123 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 63 of file itkPath.h.

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

itkPath.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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