itk::PolyLineParametricPath< VDimension > Class Template Reference

#include <itkPolyLineParametricPath.h>

Inheritance diagram for itk::PolyLineParametricPath< VDimension >:

Collaboration diagram for itk::PolyLineParametricPath< VDimension >:

List of all members.

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 Types inherited from itk::ParametricPath< VDimension >
Public Types inherited from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual InputType	EndOfInput () const
virtual OutputType	Evaluate (const InputType &input) const
virtual const char *	GetNameOfClass () const
virtual void	Initialize (void)
void	AddVertex (const ContinuousIndexType &vertex)
Public Member Functions inherited from itk::ParametricPath< VDimension >
virtual VectorType	EvaluateDerivative (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const
virtual const InputType &	GetDefaultInputStepSize ()
virtual OffsetType	IncrementInput (InputType &input) const
virtual void	SetDefaultInputStepSize (InputType _arg)
Public Member Functions inherited from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >
virtual OutputType	Evaluate (const InputType &input) const =0
virtual IndexType	EvaluateToIndex (const InputType &input) const =0
virtual OffsetType	IncrementInput (InputType &input) const =0
virtual InputType	StartOfInput () const
Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
virtual void	SetRequestedRegion (const DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()
void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
virtual void	Graft (const DataObject *)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Protected Member Functions inherited from itk::ParametricPath< VDimension >
	ParametricPath ()
	~ParametricPath ()
Protected Member Functions inherited from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
	Path ()
	~Path ()
Protected Member Functions inherited from itk::DataObject
virtual void	PropagateResetPipeline ()
	DataObject ()
	~DataObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)
	PolyLineParametricPath (const Self &)

Private Attributes
VertexListPointer	m_VertexList
virtual const VertexListType *	GetVertexList ()
	PolyLineParametricPath ()
	~PolyLineParametricPath ()
void	PrintSelf (std::ostream &os, Indent indent) const

Additional Inherited Members
Protected Attributes inherited from itk::ParametricPath< VDimension >
InputType	m_DefaultInputStepSize

---

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

Wiki Examples:

• All Examples

• A data structure for a piece-wise linear curve

Examples:

itkOrthogonalSwath2DPathFilterTest.cxx.

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

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 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

Return the container of Vertices as a const object.

template<unsigned int VDimension>

itk::PolyLineParametricPath< VDimension >::~PolyLineParametricPath ( )

inlineprotected

Return the container of Vertices as a const object.

Definition at line 124 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension>

itk::PolyLineParametricPath< VDimension >::PolyLineParametricPath ( const Self &  )

private

---

Member Function Documentation

template<unsigned int VDimension>

void itk::PolyLineParametricPath< VDimension >::AddVertex ( const ContinuousIndexType &  vertex )

inline

Evaluate the first derivative of the ND output with respect to the 1D input. This is an exact, algebraic function. 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 separated by one unit of input).

Definition at line 96 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension>

virtual::itk::LightObject::Pointer itk::PolyLineParametricPath< VDimension >::CreateAnother ( void  ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<unsigned int VDimension>

virtual InputType itk::PolyLineParametricPath< VDimension >::EndOfInput ( ) const

inlinevirtual

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 106 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.

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  )

inlinevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 115 of file itkPolyLineParametricPath.h.

template<unsigned int VDimension>

static Pointer itk::PolyLineParametricPath< VDimension >::New ( )

static

New() method for dynamic construction

Reimplemented from itk::Object.

template<unsigned int VDimension>

void itk::PolyLineParametricPath< VDimension >::operator= ( const Self &  )

private

Reimplemented from itk::ParametricPath< VDimension >.

template<unsigned int VDimension>

void itk::PolyLineParametricPath< VDimension >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Return the container of Vertices as a const object.

Reimplemented from itk::ParametricPath< VDimension >.

---

Member Data Documentation

template<unsigned int VDimension>

VertexListPointer itk::PolyLineParametricPath< VDimension >::m_VertexList

private

Definition at line 132 of file itkPolyLineParametricPath.h.

---

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

• itkPolyLineParametricPath.h