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

#include <itkPolyLineParametricPath.h>

Inheritance diagram for itk::PolyLineParametricPath< VDimension >:

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

[legend]List of all members.

---

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 55 of file itkPolyLineParametricPath.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex< double, VDimension >	ContinuousIndexType
typedef Index< VDimension >	IndexType
typedef Superclass::InputType	InputType
typedef Offset< VDimension >	OffsetType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Point< double, VDimension >	PointType
typedef PolyLineParametricPath	Self
typedef ParametricPath< VDimension >	Superclass
typedef Vector< double, VDimension >	VectorType
typedef VertexListType::Pointer	VertexListPointer
typedef VectorContainer< unsigned, VertexType >	VertexListType
typedef ContinuousIndexType	VertexType
Public Member Functions
virtual InputType	EndOfInput () const
virtual OutputType	Evaluate (const InputType &input) const
virtual VectorType	EvaluateDerivative (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const
virtual const InputType &	GetDefaultInputStepSize ()
virtual const char *	GetNameOfClass () const
virtual const VertexListType *	GetVertexList ()
virtual OffsetType	IncrementInput (InputType &input) const
virtual void	Initialize (void)
	itkStaticConstMacro (PathDimension, unsigned int, VDimension)
virtual void	SetDefaultInputStepSize (InputType _arg)
virtual InputType	StartOfInput () const
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).*/inline void AddVertex(const ContinuousIndexType &vertex)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
	Path ()
	PolyLineParametricPath ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~PolyLineParametricPath ()
Protected Attributes
InputType	m_DefaultInputStepSize

---

Member Typedef Documentation

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

Reimplemented from itk::ParametricPath< VDimension >. Definition at line 63 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 76 of file itkPolyLineParametricPath.h.

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 77 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 66 of file itkPolyLineParametricPath.h.

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

Reimplemented from itk::ParametricPath< VDimension >. Definition at line 78 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 72 of file itkPolyLineParametricPath.h.

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

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

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

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

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

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

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

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

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

Definition at line 83 of file itkPolyLineParametricPath.h.

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

Definition at line 82 of file itkPolyLineParametricPath.h.

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

Definition at line 81 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 126 of file itkPolyLineParametricPath.h.

---

Member Function Documentation

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 107 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 VectorType itk::ParametricPath< VDimension >::EvaluateDerivative (  const InputType &  input  )  const [virtual, inherited]

Evaluate the first derivative of the ND output with respect to the 1D input. This is a very simple and naive numerical derivative, and it sould be overloaded with a proper closed-form derivative function in all children. Nevertheless, users who need to create their own parametric classes for their private research need not reimplement this function if their work does not need the derivative operator. Reimplemented in itk::FourierSeriesPath< VDimension >.

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

Return the nearest index to the parametric path at the specified location. This is a wrapper to Evaluate(). Implements itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

template<unsigned int VDimension> virtual const InputType& itk::ParametricPath< VDimension >::GetDefaultInputStepSize (   )  [virtual, inherited]

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.

virtual IndexType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::GetZeroIndex (   )  const [protected, virtual, inherited]

virtual OffsetType itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::GetZeroOffset (   )  const [protected, virtual, inherited]

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

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 bounds checking. This is a fairly slow, iterative algorithm that numerically converges to the next index along the path, in a vertex-connected (8-connected in 2D) fashion. When possible, children of this class should overload this function with something more efficient. WARNING: This default implementation REQUIRES that the ND endpoint of the path be either unique or coincident only with the startpoint, since it uses the endpoint as a stopping condition. Implements itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

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

Needed for Pipelining Definition at line 116 of file itkPolyLineParametricPath.h.

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

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

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

New() method for dynamic construction

itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::Path (   )  [protected, inherited]

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

Reimplemented from itk::ParametricPath< VDimension >.

template<unsigned int VDimension> virtual void itk::ParametricPath< VDimension >::SetDefaultInputStepSize (  InputType  _arg  )  [virtual, inherited]

virtual InputType itk::Path< double , ContinuousIndex< double, 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. Reimplemented in itk::OrthogonallyCorrected2DParametricPath. Definition at line 79 of file itkPath.h.

template<unsigned int VDimension> Add a itk::PolyLineParametricPath< VDimension >::vertex (  and a connecting line segment to the previous  vertex  )  const [inline]

Evaluate the first derivative of the ND output with respect to the 1D // * input. This is an exact, algebraic function. Definition at line 93 of file itkPolyLineParametricPath.h.

---

Member Data Documentation

template<unsigned int VDimension> InputType itk::ParametricPath< VDimension >::m_DefaultInputStepSize [protected, inherited]

Default 1D input increment amount to trace along the path. Also, the value used by the defualt implementation of EvaluateDerivative() for numerically approximating the derivative with the change over a single default-sized step. (NOTE that the default implementation of EvaluateDerivative() should never be used in practice, but users or lazzy developers may nevertheless unwisely choose to do so anyway.) For integer- input-types, 1 is probably the correct value. For double-input-types, either 1 or 0.1 are probably good values. This value should be set in the constructor of all instantiable children. Values set in child constructors overwrite values set in parent constructors. Definition at line 136 of file itkParametricPath.h.

---

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

• itkPolyLineParametricPath.h

---