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

Represent a path of line segments through ND Space. More...

#include <itkPolyLineParametricPath.h>

Inheritance diagram for itk::PolyLineParametricPath< VDimension >:

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

[legend]List of all members.

Public Types
typedef PolyLineParametricPath	Self
typedef ParametricPath< VDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef ContinuousIndex< double, VDimension >	ContinuousIndexType
typedef Index< VDimension >	IndexType
typedef Offset< VDimension >	OffsetType
typedef Point< double, VDimension >	PointType
typedef Vector< double, VDimension >	VectorType
typedef ContinuousIndexType	VertexType
typedef VectorContainer< unsigned, VertexType >	VertexListType
typedef VertexListType::Pointer	VertexListPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual OutputType	Evaluate (const InputType &input) const
virtual InputType	EndOfInput () const
virtual void	Initialize (void)
virtual const VertexListType *	GetVertexList ()
void	AddVertex (const ContinuousIndexType &vertex)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	PolyLineParametricPath ()
	~PolyLineParametricPath ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

Represent a path of line segments through ND Space.

This class is intended to represent parametric paths through an image, where the paths are composed of line segments. Each line segment traverses one unit of input. A classic application of this class is the representation of contours in 2D images, especially when the contours only need to be approximately correct. Another use of a path is to guide the movement of an iterator through an image.

See also:

EllipseParametricPath

FourierSeriesPath

OrthogonallyCorrectedParametricPath

ParametricPath

ChainCodePath

Path

ContinuousIndex

Index

Offset

Vector

Definition at line 56 of file itkPolyLineParametricPath.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ParametricPath< VDimension >. Definition at line 64 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension> typedef ContinuousIndex<double,VDimension> itk::PolyLineParametricPath< VDimension >::ContinuousIndexType

Basic data-structure types used Reimplemented from itk::ParametricPath< VDimension >. Definition at line 77 of file itkPolyLineParametricPath.h. Referenced by itk::PolyLineParametricPath< VDimension >::AddVertex().

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

All paths must be mapable to index space Reimplemented from itk::ParametricPath< VDimension >. Definition at line 78 of file itkPolyLineParametricPath.h.

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

Input type Reimplemented from itk::ParametricPath< VDimension >. Definition at line 70 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension> typedef Offset< VDimension > itk::PolyLineParametricPath< VDimension >::OffsetType

Reimplemented from itk::ParametricPath< VDimension >. Definition at line 79 of file itkPolyLineParametricPath.h.

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

Output type Reimplemented from itk::ParametricPath< VDimension >. Definition at line 73 of file itkPolyLineParametricPath.h.

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

Reimplemented from itk::ParametricPath< VDimension >. Definition at line 63 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension> typedef Point<double,VDimension> itk::PolyLineParametricPath< VDimension >::PointType

Definition at line 80 of file itkPolyLineParametricPath.h.

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

Standard class typedefs. Reimplemented from itk::ParametricPath< VDimension >. Definition at line 61 of file itkPolyLineParametricPath.h. Referenced by itk::PolyLineParametricPath< VDimension >::~PolyLineParametricPath().

template<unsigned int VDimension> typedef ParametricPath<VDimension> itk::PolyLineParametricPath< VDimension >::Superclass

Reimplemented from itk::ParametricPath< VDimension >. Definition at line 62 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension> typedef Vector<double,VDimension> itk::PolyLineParametricPath< VDimension >::VectorType

Reimplemented from itk::ParametricPath< VDimension >. Definition at line 81 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension> typedef VertexListType::Pointer itk::PolyLineParametricPath< VDimension >::VertexListPointer

Definition at line 84 of file itkPolyLineParametricPath.h. Referenced by itk::PolyLineParametricPath< VDimension >::~PolyLineParametricPath().

template<unsigned int VDimension> typedef VectorContainer<unsigned, VertexType> itk::PolyLineParametricPath< VDimension >::VertexListType

Definition at line 83 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension> typedef ContinuousIndexType itk::PolyLineParametricPath< VDimension >::VertexType

Definition at line 82 of file itkPolyLineParametricPath.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 127 of file itkPolyLineParametricPath.h. References itk::PolyLineParametricPath< VDimension >::Self, and itk::PolyLineParametricPath< VDimension >::VertexListPointer.

---

Member Function Documentation

template<unsigned int VDimension> void itk::PolyLineParametricPath< VDimension >::AddVertex (  const ContinuousIndexType &  vertex  )  [inline]

Add a vertex (and a connecting line segment to the previous vertex). Adding a vertex has the additional effect of extending the domain of the PolyLineParametricPath by 1.0 (each pair of consecutive verticies is seperated by one unit of input). Definition at line 98 of file itkPolyLineParametricPath.h. References itk::PolyLineParametricPath< VDimension >::ContinuousIndexType.

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

Where does the path end? This value is necessary for IncrementInput() to know how to go to the end of a path. Since each line segment covers one unit of input, this is the number of verticies - 1. Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >. Definition at line 108 of file itkPolyLineParametricPath.h.

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

Return the location of the parametric path at the specified location. Implements itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

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

Run-time type information (and related methods). Reimplemented from itk::ParametricPath< VDimension >.

template<unsigned int VDimension> virtual const VertexListType* itk::PolyLineParametricPath< VDimension >::GetVertexList (   )  [virtual]

Return the container of Vertices as a const object.

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

Needed for Pipelining Reimplemented from itk::DataObject. Definition at line 117 of file itkPolyLineParametricPath.h.

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

New() method for dynamic construction Reimplemented from itk::Object.

template<unsigned int VDimension> void itk::PolyLineParametricPath< 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::ParametricPath< VDimension >.

---

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

• itkPolyLineParametricPath.h

---