itk::ParametricPath< VDimension > Class Template Reference
[Path Representation Objects]

Represent a parametric path through ND Space. More...

#include <itkParametricPath.h>

Inheritance diagram for itk::ParametricPath< VDimension >:

Collaboration diagram for itk::ParametricPath< VDimension >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer

typedef ContinuousIndex
< double, VDimension > ContinuousIndexType

typedef Index< VDimension > IndexType

typedef Superclass::InputType InputType

typedef Offset< VDimension > OffsetType

typedef Superclass::OutputType OutputType

typedef SmartPointer< Self > Pointer

typedef ParametricPath Self

typedef Path< double,
ContinuousIndex< double,
VDimension >, VDimension > Superclass

typedef Vector< double,
VDimension > 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 InputType EndOfInput () const

virtual OutputType Evaluate (const InputType &input) const =0

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

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

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

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

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

static void GlobalReleaseDataFlagOff ()

static void GlobalReleaseDataFlagOn ()

static void SetGlobalReleaseDataFlag (bool val)

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

virtual IndexType GetZeroIndex () const

virtual OffsetType GetZeroOffset () const

ParametricPath ()

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

void PrintSelf (std::ostream &os, Indent indent) const

virtual void PropagateResetPipeline ()

~ParametricPath ()

virtual void PrintHeader (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

InputType m_DefaultInputStepSize

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

Detailed Description

template<unsigned int VDimension>
class itk::ParametricPath< VDimension >

Represent a parametric path through ND Space.

This virtual class is intended to represent a parametric path through an image. A parametric path maps a single floating-point 1D parameter (usually designated as either time or arc-length) to a floating-point ND point in continuous image index space. This mapping is done via the abstract Evaluate() method, which must be overridden in all instantiable subclasses. Parametric paths are required to be continuous. They may be open or form a closed loop. A parametric path may cross itself several times, although the end point is constrained to have a unique spatial location unless it is shared with and only with the starting point (a path tracing the number "9," starting at the bottom and ending in the middle of the right side, would therefore be illegal). Classic applications of this class include the representation of contours in 2D images and path smoothing. Another use of a path is to guide the movement of an iterator through an image.

See also:

EllipseParametricPath

PolyLineParametricPath

FourierSeriesPath

OrthogonallyCorrectedParametricPath

Definition at line 61 of file itkParametricPath.h.

Member Typedef Documentation

template<unsigned int VDimension>

typedef SmartPointer<const Self> itk::ParametricPath< VDimension >::ConstPointer

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 69 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef ContinuousIndex<double,VDimension> itk::ParametricPath< VDimension >::ContinuousIndexType

All paths must be mapable to index space

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 82 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef Index< VDimension > itk::ParametricPath< VDimension >::IndexType

All paths must be mapable to index space

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 83 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef Superclass::InputType itk::ParametricPath< VDimension >::InputType

Input type

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 72 of file itkParametricPath.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.

template<unsigned int VDimension>

typedef Offset< VDimension > itk::ParametricPath< VDimension >::OffsetType

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 84 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef Superclass::OutputType itk::ParametricPath< VDimension >::OutputType

Output type

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 78 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef SmartPointer<Self> itk::ParametricPath< VDimension >::Pointer

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 68 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef ParametricPath itk::ParametricPath< VDimension >::Self

Standard class typedefs.

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 66 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef Path<double,ContinuousIndex<double,VDimension>,VDimension> itk::ParametricPath< VDimension >::Superclass

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 67 of file itkParametricPath.h.

template<unsigned int VDimension>

typedef Vector<double,VDimension> itk::ParametricPath< VDimension >::VectorType

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 85 of file itkParametricPath.h.

Constructor & Destructor Documentation

template<unsigned int VDimension>

itk::ParametricPath< VDimension >::ParametricPath ( ) [protected]

template<unsigned int VDimension>

itk::ParametricPath< VDimension >::~ParametricPath ( ) [inline, protected]

Definition at line 123 of file itkParametricPath.h.

Member Function Documentation

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

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

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::Path< double , ContinuousIndex< double, VDimension > , VDimension >::EndOfInput ( ) const [inline, virtual, inherited]

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 in itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

Definition at line 86 of file itkPath.h.

virtual OutputType itk::Path< double , ContinuousIndex< double, 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.

template<unsigned int VDimension>

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

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.

Reimplemented in itk::FourierSeriesPath< VDimension >.

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

Like Evaluate(), except always returns an index

template<unsigned int VDimension>

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

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.

template<unsigned int VDimension>

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

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.

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

template<unsigned int VDimension>

virtual const char* itk::ParametricPath< VDimension >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

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 unsigned long itk::DataObject::GetUpdateMTime ( ) const [virtual, inherited]

MTime for the last time this DataObject was generated.

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

virtual OffsetType itk::Path< double , ContinuousIndex< double, 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::Path< double , ContinuousIndex< double, 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.

template<unsigned int VDimension>

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

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

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::DataObject::Initialize ( ) [virtual, inherited]

Restore the data object to its initial state. This means releasing memory.

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.

itk::Path< double , ContinuousIndex< double, VDimension > , 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, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::Object::New ( ) [static, inherited]

Method for creation through the object factory.

Reimplemented from itk::LightObject.

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]`

template<unsigned int VDimension>

void itk::ParametricPath< VDimension >::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::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

Reimplemented in itk::FourierSeriesPath< VDimension >, itk::OrthogonallyCorrected2DParametricPath, and itk::PolyLineParametricPath< VDimension >.

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< VImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::PointSet< TPixel, VDimension, TTraits >, 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.

template<unsigned int VDimension>

virtual void itk::ParametricPath< VDimension >::SetDefaultInputStepSize ( InputType _arg ) [virtual]

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.

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

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

virtual InputType itk::Path< double , ContinuousIndex< double, 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.

Reimplemented in itk::OrthogonallyCorrected2DParametricPath.

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

template<unsigned int VDimension>

InputType itk::ParametricPath< VDimension >::m_DefaultInputStepSize [protected]

Default 1D input increment amount to trace along the path. Also, the value used by the defualt implementation of EvaluateDerivative() for numerically approximating the derivative with the change over a single default-sized step. (NOTE that the default implementation of EvaluateDerivative() should never be used in practice, but users or lazzy developers may nevertheless unwisely choose to do so anyway.) For integer- input-types, 1 is probably the correct value. For double-input-types, either 1 or 0.1 are probably good values. This value should be set in the constructor of all instantiable children. Values set in child constructors overwrite values set in parent constructors.

Definition at line 136 of file itkParametricPath.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.

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

itkParametricPath.h


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex < double, VDimension >	ContinuousIndexType
typedef Index< VDimension >	IndexType
typedef Superclass::InputType	InputType
typedef Offset< VDimension >	OffsetType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef ParametricPath	Self
typedef Path< double, ContinuousIndex< double, VDimension >, VDimension >	Superclass
typedef Vector< double, VDimension >	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 InputType	EndOfInput () const
virtual OutputType	Evaluate (const InputType &input) const =0
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	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)
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 ()

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

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	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	SetGlobalReleaseDataFlag (bool val)

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
virtual IndexType	GetZeroIndex () const
virtual OffsetType	GetZeroOffset () const
	ParametricPath ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
	~ParametricPath ()

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

itk::ParametricPath< VDimension > Class Template Reference [Path Representation Objects]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<unsigned int VDimension> class itk::ParametricPath< VDimension >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ParametricPath< VDimension > Class Template Reference
[Path Representation Objects]

template<unsigned int VDimension>
class itk::ParametricPath< VDimension >