 |
ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkParametricPath.h>
Inheritance diagram for itk::ParametricPath< VDimension >: Collaboration diagram for itk::ParametricPath< VDimension >: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 VectorType | EvaluateDerivative (const InputType &input) const |
| virtual IndexType | EvaluateToIndex (const InputType &input) const |
| virtual const InputType & | GetDefaultInputStepSize () |
| virtual const char * | GetNameOfClass () const |
| virtual OffsetType | IncrementInput (InputType &input) const |
| virtual void | SetDefaultInputStepSize (InputType _arg) |
Protected Member Functions | |
| ParametricPath () | |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| ~ParametricPath () | |
| InputType | m_DefaultInputStepSize |
| ParametricPath (const Self &) | |
| void | operator= (const Self &) |
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.
Definition at line 60 of file itkParametricPath.h.
| typedef SmartPointer< const Self > itk::ParametricPath< VDimension >::ConstPointer |
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 68 of file itkParametricPath.h.
| typedef ContinuousIndex< double, VDimension > itk::ParametricPath< VDimension >::ContinuousIndexType |
All paths must be mapable to index space
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 80 of file itkParametricPath.h.
| 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::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 81 of file itkParametricPath.h.
| typedef Superclass::InputType itk::ParametricPath< VDimension >::InputType |
Input type
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 71 of file itkParametricPath.h.
| typedef Offset< VDimension > itk::ParametricPath< VDimension >::OffsetType |
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 82 of file itkParametricPath.h.
| typedef Superclass::OutputType itk::ParametricPath< VDimension >::OutputType |
Output type
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 77 of file itkParametricPath.h.
| typedef SmartPointer< Self > itk::ParametricPath< VDimension >::Pointer |
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 67 of file itkParametricPath.h.
| typedef ParametricPath itk::ParametricPath< VDimension >::Self |
Standard class typedefs.
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 65 of file itkParametricPath.h.
| 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::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 66 of file itkParametricPath.h.
| typedef Vector< double, VDimension > itk::ParametricPath< VDimension >::VectorType |
Reimplemented in itk::FourierSeriesPath< VDimension >, itk::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
Definition at line 83 of file itkParametricPath.h.
| itk::ParametricPath< VDimension >::ParametricPath | ( | ) | [protected] |
| itk::ParametricPath< VDimension >::~ParametricPath | ( | ) | [inline, protected] |
Definition at line 118 of file itkParametricPath.h.
| itk::ParametricPath< VDimension >::ParametricPath | ( | const Self & | ) | [private] |
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.
| 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::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().
| virtual const InputType& itk::ParametricPath< VDimension >::GetDefaultInputStepSize | ( | ) | [virtual] |
| 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::PolyLineParametricPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
| 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.
| void itk::ParametricPath< VDimension >::operator= | ( | const Self & | ) | [private] |
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.
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::PolyLineParametricPath< VDimension >, itk::FourierSeriesPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
| void itk::ParametricPath< VDimension >::PrintSelf | ( | std::ostream & | os, |
| Indent | indent | ||
| ) | const [protected, virtual] |
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.
Reimplemented from itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.
Reimplemented in itk::PolyLineParametricPath< VDimension >, itk::FourierSeriesPath< VDimension >, and itk::OrthogonallyCorrected2DParametricPath.
| virtual void itk::ParametricPath< VDimension >::SetDefaultInputStepSize | ( | InputType | _arg | ) | [virtual] |
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 131 of file itkParametricPath.h.
1.7.6.1
