Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
itk::SlowPolyLineParametricPath< VDimension > Class Template Reference

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

#include <itkSlowPolyLineParametricPath.h>

Inheritance diagram for itk::SlowPolyLineParametricPath< VDimension >:
Collaboration diagram for itk::SlowPolyLineParametricPath< VDimension >:

Public Types

typedef SlowPolyLineParametricPath Self
 
typedef PolyLineParametricPath< VDimension > Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef Superclass::ContinuousIndexType ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PointType PointType
 
typedef Superclass::VectorType VectorType
 
typedef Superclass::VertexType VertexType
 
typedef Superclass::VertexListType VertexListType
 
typedef Superclass::VertexListPointer VertexListPointer
 

Public Member Functions

virtual const char * GetClassName () const
 
virtual OffsetType IncrementInput (InputType &input) const
 
Pointer Clone () const
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 SlowPolyLineParametricPath ()
 
 ~SlowPolyLineParametricPath ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 

Detailed Description

template<unsigned int VDimension>
class itk::SlowPolyLineParametricPath< 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 54 of file itkSlowPolyLineParametricPath.h.

Member Typedef Documentation

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

Definition at line 62 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::ContinuousIndexType itk::SlowPolyLineParametricPath< VDimension >::ContinuousIndexType

Basic data-structure types used

Definition at line 75 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::IndexType itk::SlowPolyLineParametricPath< VDimension >::IndexType

Definition at line 76 of file itkSlowPolyLineParametricPath.h.

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

Input type

Definition at line 65 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::OffsetType itk::SlowPolyLineParametricPath< VDimension >::OffsetType

Definition at line 77 of file itkSlowPolyLineParametricPath.h.

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

Output type

Definition at line 71 of file itkSlowPolyLineParametricPath.h.

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

Definition at line 61 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::PointType itk::SlowPolyLineParametricPath< VDimension >::PointType

Definition at line 78 of file itkSlowPolyLineParametricPath.h.

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

Standard class typedefs.

Definition at line 59 of file itkSlowPolyLineParametricPath.h.

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

Definition at line 60 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::VectorType itk::SlowPolyLineParametricPath< VDimension >::VectorType

Definition at line 79 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::VertexListPointer itk::SlowPolyLineParametricPath< VDimension >::VertexListPointer

Definition at line 82 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::VertexListType itk::SlowPolyLineParametricPath< VDimension >::VertexListType

Definition at line 81 of file itkSlowPolyLineParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::VertexType itk::SlowPolyLineParametricPath< VDimension >::VertexType

Definition at line 80 of file itkSlowPolyLineParametricPath.h.

Constructor & Destructor Documentation

template<unsigned int VDimension>
itk::SlowPolyLineParametricPath< VDimension >::SlowPolyLineParametricPath ( )
protected
template<unsigned int VDimension>
itk::SlowPolyLineParametricPath< VDimension >::~SlowPolyLineParametricPath ( )
inlineprotected

Definition at line 114 of file itkSlowPolyLineParametricPath.h.

Member Function Documentation

template<unsigned int VDimension>
Pointer itk::SlowPolyLineParametricPath< VDimension >::Clone ( ) const
template<unsigned int VDimension>
virtual const char* itk::SlowPolyLineParametricPath< VDimension >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

template<unsigned int VDimension>
virtual OffsetType itk::SlowPolyLineParametricPath< VDimension >::IncrementInput ( InputType input) const
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 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.

template<unsigned int VDimension>
static Pointer itk::SlowPolyLineParametricPath< VDimension >::New ( )
static

Evaluate the first derivative of the ND output with respect to the 1D input. This is an exact, algebraic function. New() method for dynamic construction

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

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