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
typedef std::vector< int >	ChainCode2DType
typedef Superclass::ChainCodeSizeType	ChainCodeSizeType
typedef Superclass::ChainCodeType	ChainCodeType
typedef SmartPointer< const Self >	ConstPointer
typedef Index< 2 >	IndexType
typedef Superclass::InputType	InputType
typedef OutputType	OffsetType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef ChainCodePath2D	Self
typedef ChainCodePath< 2 >	Superclass
Public Types inherited from itk::ChainCodePath< 2 >
typedef ChainCodeType::size_type	ChainCodeSizeType
typedef std::vector< OffsetType >	ChainCodeType
typedef SmartPointer< const Self >	ConstPointer
typedef Index< VDimension >	IndexType
typedef Superclass::InputType	InputType
typedef OutputType	OffsetType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef ChainCodePath< VDimension >	Self
typedef Path< unsigned int, Offset< VDimension > , VDimension >	Superclass
Public Types inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
typedef SmartPointer< const Self >	ConstPointer
typedef Index< VDimension >	IndexType
typedef unsigned int	InputType
typedef Offset< VDimension >	OffsetType
typedef Offset< VDimension >	OutputType
typedef SmartPointer< Self >	Pointer
typedef Path	Self
typedef DataObject	Superclass

Public Member Functions
virtual void	ChangeStep (InputType position, OffsetType step) override
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual OutputType	Evaluate (const InputType &input) const override
virtual IndexType	EvaluateToIndex (const InputType &input) const override
std::string	GetChainCodeAsString () const
virtual const char *	GetNameOfClass () const
virtual OffsetType	IncrementInput (InputType &input) const override
virtual void	InsertStep (InputType position, OffsetType step) override
virtual ChainCodeSizeType	NumberOfSteps () const override
void	InsertStep (InputType position, int encodedStep)
void	ChangeStep (InputType position, int encodedStep)
virtual void	Clear () override
Public Member Functions inherited from itk::ChainCodePath< 2 >
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual InputType	EndOfInput () const override
virtual OutputType	Evaluate (const InputType &input) const override
virtual IndexType	EvaluateToIndex (const InputType &input) const override
virtual 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)
virtual void	Initialize (void) override
Public Member Functions inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
virtual InputType	StartOfInput () const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ChainCodePath< 2 >
static Pointer	New ()

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

Protected Member Functions
	ChainCodePath2D ()
OffsetType	DecodeOffset (int encodedStep) const
int	EncodeOffset (OffsetType step) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	~ChainCodePath2D ()
Protected Member Functions inherited from itk::ChainCodePath< 2 >
	ChainCodePath ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ChainCodePath ()
Protected Member Functions inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
	Path ()
	~Path ()

Private Attributes
ChainCode2DType	m_Chain2D
int	m_FreemanCode [3][3]
OffsetType	m_ReverseFreemanCode [9]

Member Typedef Documentation

typedef std::vector< int > itk::ChainCodePath2D::ChainCode2DType

ChainCodePath2D stores its data as a Freeman-encoded chain code

Definition at line 80 of file itkChainCodePath2D.h.

typedef Superclass::ChainCodeSizeType itk::ChainCodePath2D::ChainCodeSizeType

Definition at line 77 of file itkChainCodePath2D.h.

typedef Superclass::ChainCodeType itk::ChainCodePath2D::ChainCodeType

ChainCodeType is a usless relic of the parent class

Definition at line 76 of file itkChainCodePath2D.h.

typedef SmartPointer< const Self > itk::ChainCodePath2D::ConstPointer

Definition at line 62 of file itkChainCodePath2D.h.

typedef Index< 2 > itk::ChainCodePath2D::IndexType

Definition at line 73 of file itkChainCodePath2D.h.

typedef Superclass::InputType itk::ChainCodePath2D::InputType

Definition at line 69 of file itkChainCodePath2D.h.

typedef OutputType itk::ChainCodePath2D::OffsetType

The output type of this function is an Index

Definition at line 72 of file itkChainCodePath2D.h.

typedef Superclass::OutputType itk::ChainCodePath2D::OutputType

OutputType typedef support.

Definition at line 65 of file itkChainCodePath2D.h.

typedef SmartPointer< Self > itk::ChainCodePath2D::Pointer

Definition at line 61 of file itkChainCodePath2D.h.

typedef ChainCodePath2D itk::ChainCodePath2D::Self

Standard class typedefs.

Definition at line 58 of file itkChainCodePath2D.h.

typedef ChainCodePath< 2 > itk::ChainCodePath2D::Superclass

Definition at line 59 of file itkChainCodePath2D.h.

Constructor & Destructor Documentation

itk::ChainCodePath2D::ChainCodePath2D ( )

protected

itk::ChainCodePath2D::~ChainCodePath2D ( )

protected

Member Function Documentation

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

inline

Change the direction of a step in the chaincode

Definition at line 119 of file itkChainCodePath2D.h.

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

inlineoverridevirtual

Definition at line 126 of file itkChainCodePath2D.h.

virtual void itk::ChainCodePath2D::Clear ( void  )

inlineoverridevirtual

Remove all steps from the chain code

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 133 of file itkChainCodePath2D.h.

virtual::itk::LightObject::Pointer itk::ChainCodePath2D::CreateAnother

(

)

const

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

inlineprotected

Definition at line 153 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 148 of file itkChainCodePath2D.h.

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

overridevirtual

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

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

overridevirtual

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

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

overridevirtual

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 105 of file itkChainCodePath2D.h.

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

inlineoverridevirtual

Definition at line 112 of file itkChainCodePath2D.h.

static Pointer itk::ChainCodePath2D::New ( )

static

New() method for dynamic construction

virtual ChainCodeSizeType itk::ChainCodePath2D::NumberOfSteps ( ) const

inlineoverridevirtual

How many steps in the chaincode?

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 102 of file itkChainCodePath2D.h.

virtual void itk::ChainCodePath2D::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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

Member Data Documentation

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

static

Dimension underlying input image.

Definition at line 55 of file itkChainCodePath2D.h.

ChainCode2DType itk::ChainCodePath2D::m_Chain2D

private

Definition at line 159 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