itk::ChainCodePath2D Class Reference

#include <itkChainCodePath2D.h>

Inheritance diagram for itk::ChainCodePath2D:

Collaboration diagram for itk::ChainCodePath2D:

Detailed Description

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

This class is intended to represent sequences of connected indices in a 2D image plane. It does so by storing the offset of each index from its immediately preceding, connected, index using a standard Freeman code (1=up, 2=up to the right, and so on proceeding clockwise to 8=up to the left). The only image index stored directly is thatof the first index. ChainCodePath2D maps a 1D integer input (step number) to a 2D integer output (either an offset or an image index, depending on whether Evaluate or EvaluateToIndex is called).

See Also

ChainCodePath

ParametricPath

Path

Index

Definition at line 50 of file itkChainCodePath2D.h.

Public Types
using	ChainCode2DType = std::vector< int >
using	ChainCodeSizeType = Superclass::ChainCodeSizeType
using	ChainCodeType = Superclass::ChainCodeType
using	ConstPointer = SmartPointer< const Self >
using	IndexType = Index< 2 >
using	InputType = Superclass::InputType
using	OffsetType = OutputType
using	OutputType = Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	Self = ChainCodePath2D
using	Superclass = ChainCodePath< 2 >
Public Types inherited from itk::ChainCodePath< 2 >
using	ChainCodeSizeType = typename ChainCodeType::size_type
using	ChainCodeType = std::vector< OffsetType >
using	ConstPointer = SmartPointer< const Self >
using	IndexType = Index< VDimension >
using	InputType = typename Superclass::InputType
using	OffsetType = OutputType
using	OutputType = typename Superclass::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
void	ChangeStep (InputType position, OffsetType step) override
virtual ::itk::LightObject::Pointer	CreateAnother () const
OutputType	Evaluate (const InputType &input) const override
IndexType	EvaluateToIndex (const InputType &input) const override
std::string	GetChainCodeAsString () const
virtual const char *	GetNameOfClass () const
OffsetType	IncrementInput (InputType &input) const override
void	InsertStep (InputType position, OffsetType step) override
ChainCodeSizeType	NumberOfSteps () const override
void	InsertStep (InputType position, int encodedStep)
void	ChangeStep (InputType position, int encodedStep)
void	Clear () override
Public Member Functions inherited from itk::ChainCodePath< 2 >
virtual ::itk::LightObject::Pointer	CreateAnother () const
InputType	EndOfInput () const override
OutputType	Evaluate (const InputType &input) const override
IndexType	EvaluateToIndex (const InputType &input) const override
OffsetType	IncrementInput (InputType &input) const override
virtual void	SetStart (IndexType _arg)
virtual const IndexType &	GetStart () const
virtual void	InsertStep (InputType position, OffsetType step)
virtual void	ChangeStep (InputType position, OffsetType step)
void	Initialize () override
Public Member Functions inherited from itk::Path< unsigned int, Offset< 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 () 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	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 (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
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 noexceptoverride
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
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 ()
Static Public Member Functions inherited from itk::ChainCodePath< 2 >
static Pointer	New ()
Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
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 flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

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

Protected Member Functions
	ChainCodePath2D ()
OffsetType	DecodeOffset (int encodedStep) const
int	EncodeOffset (OffsetType step) const
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ChainCodePath2D () override
Protected Member Functions inherited from itk::ChainCodePath< 2 >
	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 &time)
	~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
ChainCode2DType	m_Chain2D
int	m_FreemanCode [3][3]
OffsetType	m_ReverseFreemanCode [9]

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

Member Typedef Documentation

using itk::ChainCodePath2D::ChainCode2DType = std::vector< int >

ChainCodePath2D stores its data as a Freeman-encoded chain code

Definition at line 82 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::ChainCodeSizeType = Superclass::ChainCodeSizeType

Definition at line 79 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::ChainCodeType = Superclass::ChainCodeType

