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

#include <itkChainCodePath2D.h>

Inheritance diagram for itk::ChainCodePath2D:

Collaboration diagram for itk::ChainCodePath2D:

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 Member Functions
void	ChangeStep (InputType position, OffsetType step)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual OutputType	Evaluate (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const
std::string	GetChainCodeAsString (void) const
virtual const char *	GetNameOfClass () const
virtual OffsetType	IncrementInput (InputType &input) const
void	InsertStep (InputType position, OffsetType step)
ChainCodeSizeType	NumberOfSteps () const

void	InsertStep (InputType position, int encodedStep)

void	ChangeStep (InputType position, int encodedStep)

virtual void	Clear ()
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	Dimension = 2
Protected Member Functions
	ChainCodePath2D ()
OffsetType	DecodeOffset (int encodedStep) const
int	EncodeOffset (OffsetType step) const
void	PrintSelf (std::ostream &os, Indent indent) const
	~ChainCodePath2D ()
Private Member Functions
	ChainCodePath2D (const Self &)
void	operator= (const Self &)
Private Attributes
ChainCode2DType	m_Chain2D
int	m_FreemanCode [3][3]
OffsetType	m_ReverseFreemanCode [9]

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 preceeding, 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 interger 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.

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

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 77 of file itkChainCodePath2D.h.

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

ChainCodeType is a usless relic of the parent class

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 76 of file itkChainCodePath2D.h.

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

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 62 of file itkChainCodePath2D.h.

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

All paths must be mapable to index space

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 73 of file itkChainCodePath2D.h.

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

Input type

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 69 of file itkChainCodePath2D.h.

typedef OutputType itk::ChainCodePath2D::OffsetType

The output type of this function is an Index

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 72 of file itkChainCodePath2D.h.

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

OutputType typedef support.

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 65 of file itkChainCodePath2D.h.

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

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 61 of file itkChainCodePath2D.h.

typedef ChainCodePath2D itk::ChainCodePath2D::Self

Standard class typedefs.

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 58 of file itkChainCodePath2D.h.

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

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 59 of file itkChainCodePath2D.h.

Constructor & Destructor Documentation

itk::ChainCodePath2D::ChainCodePath2D ( ) [protected]

itk::ChainCodePath2D::~ChainCodePath2D ( ) [protected]

itk::ChainCodePath2D::ChainCodePath2D ( const Self & ) [private]

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.

void itk::ChainCodePath2D::ChangeStep	(	InputType	position,
		OffsetType	step
	)		`[inline, virtual]`

Change the direction of a step in the chaincode

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 126 of file itkChainCodePath2D.h.

virtual void itk::ChainCodePath2D::Clear ( void ) [inline, virtual]

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 ( void ) 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::ChainCodePath< 2 >.

OffsetType itk::ChainCodePath2D::DecodeOffset ( int encodedStep ) const [inline, protected]

Definition at line 153 of file itkChainCodePath2D.h.

int itk::ChainCodePath2D::EncodeOffset ( OffsetType step ) const [inline, protected]

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 [virtual]

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

Reimplemented from itk::ChainCodePath< 2 >.

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

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

Reimplemented from itk::ChainCodePath< 2 >.

std::string itk::ChainCodePath2D::GetChainCodeAsString ( void ) 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 [virtual]

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.

Reimplemented from itk::ChainCodePath< 2 >.

void itk::ChainCodePath2D::InsertStep	(	InputType	position,
		OffsetType	step
	)		`[inline, virtual]`

Insert a new step into the chaincode at a specified position

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 112 of file itkChainCodePath2D.h.

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.

static Pointer itk::ChainCodePath2D::New ( ) [static]

New() method for dynamic construction

Reimplemented from itk::ChainCodePath< 2 >.

ChainCodeSizeType itk::ChainCodePath2D::NumberOfSteps ( ) const [inline, virtual]

How many steps in the chaincode?

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 102 of file itkChainCodePath2D.h.

void itk::ChainCodePath2D::operator= ( const Self & ) [private]

Reimplemented from itk::ChainCodePath< 2 >.

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

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Reimplemented from itk::ChainCodePath< 2 >.