ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Protected 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 >:

Public Types

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

Public Member Functions

virtual VectorType EvaluateDerivative (const InputType &input) const
 
IndexType EvaluateToIndex (const InputType &input) const override
 
virtual const InputTypeGetDefaultInputStepSize () const
 
virtual const char * GetNameOfClass () const
 
OffsetType IncrementInput (InputType &input) const override
 
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
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual void Initialize ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual void PrepareForNewData ()
 
virtual void DataHasBeenGenerated ()
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual bool VerifyRequestedRegion ()
 
virtual void CopyInformation (const DataObject *)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void Graft (const DataObject *)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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 override
 
 ~ParametricPath () override=default
 
- Protected Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual IndexType GetZeroIndex () const
 
virtual OffsetType GetZeroOffset () const
 
 Path ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~Path () override=default
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
 ~DataObject () override
 
virtual void PropagateResetPipeline ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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
std::atomic< int > m_ReferenceCount
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static Pointer New ()
 
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 constexpr unsigned int PathDimension
 

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.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 75 of file itkParametricPath.h.

◆ ContinuousIndexType

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

All paths must be mapable to index space

Definition at line 71 of file itkParametricPath.h.

◆ IndexType

template<unsigned int VDimension>
using itk::ParametricPath< VDimension >::IndexType = Index<VDimension>

Definition at line 86 of file itkParametricPath.h.

◆ InputType

template<unsigned int VDimension>
using itk::ParametricPath< VDimension >::InputType = typename Superclass::InputType

Input type

Definition at line 81 of file itkParametricPath.h.

◆ OffsetType

template<unsigned int VDimension>
using itk::ParametricPath< VDimension >::OffsetType = Offset<VDimension>

Definition at line 87 of file itkParametricPath.h.

◆ OutputType

template<unsigned int VDimension>
using itk::ParametricPath< VDimension >::OutputType = typename Superclass::OutputType

Output type

Definition at line 84 of file itkParametricPath.h.

◆ Pointer

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

Definition at line 74 of file itkParametricPath.h.

◆ Self

template<unsigned int VDimension>
using itk::ParametricPath< VDimension >::Self = ParametricPath

Standard class type aliases.

Definition at line 68 of file itkParametricPath.h.

◆ Superclass

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

Definition at line 72 of file itkParametricPath.h.

◆ VectorType

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

Definition at line 88 of file itkParametricPath.h.

Constructor & Destructor Documentation

◆ ParametricPath()

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

◆ ~ParametricPath()

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

Member Function Documentation

◆ EvaluateDerivative()

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.

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

◆ EvaluateToIndex()

template<unsigned int VDimension>
IndexType itk::ParametricPath< VDimension >::EvaluateToIndex ( const InputType input) const
override

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

◆ GetDefaultInputStepSize()

template<unsigned int VDimension>
virtual const InputType& itk::ParametricPath< VDimension >::GetDefaultInputStepSize ( ) const
virtual

◆ GetNameOfClass()

template<unsigned int VDimension>
virtual const char* itk::ParametricPath< VDimension >::GetNameOfClass ( ) const
virtual

◆ IncrementInput()

template<unsigned int VDimension>
OffsetType itk::ParametricPath< VDimension >::IncrementInput ( InputType input) const
override

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.

◆ PrintSelf()

template<unsigned int VDimension>
void itk::ParametricPath< VDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Who generated this data?

Reimplemented from itk::DataObject.

Reimplemented in itk::PolyLineParametricPath< VDimension >.

◆ SetDefaultInputStepSize()

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

Member Data Documentation

◆ m_DefaultInputStepSize

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


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