#include <itkSpeedFunctionPathInformation.h>

Inheritance diagram for itk::SpeedFunctionPathInformation< TPoint >:

Collaboration diagram for itk::SpeedFunctionPathInformation< TPoint >:

Detailed Description

template<typename TPoint>
class itk::SpeedFunctionPathInformation< TPoint >

PathInfo class for encapsulating information about a path for a SpeedFunctionToPathFilter Object. The points are stored as follows: end, start, way0, way1, ..., wayN. Fronts are propagated in reverse order: wayN, ..., way1, way0, start. (NOTE: a front is never propagated from end).

The user must provide at least one PathInfo object using SpeedFunctionToPathFilter::AddPathInfo(). If multiple PathInfo objects are added, multiple paths are extracted and saved to separate filter outputs.

Author: Dan Mueller, Queensland University of Technology, dan.muel[at]gmail.com

See Also: LightObject

Definition at line 48 of file itkSpeedFunctionPathInformation.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef TPoint	PointType

typedef SpeedFunctionPathInformation	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
void	AddWayPoint (const PointType &way)

void	ClearInfo ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

const PointType &	GetCurrentFrontAndAdvance ()

const PointType &	GetEndPoint () const

virtual const char *	GetNameOfClass () const

unsigned int	GetNumberOfPoints () const

const PointType &	GetStartPoint () const

const PointType &	GetWayPoint (SizeValueType i) const

bool	HasNextFront () const

const PointType &	PeekCurrentFront () const

const PointType &	PeekNextFront () const

const PointType &	PeekPreviousFront () const

void	SetEndPoint (const PointType &end)

void	SetStartPoint (const PointType &start)

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const

	SpeedFunctionPathInformation ()

virtual	~SpeedFunctionPathInformation ()

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

Protected Attributes
SizeValueType	m_Front

std::vector< PointType >	m_Information

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
void	operator= (const Self &)

	SpeedFunctionPathInformation (const Self &)

Member Typedef Documentation

template<typename TPoint >

typedef SmartPointer<const Self> itk::SpeedFunctionPathInformation< TPoint >::ConstPointer

Definition at line 56 of file itkSpeedFunctionPathInformation.h.

template<typename TPoint >

typedef SmartPointer<Self> itk::SpeedFunctionPathInformation< TPoint >::Pointer

Definition at line 55 of file itkSpeedFunctionPathInformation.h.

template<typename TPoint >

typedef TPoint itk::SpeedFunctionPathInformation< TPoint >::PointType

Some point typedefs.

Definition at line 62 of file itkSpeedFunctionPathInformation.h.

template<typename TPoint >

typedef SpeedFunctionPathInformation itk::SpeedFunctionPathInformation< TPoint >::Self

Standard class typedefs.

Definition at line 53 of file itkSpeedFunctionPathInformation.h.

template<typename TPoint >

typedef LightObject itk::SpeedFunctionPathInformation< TPoint >::Superclass

Definition at line 54 of file itkSpeedFunctionPathInformation.h.

Constructor & Destructor Documentation

template<typename TPoint >

itk::SpeedFunctionPathInformation< TPoint >::SpeedFunctionPathInformation ( )

protected

template<typename TPoint >

virtual itk::SpeedFunctionPathInformation< TPoint >::~SpeedFunctionPathInformation ( )

protectedvirtual

template<typename TPoint >

itk::SpeedFunctionPathInformation< TPoint >::SpeedFunctionPathInformation ( const Self & )

private

Member Function Documentation

template<typename TPoint >

void itk::SpeedFunctionPathInformation< TPoint >::AddWayPoint ( const PointType & way )

template<typename TPoint >

void itk::SpeedFunctionPathInformation< TPoint >::ClearInfo ( )

template<typename TPoint >

virtual::itk::LightObject::Pointer itk::SpeedFunctionPathInformation< TPoint >::CreateAnother ( ) 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::LightObject.

template<typename TPoint >

const PointType& itk::SpeedFunctionPathInformation< TPoint >::GetCurrentFrontAndAdvance ( )

template<typename TPoint >

const PointType& itk::SpeedFunctionPathInformation< TPoint >::GetEndPoint ( ) const

template<typename TPoint >

virtual const char* itk::SpeedFunctionPathInformation< TPoint >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightObject.

template<typename TPoint >

unsigned int itk::SpeedFunctionPathInformation< TPoint >::GetNumberOfPoints ( ) const

template<typename TPoint >

const PointType& itk::SpeedFunctionPathInformation< TPoint >::GetStartPoint ( ) const

template<typename TPoint >

const PointType& itk::SpeedFunctionPathInformation< TPoint >::GetWayPoint ( SizeValueType i ) const

template<typename TPoint >

bool itk::SpeedFunctionPathInformation< TPoint >::HasNextFront ( ) const

template<typename TPoint >

static Pointer itk::SpeedFunctionPathInformation< TPoint >::New ( )

static

Method for creation through the object factory.

template<typename TPoint >

void itk::SpeedFunctionPathInformation< TPoint >::operator= ( const Self & )

private

template<typename TPoint >

const PointType& itk::SpeedFunctionPathInformation< TPoint >::PeekCurrentFront ( ) const

template<typename TPoint >

const PointType& itk::SpeedFunctionPathInformation< TPoint >::PeekNextFront ( ) const

template<typename TPoint >

const PointType& itk::SpeedFunctionPathInformation< TPoint >::PeekPreviousFront ( ) const

template<typename TPoint >

virtual void itk::SpeedFunctionPathInformation< TPoint >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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::LightObject.

template<typename TPoint >

void itk::SpeedFunctionPathInformation< TPoint >::SetEndPoint ( const PointType & end )