ChainCodeType is a usless relic of the parent class

Definition at line 78 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::ConstPointer = SmartPointer< const Self >

Definition at line 64 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::IndexType = Index< 2 >

Definition at line 75 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::InputType = Superclass::InputType

Definition at line 71 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::OffsetType = OutputType

The output type of this function is an Index

Definition at line 74 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::OutputType = Superclass::OutputType

OutputType type alias support

Definition at line 70 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::Pointer = SmartPointer< Self >

Definition at line 63 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::Self = ChainCodePath2D

Standard class type aliases.

Definition at line 60 of file itkChainCodePath2D.h.

using itk::ChainCodePath2D::Superclass = ChainCodePath< 2 >

Definition at line 61 of file itkChainCodePath2D.h.

Constructor & Destructor Documentation

itk::ChainCodePath2D::ChainCodePath2D ( )

protected

itk::ChainCodePath2D::~ChainCodePath2D ( )

overrideprotected

Member Function Documentation

void itk::ChainCodePath2D::ChangeStep ( InputType  position, int  encodedStep  )

inline

Change the direction of a step in the chaincode

Definition at line 121 of file itkChainCodePath2D.h.

void itk::ChainCodePath2D::ChangeStep ( InputType  position, OffsetType  step  )

inlineoverride

Definition at line 128 of file itkChainCodePath2D.h.

void itk::ChainCodePath2D::Clear ( )

inlineoverridevirtual

Remove all steps from the chain code

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 135 of file itkChainCodePath2D.h.

virtual::itk::LightObject::Pointer itk::ChainCodePath2D::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::Object.

OffsetType itk::ChainCodePath2D::DecodeOffset ( int  encodedStep ) const

inlineprotected

Definition at line 155 of file itkChainCodePath2D.h.

int itk::ChainCodePath2D::EncodeOffset ( OffsetType  step ) const

inlineprotected

Encode and Decode between an offset and a Freeman code

Definition at line 150 of file itkChainCodePath2D.h.

OutputType itk::ChainCodePath2D::Evaluate ( const InputType &  input ) const

override

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

IndexType itk::ChainCodePath2D::EvaluateToIndex ( const InputType &  input ) const

override

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

std::string itk::ChainCodePath2D::GetChainCodeAsString

(

)

const

virtual const char* itk::ChainCodePath2D::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ChainCodePath< 2 >.

OffsetType itk::ChainCodePath2D::IncrementInput ( InputType &  input ) const

override

Increment the input variable passed by reference and return the offset stored at the previous 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.

void itk::ChainCodePath2D::InsertStep ( InputType  position, int  encodedStep  )

inline

Insert a new step into the chaincode at a specified position

Definition at line 107 of file itkChainCodePath2D.h.

void itk::ChainCodePath2D::InsertStep ( InputType  position, OffsetType  step  )

inlineoverride

Definition at line 114 of file itkChainCodePath2D.h.

static Pointer itk::ChainCodePath2D::New ( )

static

New() method for dynamic construction

ChainCodeSizeType itk::ChainCodePath2D::NumberOfSteps ( ) const

inlineoverridevirtual

How many steps in the chaincode?

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 104 of file itkChainCodePath2D.h.

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

Member Data Documentation

constexpr unsigned int itk::ChainCodePath2D::Dimension = 2

static

Dimension underlying input image.

Definition at line 57 of file itkChainCodePath2D.h.

ChainCode2DType itk::ChainCodePath2D::m_Chain2D

private

Definition at line 161 of file itkChainCodePath2D.h.

int itk::ChainCodePath2D::m_FreemanCode[3][3]

private

Definition at line 170 of file itkChainCodePath2D.h.

OffsetType itk::ChainCodePath2D::m_ReverseFreemanCode[9]

private

Definition at line 174 of file itkChainCodePath2D.h.

---

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

• itkChainCodePath2D.h