#include <itkChainCodePath.h>

Detailed Description

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

Represent a path as a sequence of connected image index offsets.

This class is intended to represent sequences of connected indices in an image. It does so by storing the offset of each index from its immediately preceding, connected, index. The only image index stored directly is that of the first index. ChainCodePath maps a 1D integer input (step number) to an ND integer output (either an offset or an image index, depending on whether Evaluate or EvaluateToIndex is called).

See also: ChainCodePath2D; ParametricPath; Path; Index; Offset

Definition at line 50 of file itkChainCodePath.h.

Inheritance diagram for itk::ChainCodePath< VDimension >:

Collaboration diagram for itk::ChainCodePath< VDimension >:

Public Types
using	ChainCodeSizeType = typename ChainCodeType::size_type

using	ChainCodeType = std::vector< OffsetType >

using	ConstPointer = SmartPointer< const Self >

using	IndexType = Index< VDimension >

using	OffsetType = OutputType

using	Pointer = SmartPointer< Self >

using	Self = ChainCodePath< VDimension >

using	Superclass = Path< unsigned int, Offset< VDimension >, VDimension >

Public Types inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
using	ConstPointer = SmartPointer< const Self >

using	IndexType = Index< VDimension >

using	InputType = unsigned int

using	OffsetType = Offset< VDimension >

using	OutputType = Offset< 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

IndexType	EvaluateToIndex (const InputType &input) const override

const char *	GetNameOfClass () const override

OffsetType	IncrementInput (InputType &input) const override

virtual ChainCodeSizeType	NumberOfSteps () const


virtual void	SetStart (IndexType _arg)

virtual const IndexType &	GetStart () const


virtual void	InsertStep (InputType position, OffsetType step)


virtual void	ChangeStep (InputType position, OffsetType step)


virtual void	Clear ()


void	Initialize () override

Public Member Functions inherited from itk::Path< unsigned int, Offset< 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 *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

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

Static Public Attributes
static constexpr unsigned int	Dimension = VDimension

Static Public Attributes inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
static constexpr unsigned int	PathDimension

Protected Member Functions
	ChainCodePath ()

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

	~ChainCodePath () override=default

Protected Member Functions inherited from itk::Path< unsigned int, Offset< 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
ChainCodeType	m_Chain {}

IndexType	m_Start {}

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

Member Typedef Documentation

◆ ChainCodeSizeType

template<unsigned int VDimension>

using itk::ChainCodePath< VDimension >::ChainCodeSizeType = typename ChainCodeType::size_type

Definition at line 78 of file itkChainCodePath.h.

◆ ChainCodeType

template<unsigned int VDimension>

using itk::ChainCodePath< VDimension >::ChainCodeType = std::vector<OffsetType>

Definition at line 76 of file itkChainCodePath.h.

◆ ConstPointer

template<unsigned int VDimension>

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

Definition at line 63 of file itkChainCodePath.h.

◆ IndexType

template<unsigned int VDimension>

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

Definition at line 74 of file itkChainCodePath.h.

◆ OffsetType

template<unsigned int VDimension>

using itk::ChainCodePath< VDimension >::OffsetType = OutputType

The output type of this function is an Index

Definition at line 73 of file itkChainCodePath.h.

◆ Pointer

template<unsigned int VDimension>

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

Definition at line 62 of file itkChainCodePath.h.

◆ Self

template<unsigned int VDimension>

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

Standard class type aliases.

Definition at line 59 of file itkChainCodePath.h.

◆ Superclass

template<unsigned int VDimension>

using itk::ChainCodePath< VDimension >::Superclass = Path<unsigned int, Offset<VDimension>, VDimension>

Definition at line 60 of file itkChainCodePath.h.

Constructor & Destructor Documentation

◆ ChainCodePath()

template<unsigned int VDimension>

itk::ChainCodePath< VDimension >::ChainCodePath ( )

protected

◆ ~ChainCodePath()

template<unsigned int VDimension>

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

overrideprotecteddefault

Member Function Documentation

◆ ChangeStep()

template<unsigned int VDimension>

virtual void itk::ChainCodePath< VDimension >::ChangeStep	(	InputType	position,
		OffsetType	step
	)

inlinevirtual

Change the direction of a step in the chaincode

