#include <itkPath.h>

Detailed Description

template<typename TInput, typename TOutput, unsigned int VDimension>
class itk::Path< TInput, TOutput, VDimension >

Represent a path through ND Space.

This base class is intended to represent a path through an image. As a path, it maps a 1D parameter (such as time or arc length, etc) to an index (or possibly an offset or a point) in ND space. This mapping is done via the abstract Evaluate() method, which must be overridden in all instantiable subclasses. The only geometric requirement for a general path is that it be continuous. A path may be open or closed, and may cross itself several times. A classic application of this class is the representation of contours in 2D images using chaincodes or freeman codes. Another use of a path is to guide the movement of an iterator through an image.

Template Parameters

TInput	Type of the 1D parameter of the path, e.g. unsigned int or double.
TOutput	Type of the path location at the given input, e.g. itk::Offset< VDimension > or itk::ContinuousIndex< VDimension >
VDimension	Dimension of the path.

See also: Index; Point; ContinuousIndex

Definition at line 54 of file itkPath.h.

Inheritance diagram for itk::Path< TInput, TOutput, VDimension >:

Collaboration diagram for itk::Path< TInput, TOutput, VDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = Index< VDimension >

using	InputType = TInput

using	OffsetType = Offset< VDimension >

using	OutputType = TOutput

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
virtual InputType	EndOfInput () const

virtual OutputType	Evaluate (const InputType &input) const =0

virtual IndexType	EvaluateToIndex (const InputType &input) const =0

const char *	GetNameOfClass () const override

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

const char *	GetNameOfClass () const override

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

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 *cmd) 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

const char *	GetNameOfClass () const override

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

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

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Attributes
static constexpr unsigned int	PathDimension = VDimension

Protected Member Functions
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 ()

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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

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

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

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
IndexType	m_ZeroIndex {}

OffsetType	m_ZeroOffset {}

Additional Inherited Members
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 Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 63 of file itkPath.h.

◆ IndexType

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::IndexType = Index<VDimension>

All paths must be mappable to index space

Definition at line 78 of file itkPath.h.

◆ InputType

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::InputType = TInput

Input type

Definition at line 72 of file itkPath.h.

◆ OffsetType

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::OffsetType = Offset<VDimension>

Definition at line 79 of file itkPath.h.

◆ OutputType

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::OutputType = TOutput

Output type

Definition at line 75 of file itkPath.h.

◆ Pointer

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::Pointer = SmartPointer<Self>

Definition at line 62 of file itkPath.h.

◆ Self

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::Self = Path

Standard class type aliases.

Definition at line 60 of file itkPath.h.

◆ Superclass

template<typename TInput , typename TOutput , unsigned int VDimension>

using itk::Path< TInput, TOutput, VDimension >::Superclass = DataObject

Definition at line 61 of file itkPath.h.

Constructor & Destructor Documentation

◆ Path()

template<typename TInput , typename TOutput , unsigned int VDimension>

itk::Path< TInput, TOutput, VDimension >::Path ( )

protected

◆ ~Path()

template<typename TInput , typename TOutput , unsigned int VDimension>

itk::Path< TInput, TOutput, VDimension >::~Path ( )

overrideprotecteddefault

Member Function Documentation

◆ EndOfInput()

template<typename TInput , typename TOutput , unsigned int VDimension>

virtual InputType itk::Path< TInput, TOutput, VDimension >::EndOfInput ( ) const

inlinevirtual

Where does the path end (what is the last valid input value)? This value is sometimes used by IncrementInput() to go to the end of a path.

Reimplemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, itk::HilbertPath< TIndexValue, VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 93 of file itkPath.h.

References itk::NumericTraits< T >::OneValue().

◆ Evaluate()

template<typename TInput , typename TOutput , unsigned int VDimension>

virtual OutputType itk::Path< TInput, TOutput, VDimension >::Evaluate ( const InputType & input ) const

pure virtual

Evaluate the path at specified location along the path. Return data is the path's "natural" format.

Implemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::HilbertPath< TIndexValue, VDimension >.

◆ EvaluateToIndex()

template<typename TInput , typename TOutput , unsigned int VDimension>

virtual IndexType itk::Path< TInput, TOutput, VDimension >::EvaluateToIndex ( const InputType & input ) const

pure virtual

Like Evaluate(), except always returns an index

Implemented in itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, itk::ParametricPath< VDimension >, itk::ParametricPath< 2 >, and itk::HilbertPath< TIndexValue, VDimension >.

◆ GetNameOfClass()

template<typename TInput , typename TOutput , unsigned int VDimension>

const char * itk::Path< TInput, TOutput, VDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ GetZeroIndex()

template<typename TInput , typename TOutput , unsigned int VDimension>

virtual IndexType itk::Path< TInput, TOutput, VDimension >::GetZeroIndex ( ) const

protectedvirtual

◆ GetZeroOffset()

template<typename TInput , typename TOutput , unsigned int VDimension>

virtual OffsetType itk::Path< TInput, TOutput, VDimension >::GetZeroOffset ( ) const

protectedvirtual

◆ IncrementInput()

template<typename TInput , typename TOutput , unsigned int VDimension>

virtual OffsetType itk::Path< TInput, TOutput, VDimension >::IncrementInput ( InputType & input ) const

pure 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 general bounds checking, but are required to return an offset of zero when trying to increment from the final valid input value.

Implemented in itk::HilbertPath< TIndexValue, VDimension >, itk::ChainCodePath< VDimension >, itk::ChainCodePath< 2 >, itk::ParametricPath< VDimension >, itk::ParametricPath< 2 >, and itk::PolyLineParametricPath< VDimension >.

◆ PrintSelf()

template<typename TInput , typename TOutput , unsigned int VDimension>

void itk::Path< TInput, TOutput, 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::DataObject.

◆ StartOfInput()

template<typename TInput , typename TOutput , unsigned int VDimension>

virtual InputType itk::Path< TInput, TOutput, VDimension >::StartOfInput ( ) const

inlinevirtual

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 85 of file itkPath.h.

Member Data Documentation

◆ m_ZeroIndex

template<typename TInput , typename TOutput , unsigned int VDimension>

IndexType itk::Path< TInput, TOutput, VDimension >::m_ZeroIndex {}

private

Definition at line 131 of file itkPath.h.

◆ m_ZeroOffset

template<typename TInput , typename TOutput , unsigned int VDimension>

OffsetType itk::Path< TInput, TOutput, VDimension >::m_ZeroOffset {}

private

Definition at line 130 of file itkPath.h.

◆ PathDimension

template<typename TInput , typename TOutput , unsigned int VDimension>

constexpr unsigned int itk::Path< TInput, TOutput, VDimension >::PathDimension = VDimension

staticconstexpr

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

Definition at line 66 of file itkPath.h.

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

itkPath.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ InputType

◆ OffsetType

◆ OutputType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ Path()

◆ ~Path()

Member Function Documentation

◆ EndOfInput()

◆ Evaluate()

◆ EvaluateToIndex()

◆ GetNameOfClass()

◆ GetZeroIndex()

◆ GetZeroOffset()

◆ IncrementInput()

◆ PrintSelf()

◆ StartOfInput()

Member Data Documentation

◆ m_ZeroIndex

◆ m_ZeroOffset

◆ PathDimension