ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::ParametricPath< VDimension > Class Template Reference

#include <itkParametricPath.h>

+ Inheritance diagram for itk::ParametricPath< VDimension >:
+ Collaboration diagram for itk::ParametricPath< VDimension >:

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
ChainCodePath
Path
ContinuousIndex
Index
Offset
Vector

Definition at line 61 of file itkParametricPath.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< SpacePrecisionType,
VDimension > 
ContinuousIndexType
 
typedef Index< VDimension > IndexType
 
typedef Superclass::InputType InputType
 
typedef Offset< VDimension > OffsetType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef ParametricPath Self
 
typedef Path< double,
ContinuousIndexType,
VDimension > 
Superclass
 
typedef Vector< double,
VDimension > 
VectorType
 
- Public Types inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef Index< VDimension > IndexType
 
typedef double InputType
 
typedef Offset< VDimension > OffsetType
 
typedef ContinuousIndex
< SpacePrecisionType,
VDimension > 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Path Self
 
typedef DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual VectorType EvaluateDerivative (const InputType &input) const
 
virtual IndexType EvaluateToIndex (const InputType &input) const
 
virtual const InputTypeGetDefaultInputStepSize () const
 
virtual const char * GetNameOfClass () const
 
virtual OffsetType IncrementInput (InputType &input) const
 
virtual void SetDefaultInputStepSize (InputType _arg)
 
- Public Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual InputType EndOfInput () const
 
virtual OutputType Evaluate (const InputType &input) const =0
 
virtual IndexType EvaluateToIndex (const InputType &input) const =0
 
virtual OffsetType IncrementInput (InputType &input) const =0
 
virtual InputType StartOfInput () const
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const ITK_OVERRIDE
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 ParametricPath ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 ~ParametricPath ()
 
- Protected Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual IndexType GetZeroIndex () const
 
virtual OffsetType GetZeroOffset () const
 
 Path ()
 
 ~Path ()
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

InputType m_DefaultInputStepSize
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

void operator= (const Self &)
 
 ParametricPath (const Self &)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Static Public Attributes inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
static const unsigned int PathDimension
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

template<unsigned int VDimension>
typedef SmartPointer< const Self > itk::ParametricPath< VDimension >::ConstPointer

Definition at line 73 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef ContinuousIndex< SpacePrecisionType,VDimension > itk::ParametricPath< VDimension >::ContinuousIndexType

All paths must be mapable to index space

Definition at line 69 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef Index< VDimension > itk::ParametricPath< VDimension >::IndexType

Definition at line 84 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::InputType itk::ParametricPath< VDimension >::InputType

Input type

Definition at line 76 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef Offset< VDimension > itk::ParametricPath< VDimension >::OffsetType

Definition at line 85 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef Superclass::OutputType itk::ParametricPath< VDimension >::OutputType

Output type

Definition at line 82 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef SmartPointer< Self > itk::ParametricPath< VDimension >::Pointer

Definition at line 72 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef ParametricPath itk::ParametricPath< VDimension >::Self

Standard class typedefs.

Definition at line 66 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef Path< double, ContinuousIndexType, VDimension > itk::ParametricPath< VDimension >::Superclass

Definition at line 70 of file itkParametricPath.h.

template<unsigned int VDimension>
typedef Vector< double, VDimension > itk::ParametricPath< VDimension >::VectorType

Definition at line 86 of file itkParametricPath.h.

Constructor & Destructor Documentation

template<unsigned int VDimension>
itk::ParametricPath< VDimension >::ParametricPath ( )
protected
template<unsigned int VDimension>
itk::ParametricPath< VDimension >::~ParametricPath ( )
inlineprotected

Definition at line 122 of file itkParametricPath.h.

template<unsigned int VDimension>
itk::ParametricPath< VDimension >::ParametricPath ( const Self )
private

Member Function Documentation

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

template<unsigned int VDimension>
virtual const InputType& itk::ParametricPath< VDimension >::GetDefaultInputStepSize ( ) const
virtual
template<unsigned int VDimension>
virtual const char* itk::ParametricPath< VDimension >::GetNameOfClass ( ) const
virtual
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.

template<unsigned int VDimension>
void itk::ParametricPath< VDimension >::operator= ( const Self )
private
template<unsigned int VDimension>
void itk::ParametricPath< VDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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< SpacePrecisionType, VDimension >, VDimension >.

Reimplemented in itk::PolyLineParametricPath< VDimension >.

template<unsigned int VDimension>
virtual void itk::ParametricPath< VDimension >::SetDefaultInputStepSize ( InputType  _arg)
virtual

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 135 of file itkParametricPath.h.


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