#include <itkPolyLineParametricPath.h>

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

ITK Sphinx Examples:

All ITK Sphinx Examples

Data Structure For Piece-Wise Linear Curve

Examples: Examples/DataRepresentation/Path/PolyLineParametricPath1.cxx, and SphinxExamples/src/Filtering/Path/DataStructureForPieceWiseLinearCurve/Code.cxx.

Definition at line 57 of file itkPolyLineParametricPath.h.

Inheritance diagram for itk::PolyLineParametricPath< VDimension >:

Collaboration diagram for itk::PolyLineParametricPath< VDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = Index< VDimension >

using	OffsetType = Offset< VDimension >

using	Pointer = SmartPointer< Self >

using	PointType = Point< double, VDimension >

using	Self = PolyLineParametricPath

using	Superclass = ParametricPath< VDimension >

using	VectorType = Vector< double, VDimension >

using	VertexListPointer = typename VertexListType::Pointer

using	VertexListType = VectorContainer< unsigned int, VertexType >

using	VertexType = ContinuousIndexType

Public Types inherited from itk::ParametricPath< VDimension >
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< SpacePrecisionType, VDimension >

using	IndexType = Index< VDimension >

using	OffsetType = Offset< VDimension >

using	Pointer = SmartPointer< Self >

using	Self = ParametricPath

using	Superclass = Path< double, ContinuousIndexType, VDimension >

using	VectorType = Vector< double, VDimension >

Public Types inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
using	ConstPointer = SmartPointer< const Self >

using	IndexType = Index< VDimension >

using	InputType = double

using	OffsetType = Offset< VDimension >

using	OutputType = ContinuousIndex< SpacePrecisionType, VDimension >

using	Pointer = SmartPointer< Self >

using	Self = Path

using	Superclass = DataObject

Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type

using	Pointer = SmartPointer< Self >

using	Self = DataObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
InputType	EndOfInput () const override

OutputType	Evaluate (const InputType &input) const override

VectorType	EvaluateDerivative (const InputType &input) const override

virtual VertexListType *	GetModifiableVertexList ()

const char *	GetNameOfClass () const override

OffsetType	IncrementInput (InputType &input) const override

void	Initialize () override


void	AddVertex (const ContinuousIndexType &vertex)

Public Member Functions inherited from itk::ParametricPath< VDimension >
IndexType	EvaluateToIndex (const InputType &input) const override

virtual const InputType &	GetDefaultInputStepSize () const

virtual void	SetDefaultInputStepSize (InputType _arg)

Public Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
const char *	GetNameOfClass () const override

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

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

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

void	UpdateSource () const

virtual bool	VerifyRequestedRegion ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static Pointer	New ()

static void	SetGlobalReleaseDataFlag (bool val)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

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

static Pointer	New ()

Protected Member Functions
	PolyLineParametricPath ()

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

	~PolyLineParametricPath () override=default

Protected Member Functions inherited from itk::ParametricPath< VDimension >
	ParametricPath ()

	~ParametricPath () override=default

Protected Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual IndexType	GetZeroIndex () const

virtual OffsetType	GetZeroOffset () const

	Path ()

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

	~Path () override=default

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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 Attributes
VertexListPointer	m_VertexList {}

Additional Inherited Members
Static Public Attributes inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
static constexpr unsigned int	PathDimension

