itk::ChainCodePath< VDimension > Class Template Reference
[Path Representation Objects]

#include <itkChainCodePath.h>

Inheritance diagram for itk::ChainCodePath< VDimension >:

[legend]Collaboration diagram for itk::ChainCodePath< VDimension >:

[legend]List of all members.

---

Detailed Description

template<unsigned int VDimension>
class itk::ChainCodePath< VDimension >

Represent a path as a sequence of connected image index offsets.

This class is intended to represent sequences of connected indices in an image. It does so by storing the offset of each index from its immediately preceeding, connected, index. The only image index stored directly is that of the first index. ChainCodePath maps a 1D integer input (step number) to an ND interger output (either an offset or an image index, depending on whether Evaluate or EvaluateToIndex is called).

See also:

ChainCodePath2D

ParametricPath

Path

Index

Offset

Definition at line 49 of file itkChainCodePath.h.

Public Types
typedef std::vector< OffsetType >	ChainCodeType
typedef SmartPointer< const Self >	ConstPointer
typedef Index< VDimension >	IndexType
typedef Superclass::InputType	InputType
typedef OutputType	OffsetType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef ChainCodePath< VDimension >	Self
typedef Path< unsigned int, Offset< VDimension >, VDimension >	Superclass
Public Member Functions
Change the direction of a step in the chaincode *virtual void	ChangeStep (InputType position, OffsetType step)
Remove all steps from the chain code *virtual void	Clear ()
virtual InputType	EndOfInput () const
virtual OutputType	Evaluate (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const
virtual const char *	GetNameOfClass () const
virtual const IndexType &	GetStart ()
virtual OffsetType	IncrementInput (InputType &input) const
Needed for Pipelining *virtual void	Initialize (void)
Insert a new step into the chaincode at a specified position *virtual void	InsertStep (InputType position, OffsetType step)
	itkStaticConstMacro (PathDimension, unsigned int, VDimension)
	itkStaticConstMacro (Dimension, unsigned int, VDimension)
virtual unsigned int	NumberOfSteps () const
Set Get the index associated with the initial position of the path *virtual void	SetStart (IndexType _arg)
virtual InputType	StartOfInput () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	ChainCodePath ()
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
	Path ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~ChainCodePath ()

---

Member Typedef Documentation

template<unsigned int VDimension> typedef std::vector<OffsetType> itk::ChainCodePath< VDimension >::ChainCodeType

Reimplemented in itk::ChainCodePath2D. Definition at line 75 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef SmartPointer<const Self> itk::ChainCodePath< VDimension >::ConstPointer

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 61 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef Index<VDimension> itk::ChainCodePath< VDimension >::IndexType

All paths must be mapable to index space Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 73 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef Superclass::InputType itk::ChainCodePath< VDimension >::InputType

Input type Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 69 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef OutputType itk::ChainCodePath< VDimension >::OffsetType

The output type of this function is an Index Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 72 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef Superclass::OutputType itk::ChainCodePath< VDimension >::OutputType

OutputType typedef support. Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 64 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef SmartPointer<Self> itk::ChainCodePath< VDimension >::Pointer

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 60 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef ChainCodePath<VDimension> itk::ChainCodePath< VDimension >::Self

Standard class typedefs. Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 57 of file itkChainCodePath.h.

template<unsigned int VDimension> typedef Path< unsigned int, Offset< VDimension >, VDimension > itk::ChainCodePath< VDimension >::Superclass

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 58 of file itkChainCodePath.h.

---

Constructor & Destructor Documentation

template<unsigned int VDimension> itk::ChainCodePath< VDimension >::ChainCodePath (   )  [protected]

template<unsigned int VDimension> itk::ChainCodePath< VDimension >::~ChainCodePath (   )  [inline, protected]

Definition at line 152 of file itkChainCodePath.h.

---

Member Function Documentation

template<unsigned int VDimension> Change the direction of a step in the chaincode* virtual void itk::ChainCodePath< VDimension >::ChangeStep (  InputType  position, OffsetType  step )  [inline, virtual]

Reimplemented in itk::ChainCodePath2D. Definition at line 121 of file itkChainCodePath.h.

template<unsigned int VDimension> Remove all steps from the chain code* virtual void itk::ChainCodePath< VDimension >::Clear (   )  [inline, virtual]

Reimplemented in itk::ChainCodePath2D. Definition at line 129 of file itkChainCodePath.h.

template<unsigned int VDimension> virtual InputType itk::ChainCodePath< VDimension >::EndOfInput (   )  const [inline, virtual]

Where does the path end (what is the last valid input value)? Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Definition at line 95 of file itkChainCodePath.h.

template<unsigned int VDimension> virtual OutputType itk::ChainCodePath< VDimension >::Evaluate (  const InputType &  input  )  const [inline, virtual]

Evaluate the chaincode for the offset at the specified path-position. Implements itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D. Definition at line 80 of file itkChainCodePath.h.

template<unsigned int VDimension> virtual IndexType itk::ChainCodePath< VDimension >::EvaluateToIndex (  const InputType &  input  )  const [virtual]

Like Evaluate(), but returns the index at the specified path-position. Implements itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension> virtual const char* itk::ChainCodePath< VDimension >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension> virtual const IndexType& itk::ChainCodePath< VDimension >::GetStart (   )  [virtual]

virtual IndexType itk::Path< unsigned int , Offset< VDimension > , VDimension >::GetZeroIndex (   )  const [protected, virtual, inherited]

virtual OffsetType itk::Path< unsigned int , Offset< VDimension > , VDimension >::GetZeroOffset (   )  const [protected, virtual, inherited]

template<unsigned int VDimension> virtual OffsetType itk::ChainCodePath< VDimension >::IncrementInput (  InputType &  input  )  const [virtual]

Increment the input variable passed by reference and then return the offset stored at the new path-position. If the chaincode is unable to be incremented, input is not changed and an offset of zero is returned, which may be used to check for the end of the chain code. Implements itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension> Needed for Pipelining* virtual void itk::ChainCodePath< VDimension >::Initialize (  void   )  [inline, virtual]

Definition at line 143 of file itkChainCodePath.h.

template<unsigned int VDimension> Insert a new step into the chaincode at a specified position* virtual void itk::ChainCodePath< VDimension >::InsertStep (  InputType  position, OffsetType  step )  [inline, virtual]

Reimplemented in itk::ChainCodePath2D. Definition at line 113 of file itkChainCodePath.h.

itk::Path< unsigned int , Offset< VDimension > , VDimension >::itkStaticConstMacro (  PathDimension  , unsigned  int, VDimension  )  [inherited]

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

template<unsigned int VDimension> itk::ChainCodePath< VDimension >::itkStaticConstMacro (  Dimension  , unsigned  int, VDimension  )

Dimension underlying input image.

template<unsigned int VDimension> static Pointer itk::ChainCodePath< VDimension >::New (   )  [static]

New() method for dynamic construction Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension> virtual unsigned int itk::ChainCodePath< VDimension >::NumberOfSteps (   )  const [inline, virtual]

How many steps in the chaincode? Reimplemented in itk::ChainCodePath2D. Definition at line 137 of file itkChainCodePath.h.

itk::Path< unsigned int , Offset< VDimension > , VDimension >::Path (   )  [protected, inherited]

template<unsigned int VDimension> void itk::ChainCodePath< VDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected]

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension> Set Get the index associated with the initial position of the path* virtual void itk::ChainCodePath< VDimension >::SetStart (  IndexType  _arg  )  [virtual]

virtual InputType itk::Path< unsigned int , Offset< VDimension > , VDimension >::StartOfInput (   )  const [inline, virtual, inherited]

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

---

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

• itkChainCodePath.h

---