#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 51 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 Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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 void	SetStart (IndexType _arg)

virtual const IndexType &	GetStart () const

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

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

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

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

virtual void	PropagateResetPipeline ()

	~DataObject ()

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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 Member Functions
	ChainCodePath2D (const Self &)

void	operator= (const Self &)

Private Attributes
ChainCode2DType	m_Chain2D

int	m_FreemanCode [3][3]

OffsetType	m_ReverseFreemanCode [9]

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

Member Typedef Documentation

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

ChainCodePath2D stores its data as a Freeman-encoded chain code

Definition at line 81 of file itkChainCodePath2D.h.

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

Definition at line 78 of file itkChainCodePath2D.h.

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

ChainCodeType is a usless relic of the parent class

Definition at line 77 of file itkChainCodePath2D.h.

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

Definition at line 63 of file itkChainCodePath2D.h.

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

Definition at line 74 of file itkChainCodePath2D.h.

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

Definition at line 70 of file itkChainCodePath2D.h.

typedef OutputType itk::ChainCodePath2D::OffsetType

The output type of this function is an Index

Definition at line 73 of file itkChainCodePath2D.h.

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

OutputType typedef support.

Definition at line 66 of file itkChainCodePath2D.h.

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

Definition at line 62 of file itkChainCodePath2D.h.

typedef ChainCodePath2D itk::ChainCodePath2D::Self

Standard class typedefs.

Definition at line 59 of file itkChainCodePath2D.h.

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

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

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

inlineoverridevirtual

Change the direction of a step in the chaincode

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 127 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 134 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 154 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 149 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.

Reimplemented from itk::ChainCodePath< 2 >.

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

overridevirtual

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

Reimplemented from itk::ChainCodePath< 2 >.

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.

Reimplemented from itk::ChainCodePath< 2 >.

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

inline

Insert a new step into the chaincode at a specified position

Definition at line 106 of file itkChainCodePath2D.h.

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

inlineoverridevirtual

Insert a new step into the chaincode at a specified position

Reimplemented from itk::ChainCodePath< 2 >.

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

void itk::ChainCodePath2D::operator= ( const Self & )

private

virtual 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::Path< unsigned int, Offset< VDimension >, VDimension >.

Member Data Documentation

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

static

Dimension underlying input image.

Definition at line 56 of file itkChainCodePath2D.h.

ChainCode2DType itk::ChainCodePath2D::m_Chain2D

private

Definition at line 163 of file itkChainCodePath2D.h.

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

private

Definition at line 172 of file itkChainCodePath2D.h.

OffsetType itk::ChainCodePath2D::m_ReverseFreemanCode[9]

private

Definition at line 176 of file itkChainCodePath2D.h.

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

itkChainCodePath2D.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation