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
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 OutputType	Evaluate (const InputType &input) const
virtual IndexType	EvaluateToIndex (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
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
SmartPointerForwardReference < ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
bool	HasObserver (const EventObject &event) const
virtual OffsetType	IncrementInput (InputType &input) const
virtual OffsetType	IncrementInput (InputType &input) const
virtual OffsetType	IncrementInput (InputType &input) const =0
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
ChainCodeSizeType	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 ()
bool	ShouldIReleaseData () const
virtual InputType	StartOfInput () const
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()


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


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


virtual void	Clear ()


virtual void	SetStart (IndexType _arg)
virtual const IndexType &	GetStart ()


virtual void	InsertStep (InputType position, OffsetType step)


virtual void	ChangeStep (InputType position, OffsetType step)


virtual void	Initialize (void)


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


virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	UpdateOutputData ()


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


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalReleaseDataFlag (bool val)
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalReleaseDataFlagOff ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	Dimension = 2
static const unsigned int	PathDimension
Protected Types


typedef int	InternalReferenceCountType
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 ()


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


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

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

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

Reimplemented from itk::ChainCodePath< 2 >.

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

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

Reimplemented from itk::ChainCodePath< 2 >.

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

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

Input type

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 72 of file itkChainCodePath2D.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef OutputType itk::ChainCodePath2D::OffsetType

The output type of this function is an Index

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 75 of file itkChainCodePath2D.h.

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

OutputType typedef support.

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 68 of file itkChainCodePath2D.h.

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

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 64 of file itkChainCodePath2D.h.

typedef ChainCodePath2D itk::ChainCodePath2D::Self

Standard class typedefs.

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 61 of file itkChainCodePath2D.h.

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

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 62 of file itkChainCodePath2D.h.

Constructor & Destructor Documentation

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

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

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

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.

void itk::ChainCodePath2D::ChangeStep	(	InputType	position,
		int	encodedStep
	)			`[inline]`

Change the direction of a step in the chaincode

Definition at line 122 of file itkChainCodePath2D.h.

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

Change the direction of a step in the chaincode

Definition at line 127 of file itkChainCodePath2D.h.

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 120 of file itkChainCodePath.h.

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

Remove all steps from the chain code

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 135 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]

Encode and Decode between an offset and a Freeman code

Definition at line 154 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 150 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< unsigned int, Offset< VDimension >, VDimension >.

Definition at line 98 of file itkChainCodePath.h.

virtual OutputType itk::ChainCodePath< VDimension >::Evaluate ( const InputType & input ) const [inline, virtual, inherited]

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

Definition at line 83 of file itkChainCodePath.h.

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

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

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

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

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]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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

Returns:: A constant reference to this objects MetaDataDictionary.

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]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

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

Turn on/off a flag to control whether this object's data is released after being used by a filter.

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]

Set/Get the index associated with the initial position of the path

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

MTime for the last time this DataObject was generated.

virtual IndexType itk::Path< unsigned int , Offset< VDimension > , VDimension >::GetZeroIndex ( ) const [protected, virtual, inherited]

virtual OffsetType itk::Path< unsigned int , Offset< VDimension > , VDimension >::GetZeroOffset ( ) const [protected, virtual, inherited]

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

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 319 of file itkDataObject.h.

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

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 317 of file itkDataObject.h.

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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.

virtual OffsetType itk::ChainCodePath< VDimension >::IncrementInput ( InputType & input ) const [virtual, inherited]

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

virtual OffsetType itk::Path< unsigned int , Offset< VDimension > , 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 void itk::ChainCodePath< VDimension >::Initialize ( void ) [inline, virtual, inherited]

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 142 of file itkChainCodePath.h.

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

Insert a new step into the chaincode at a specified position

Definition at line 114 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 109 of file itkChainCodePath2D.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 112 of file itkChainCodePath.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.

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.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

virtual void itk::DataObject::PrepareForNewData ( ) [inline, virtual, inherited]

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 389 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

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

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

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::DataObject::PropagateRequestedRegion ( ) throw (InvalidRequestedRegionError) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Propagate a call to ResetPipeline(). Called only from ProcessObject.

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

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

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

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

virtual void itk::DataObject::ReleaseDataFlagOff ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

virtual void itk::DataObject::ReleaseDataFlagOn ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual bool itk::DataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [inline, virtual, inherited]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented in itk::ImageBase< VImageDimension >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::SpatialObject< TDimension >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::PointSet< TPixel, VDimension, TTraits >, itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Definition at line 413 of file itkDataObject.h.

virtual void itk::DataObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::DataObject::SetGlobalReleaseDataFlag ( bool val ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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

Returns:: Set the MetaDataDictionary

void itk::DataObject::SetPipelineMTime ( unsigned long time ) [inline, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 373 of file itkDataObject.h.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

void itk::DataObject::SetReleaseDataFlag ( bool flag ) [inline, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

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

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 446 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegionToLargestPossibleRegion ( ) [inline, virtual, inherited]

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Definition at line 402 of file itkDataObject.h.

virtual void itk::ChainCodePath< VDimension >::SetStart ( IndexType _arg ) [virtual, inherited]

Set/Get the index associated with the initial position of the path

bool itk::DataObject::ShouldIReleaseData ( ) const [inherited]

Return flag indicating whether data should be released after use by a filter.

virtual InputType itk::Path< unsigned int , Offset< VDimension > , VDimension >::StartOfInput ( ) const [inline, virtual, inherited]

Where does the path begin? For most types of paths, the path will begin at zero. This value can be overridden in children, and is necessary for iterators to know how to go to the beginning of a path.

Definition at line 79 of file itkPath.h.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::DataObject::Update ( ) [virtual, inherited]

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

virtual void itk::DataObject::UpdateOutputData ( ) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::UpdateOutputInformation ( ) [virtual, inherited]

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

virtual bool itk::DataObject::VerifyRequestedRegion ( ) [inline, virtual, inherited]

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Definition at line 428 of file itkDataObject.h.

Member Data Documentation

const unsigned int itk::ChainCodePath2D::Dimension = 2 [static]

Dimension underlying input image.

Reimplemented from itk::ChainCodePath< 2 >.

Definition at line 58 of file itkChainCodePath2D.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

const unsigned int itk::Path< unsigned int , Offset< VDimension > , VDimension >::PathDimension [static, inherited]

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

Definition at line 59 of file itkPath.h.

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

itkChainCodePath2D.h

itk::ChainCodePath2D Class Reference [Path Representation Objects]

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ChainCodePath2D Class Reference
[Path Representation Objects]