ITK: itk::ChainCodePath2D Class Reference

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ChainCodePath< VDimension >::ChangeStep	(	InputType	position,
		OffsetType	step
	)			`[inline, virtual, inherited]`

Change the direction of a step in the chaincode

Definition at line 118 of file itkChainCodePath.h.

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

Definition at line 126 of file itkChainCodePath2D.h.

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.

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

Remove all steps from the chain code

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 134 of file itkChainCodePath2D.h.

virtual void itk::DataObject::CopyInformation ( const DataObject * ) [inline, virtual, inherited]

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 439 of file itkDataObject.h.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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

void itk::DataObject::DataHasBeenGenerated ( ) [inherited]

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

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

Definition at line 153 of file itkChainCodePath2D.h.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

void itk::DataObject::DisconnectPipeline ( ) [inherited]

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

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

Encode and Decode between an offset and a Freeman code

Definition at line 149 of file itkChainCodePath2D.h.

virtual InputType itk::ChainCodePath< VDimension >::EndOfInput ( ) const [inline, virtual, inherited]

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

Reimplemented from itk::Path< TInput, TOutput, VDimension >.

Definition at line 96 of file itkChainCodePath.h.

template<class TInput, class TOutput, unsigned int VDimension>

virtual OutputType itk::Path< TInput, TOutput, VDimension >::Evaluate ( const InputType & input ) const [pure virtual, inherited]

Evaluate the path at specified location along the path. Return data is the path's "natural" format.

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

template<class TInput, class TOutput, unsigned int VDimension>

virtual IndexType itk::Path< TInput, TOutput, VDimension >::EvaluateToIndex ( const InputType & input ) const [pure virtual, inherited]

Like Evaluate(), except always returns an index

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

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::DataObject::GetDataReleased ( ) const [inline, inherited]

Get the flag indicating the data has been released.

Definition at line 334 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool itk::DataObject::GetGlobalReleaseDataFlag ( ) [static, inherited]

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

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

Run-time type information (and related methods).

Reimplemented from itk::ChainCodePath< 2 >.

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( ) [virtual, inherited]

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( ) [virtual, inherited]

SmartPointerForwardReference<ProcessObject> itk::DataObject::GetSource ( ) const [inherited]

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const [inherited]

Which of the source's outputs corresponds to this data object?

virtual const IndexType& itk::ChainCodePath< VDimension >::GetStart ( ) [virtual, inherited]

virtual unsigned long itk::DataObject::GetUpdateMTime ( ) const [virtual, inherited]

MTime for the last time this DataObject was generated.

template<class TInput, class TOutput, unsigned int VDimension>

virtual IndexType itk::Path< TInput, TOutput, VDimension >::GetZeroIndex ( ) const [protected, virtual, inherited]

template<class TInput, class TOutput, unsigned int VDimension>

virtual OffsetType itk::Path< TInput, TOutput, VDimension >::GetZeroOffset ( ) const [protected, virtual, inherited]

void itk::DataObject::GlobalReleaseDataFlagOff ( ) [inline, inherited]

Definition at line 319 of file itkDataObject.h.

void itk::DataObject::GlobalReleaseDataFlagOn ( ) [inline, inherited]

Definition at line 317 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::DataObject::Graft ( const DataObject * ) [inline, virtual, inherited]

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.

Definition at line 453 of file itkDataObject.h.

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<class TInput, class TOutput, unsigned int VDimension>

virtual OffsetType itk::Path< TInput, TOutput, VDimension >::IncrementInput ( InputType & input ) const [pure virtual, inherited]

Increment the input variable passed by reference such that the ND index of the path moves to its next vertex-connected (8-connected in 2D) neighbor. Return the Index-space offset of the path from its prior input to its new input. If the path is unable to increment, input is not changed and an offset of Zero is returned. Children are not required to implement general bounds checking, but are required to return an offset of zero when trying to increment from the final valid input value.

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

virtual void itk::ChainCodePath< VDimension >::Initialize ( void ) [inline, virtual, inherited]

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 140 of file itkChainCodePath.h.

virtual void itk::ChainCodePath< VDimension >::InsertStep	(	InputType	position,
		OffsetType	step
	)			`[inline, virtual, inherited]`

Insert a new step into the chaincode at a specified position

Definition at line 110 of file itkChainCodePath.h.

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

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

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<class TInput, class TOutput, unsigned int VDimension>

itk::Path< TInput, TOutput, VDimension >::itkStaticConstMacro	(	PathDimension	,
		unsigned	int,
		VDimension
	)			`[inherited]`

Path dimension. The dimension of a path is fixed at construction.

itk::ChainCodePath< VDimension >::itkStaticConstMacro	(	Dimension	,
		unsigned	int,
		VDimension
	)			`[inherited]`

Dimension underlying input image.

itk::ChainCodePath2D::itkStaticConstMacro	(	Dimension	,
		unsigned	int,
		2
	)

Dimension underlying input image.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.


void	GlobalReleaseDataFlagOff ()
void	GlobalReleaseDataFlagOn ()
static bool	GetGlobalReleaseDataFlag ()
static void	SetGlobalReleaseDataFlag (const bool val)
Public Types
typedef std::vector< int >	ChainCode2DType
typedef std::vector< OffsetType >	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
virtual void	ChangeStep (InputType position, OffsetType step)
virtual void	CopyInformation (const DataObject *)
virtual LightObject::Pointer	CreateAnother () const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
virtual InputType	EndOfInput () const
virtual OutputType	Evaluate (const InputType &input) const=0
virtual OutputType	Evaluate (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const=0
virtual IndexType	EvaluateToIndex (const InputType &input) const
std::string	GetChainCodeAsString (void) const
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
SmartPointerForwardReference< ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual const IndexType &	GetStart ()
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
bool	HasObserver (const EventObject &event) const
virtual OffsetType	IncrementInput (InputType &input) const=0
virtual OffsetType	IncrementInput (InputType &input) const
virtual void	Initialize (void)
virtual void	InsertStep (InputType position, OffsetType step)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (PathDimension, unsigned int, VDimension)
	itkStaticConstMacro (Dimension, unsigned int, VDimension)
	itkStaticConstMacro (Dimension, unsigned int, 2)
virtual void	Modified () const
unsigned int	NumberOfSteps () const
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	ReleaseData ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	SetRequestedRegion (DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual void	SetStart (IndexType _arg)
bool	ShouldIReleaseData () const
virtual InputType	StartOfInput () const
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

void	ChangeStep (InputType position, OffsetType step)
void	ChangeStep (InputType position, int encodedStep)

virtual void	Clear ()

virtual const unsigned long &	GetPipelineMTime ()
void	SetPipelineMTime (unsigned long time)

virtual const bool &	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
void	SetReleaseDataFlag (bool flag)

void	InsertStep (InputType position, OffsetType step)
void	InsertStep (InputType position, int encodedStep)

virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	UpdateOutputData ()
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
	ChainCodePath2D ()
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
	~ChainCodePath2D ()

OffsetType	DecodeOffset (int encodedStep) const
int	EncodeOffset (OffsetType step) const

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

itk::ChainCodePath2D Class Reference
[Path Representation Objects]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

itk::ChainCodePath2D Class Reference [Path Representation Objects]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

itk::ChainCodePath2D Class Reference
[Path Representation Objects]