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

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.

virtual InputType itk::OrthogonallyCorrected2DParametricPath::EndOfInput ( ) const [inline, virtual]

Where does the path end (what is the last valid input value)? This value is sometimes used by IncrementInput() to go to the end of a path.

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

Definition at line 108 of file itkOrthogonallyCorrected2DParametricPath.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::OrthogonallyCorrected2DParametricPath::Evaluate ( const InputType & input ) const [virtual]

Return the location of the parametric path at the specified location.

virtual VectorType itk::ParametricPath< VDimension >::EvaluateDerivative ( const InputType & input ) const [virtual, inherited]

Evaluate the first derivative of the ND output with respect to the 1D input. This is a very simple and naive numerical derivative, and it sould be overloaded with a proper closed-form derivative function in all children. Nevertheless, users who need to create their own parametric classes for their private research need not reimplement this function if their work does not need the derivative operator.

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::ParametricPath< VDimension >::EvaluateToIndex ( const InputType & input ) const [virtual, inherited]

Return the nearest index to the parametric path at the specified location. This is a wrapper to Evaluate().

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.

virtual const InputType& itk::ParametricPath< VDimension >::GetDefaultInputStepSize ( ) [virtual, inherited]

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::OrthogonallyCorrected2DParametricPath::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ParametricPath< 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 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::ParametricPath< VDimension >::IncrementInput ( InputType & input ) const [virtual, inherited]

This is a fairly slow, iterative algorithm that numerically converges to the next index along the path, in a vertex-connected (8-connected in 2D) fashion. When possible, children of this class should overload this function with something more efficient.

WARNING: This default implementation REQUIRES that the ND endpoint of the path be either unique or coincident only with the startpoint, since it uses the endpoint as a stopping condition.

virtual void itk::OrthogonallyCorrected2DParametricPath::Initialize ( void ) [inline, virtual]

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 97 of file itkOrthogonallyCorrected2DParametricPath.h.

References NULL.

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.

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, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(),


void	GlobalReleaseDataFlagOff ()
void	GlobalReleaseDataFlagOn ()
static bool	GetGlobalReleaseDataFlag ()
static void	SetGlobalReleaseDataFlag (const bool val)
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex< double, 2 >	ContinuousIndexType
typedef Index< 2 >	IndexType
typedef Superclass::InputType	InputType
typedef Offset< 2 >	OffsetType
typedef OriginalPathType::ConstPointer	OriginalPathConstPointer
typedef ParametricPath< 2 >	OriginalPathType
typedef OrthogonalCorrectionTableType::Pointer	OrthogonalCorrectionTablePointer
typedef OrthogonalCorrectionTableType::VectorContainerSizeType	OrthogonalCorrectionTableSizeType
typedef VectorContainer< unsigned, double >	OrthogonalCorrectionTableType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef OrthogonallyCorrected2DParametricPath	Self
typedef ParametricPath< 2 >	Superclass
typedef Superclass::VectorType	VectorType
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 OutputType	Evaluate (const InputType &input) const=0
virtual OutputType	Evaluate (const InputType &input) const
virtual VectorType	EvaluateDerivative (const InputType &input) const
virtual IndexType	EvaluateToIndex (const InputType &input) const=0
virtual IndexType	EvaluateToIndex (const InputType &input) const
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
virtual const InputType &	GetDefaultInputStepSize ()
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 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)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (PathDimension, unsigned int, VDimension)
virtual void	Modified () 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
virtual void	SetDefaultInputStepSize (InputType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetOriginalPath (const OriginalPathType *originalPath)
virtual void	SetOrthogonalCorrectionTable (OrthogonalCorrectionTableType *_arg)
virtual void	SetReferenceCount (int)
virtual void	SetRequestedRegion (DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () 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 *)

virtual InputType	EndOfInput () const
virtual InputType	StartOfInput () const

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

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

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
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
	OrthogonallyCorrected2DParametricPath ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
	~OrthogonallyCorrected2DParametricPath ()

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

itk::OrthogonallyCorrected2DParametricPath 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::OrthogonallyCorrected2DParametricPath Class Reference
[Path Representation Objects]