Definition at line 126 of file itkChainCodePath.h.

◆ Clear()

template<unsigned int VDimension>

virtual void itk::ChainCodePath< VDimension >::Clear ( )

inlinevirtual

Remove all steps from the chain code

Reimplemented in itk::ChainCodePath2D.

Definition at line 135 of file itkChainCodePath.h.

◆ EndOfInput()

template<unsigned int VDimension>

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

inlineoverridevirtual

Where does the path end (what is the last valid input value)?

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >.

Definition at line 102 of file itkChainCodePath.h.

◆ Evaluate()

template<unsigned int VDimension>

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

inlineoverridevirtual

Evaluate the chaincode for the offset at the specified path-position.

Implements itk::Path< unsigned int, Offset< VDimension >, VDimension >.

Definition at line 84 of file itkChainCodePath.h.

◆ EvaluateToIndex()

template<unsigned int VDimension>

IndexType itk::ChainCodePath< VDimension >::EvaluateToIndex ( const InputType & input ) const

overridevirtual

Like Evaluate(), but returns the index at the specified path-position.

Implements itk::Path< unsigned int, Offset< VDimension >, VDimension >.

◆ GetNameOfClass()

template<unsigned int VDimension>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ GetStart()

template<unsigned int VDimension>

virtual const IndexType& itk::ChainCodePath< VDimension >::GetStart ( ) const

virtual

Set/Get the index associated with the initial position of the path

◆ IncrementInput()

template<unsigned int VDimension>

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

overridevirtual

Increment the input variable passed by reference and then return the offset stored at the new path-position. If the chaincode is unable to be incremented, input is not changed and an offset of zero is returned, which may be used to check for the end of the chain code.

Implements itk::Path< unsigned int, Offset< VDimension >, VDimension >.

◆ Initialize()

template<unsigned int VDimension>

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

inlineoverridevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 151 of file itkChainCodePath.h.

◆ InsertStep()

template<unsigned int VDimension>

virtual void itk::ChainCodePath< VDimension >::InsertStep	(	InputType	position,
		OffsetType	step
	)

inlinevirtual

Insert a new step into the chaincode at a specified position

Definition at line 117 of file itkChainCodePath.h.

◆ New()

template<unsigned int VDimension>

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

static

New() method for dynamic construction

◆ NumberOfSteps()

template<unsigned int VDimension>

virtual ChainCodeSizeType itk::ChainCodePath< VDimension >::NumberOfSteps ( ) const

inlinevirtual

How many steps in the chaincode?

Reimplemented in itk::ChainCodePath2D.

Definition at line 144 of file itkChainCodePath.h.

◆ PrintSelf()

template<unsigned int VDimension>

void itk::ChainCodePath< 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.

◆ SetStart()

template<unsigned int VDimension>

virtual void itk::ChainCodePath< VDimension >::SetStart ( IndexType _arg )

virtual

Set/Get the index associated with the initial position of the path

Member Data Documentation

◆ Dimension

template<unsigned int VDimension>

constexpr unsigned int itk::ChainCodePath< VDimension >::Dimension = VDimension

staticconstexpr

Dimension underlying input image.

Definition at line 56 of file itkChainCodePath.h.

◆ m_Chain

template<unsigned int VDimension>

ChainCodeType itk::ChainCodePath< VDimension >::m_Chain {}

private

Definition at line 166 of file itkChainCodePath.h.

◆ m_Start

template<unsigned int VDimension>

IndexType itk::ChainCodePath< VDimension >::m_Start {}

private

Definition at line 165 of file itkChainCodePath.h.

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

itkChainCodePath.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ChainCodeSizeType

◆ ChainCodeType

◆ ConstPointer

◆ IndexType

◆ OffsetType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ChainCodePath()

◆ ~ChainCodePath()

Member Function Documentation

◆ ChangeStep()

◆ Clear()

◆ EndOfInput()

◆ Evaluate()

◆ EvaluateToIndex()

◆ GetNameOfClass()

◆ GetStart()

◆ IncrementInput()

◆ Initialize()

◆ InsertStep()

◆ New()

◆ NumberOfSteps()

◆ PrintSelf()

◆ SetStart()

Member Data Documentation

◆ Dimension

◆ m_Chain

◆ m_Start

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