Protected Attributes inherited from itk::ParametricPath< VDimension >
InputType	m_DefaultInputStepSize {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 66 of file itkPolyLineParametricPath.h.

◆ IndexType

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::IndexType = Index<VDimension>

Definition at line 79 of file itkPolyLineParametricPath.h.

◆ OffsetType

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::OffsetType = Offset<VDimension>

Definition at line 80 of file itkPolyLineParametricPath.h.

◆ Pointer

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::Pointer = SmartPointer<Self>

Definition at line 65 of file itkPolyLineParametricPath.h.

◆ PointType

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::PointType = Point<double, VDimension>

Definition at line 81 of file itkPolyLineParametricPath.h.

◆ Self

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::Self = PolyLineParametricPath

Standard class type aliases.

Definition at line 63 of file itkPolyLineParametricPath.h.

◆ Superclass

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::Superclass = ParametricPath<VDimension>

Definition at line 64 of file itkPolyLineParametricPath.h.

◆ VectorType

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::VectorType = Vector<double, VDimension>

Definition at line 82 of file itkPolyLineParametricPath.h.

◆ VertexListPointer

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::VertexListPointer = typename VertexListType::Pointer

Definition at line 85 of file itkPolyLineParametricPath.h.

◆ VertexListType

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::VertexListType = VectorContainer<unsigned int, VertexType>

Definition at line 84 of file itkPolyLineParametricPath.h.

◆ VertexType

template<unsigned int VDimension>

using itk::PolyLineParametricPath< VDimension >::VertexType = ContinuousIndexType

Definition at line 83 of file itkPolyLineParametricPath.h.

Constructor & Destructor Documentation

◆ PolyLineParametricPath()

template<unsigned int VDimension>

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

protected

◆ ~PolyLineParametricPath()

template<unsigned int VDimension>

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

overrideprotecteddefault

Member Function Documentation

◆ AddVertex()

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 vertices is separated by one unit of input).

Definition at line 100 of file itkPolyLineParametricPath.h.

◆ EndOfInput()

template<unsigned int VDimension>

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

inlineoverridevirtual

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 vertices - 1.

Reimplemented from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >.

Definition at line 111 of file itkPolyLineParametricPath.h.

◆ Evaluate()

template<unsigned int VDimension>

OutputType itk::PolyLineParametricPath< VDimension >::Evaluate ( const InputType & input ) const

overridevirtual

Return the location of the parametric path at the specified location.

Implements itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >.

◆ EvaluateDerivative()

template<unsigned int VDimension>

VectorType itk::PolyLineParametricPath< VDimension >::EvaluateDerivative ( const InputType & input ) const

overridevirtual

This function overrides the superclass EvaluateDerivative and instead calculates the instantaneous derivative of input by taking the index of the previous and next integral timepoints and subtracting them

Reimplemented from itk::ParametricPath< VDimension >.

◆ GetModifiableVertexList()

template<unsigned int VDimension>

virtual VertexListType* itk::PolyLineParametricPath< VDimension >::GetModifiableVertexList ( )

virtual

Return the container of Vertices as a const object.

◆ GetNameOfClass()

template<unsigned int VDimension>

const char* itk::PolyLineParametricPath< VDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ParametricPath< VDimension >.

◆ IncrementInput()

template<unsigned int VDimension>

OffsetType itk::PolyLineParametricPath< VDimension >::IncrementInput ( InputType & input ) const

overridevirtual

This function overrides the superclass IncrementInput and calculates the next pixel along the path to visit by using the instantaneous partial derivatives to calculate the timestep needed to move along the path by one pixel

Reimplemented from itk::ParametricPath< VDimension >.

◆ Initialize()

template<unsigned int VDimension>

void itk::PolyLineParametricPath< VDimension >::Initialize ( )

inlineoverridevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 121 of file itkPolyLineParametricPath.h.

◆ New()

template<unsigned int VDimension>

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

static

New() method for dynamic construction

◆ PrintSelf()

template<unsigned int VDimension>

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

overrideprotectedvirtual

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

Member Data Documentation

◆ m_VertexList

template<unsigned int VDimension>

VertexListPointer itk::PolyLineParametricPath< VDimension >::m_VertexList {}

private

Definition at line 149 of file itkPolyLineParametricPath.h.

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

itkPolyLineParametricPath.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ OffsetType

◆ Pointer

◆ PointType

◆ Self

◆ Superclass

◆ VectorType

◆ VertexListPointer

◆ VertexListType

◆ VertexType

Constructor & Destructor Documentation

◆ PolyLineParametricPath()

◆ ~PolyLineParametricPath()

Member Function Documentation

◆ AddVertex()

◆ EndOfInput()

◆ Evaluate()

◆ EvaluateDerivative()

◆ GetModifiableVertexList()

◆ GetNameOfClass()

◆ IncrementInput()

◆ Initialize()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ m_VertexList

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