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

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

#include <itkChainCodePath.h>

Inheritance diagram for itk::ChainCodePath< VDimension >:

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

[legend]List of all members.

Public Types
typedef ChainCodePath< VDimension >	Self
typedef Path< unsigned int, Offset< VDimension >, VDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::OutputType	OutputType
typedef Superclass::InputType	InputType
typedef OutputType	OffsetType
typedef Index< VDimension >	IndexType
typedef std::vector< OffsetType >	ChainCodeType
Public Member Functions
	itkStaticConstMacro (Dimension, unsigned int, VDimension)
virtual const char *	GetNameOfClass () const
virtual OutputType	Evaluate (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const
virtual OffsetType	IncrementInput (InputType &input) const
virtual InputType	EndOfInput () const
virtual unsigned int	NumberOfSteps () const
virtual void	SetStart (IndexType _arg)
virtual const IndexType &	GetStart ()
virtual void	InsertStep (InputType position, OffsetType step)
virtual void	ChangeStep (InputType position, OffsetType step)
virtual void	Clear ()
virtual void	Initialize (void)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ChainCodePath ()
	~ChainCodePath ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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.

---

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 68 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 156 of file itkChainCodePath.h.

---

Member Function Documentation

template<unsigned int VDimension> virtual void itk::ChainCodePath< VDimension >::ChangeStep (  InputType  position, OffsetType  step )  [inline, virtual]

Change the direction of a step in the chaincode Reimplemented in itk::ChainCodePath2D. Definition at line 123 of file itkChainCodePath.h.

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

Remove all steps from the chain code Reimplemented in itk::ChainCodePath2D. Definition at line 131 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 97 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 82 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]

Set/Get the index associated with the initial position of the path

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> virtual void itk::ChainCodePath< VDimension >::Initialize (  void   )  [inline, virtual]

Needed for Pipelining Reimplemented from itk::DataObject. Definition at line 145 of file itkChainCodePath.h.

template<unsigned int VDimension> virtual void itk::ChainCodePath< VDimension >::InsertStep (  InputType  position, OffsetType  step )  [inline, virtual]

Insert a new step into the chaincode at a specified position Reimplemented in itk::ChainCodePath2D. Definition at line 115 of file itkChainCodePath.h.

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

Dimension underlying input image.

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

New() method for dynamic construction Reimplemented from itk::Object. 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 139 of file itkChainCodePath.h.

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

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::Path< unsigned int, Offset< VDimension >, VDimension >. Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension> virtual void itk::ChainCodePath< VDimension >::SetStart (  IndexType  _arg  )  [virtual]

Set/Get the index associated with the initial position of the path

---

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

• itkChainCodePath.h

---