Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::OrthogonallyCorrected2DParametricPath Class Reference
[Path Representation Objects]

#include <itkOrthogonallyCorrected2DParametricPath.h>

Inheritance diagram for itk::OrthogonallyCorrected2DParametricPath:

Inheritance graph
[legend]
Collaboration diagram for itk::OrthogonallyCorrected2DParametricPath:

Collaboration graph
[legend]
List of all members.

Detailed Description

Represent an orthogonally corrected 2D parametric path.

Description

See also:
EllipseParametricPath

PolyLineParametricPath

ParametricPath

Path

ContinuousIndex

Index

Offset

Vector

Definition at line 47 of file itkOrthogonallyCorrected2DParametricPath.h.

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 VectorContainer< unsigned,
double > 
OrthogonalCorrectionTableType
typedef Superclass::OutputType OutputType
typedef SmartPointer< SelfPointer
typedef OrthogonallyCorrected2DParametricPath Self
typedef ParametricPath< 2 > Superclass
typedef Superclass::VectorType VectorType

Public Member Functions

virtual InputType EndOfInput () const
virtual OutputType Evaluate (const InputType &input) const
virtual VectorType EvaluateDerivative (const InputType &input) const
virtual IndexType EvaluateToIndex (const InputType &input) const
virtual const InputTypeGetDefaultInputStepSize ()
virtual const char * GetNameOfClass () const
virtual OffsetType IncrementInput (InputType &input) const
virtual void Initialize (void)
 itkStaticConstMacro (PathDimension, unsigned int, VDimension)
virtual void SetDefaultInputStepSize (InputType _arg)
void SetOriginalPath (const OriginalPathType *originalPath)
virtual void SetOrthogonalCorrectionTable (OrthogonalCorrectionTableType *_arg)
These are determined by the
original path *virtual InputType 
StartOfInput () const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual IndexType GetZeroIndex () const
virtual OffsetType GetZeroOffset () const
 OrthogonallyCorrected2DParametricPath ()
 ParametricPath ()
 Path ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~OrthogonallyCorrected2DParametricPath ()

Protected Attributes

InputType m_DefaultInputStepSize


Member Typedef Documentation

typedef SmartPointer<const Self> itk::OrthogonallyCorrected2DParametricPath::ConstPointer
 

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 55 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef ContinuousIndex<double,2> itk::OrthogonallyCorrected2DParametricPath::ContinuousIndexType
 

Basic data-structure types used

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 68 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef Index<2> itk::OrthogonallyCorrected2DParametricPath::IndexType
 

All paths must be mapable to index space

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 69 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef Superclass::InputType itk::OrthogonallyCorrected2DParametricPath::InputType
 

Input type

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 58 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef Offset<2> itk::OrthogonallyCorrected2DParametricPath::OffsetType
 

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 70 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef OriginalPathType::ConstPointer itk::OrthogonallyCorrected2DParametricPath::OriginalPathConstPointer
 

Definition at line 73 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef ParametricPath<2> itk::OrthogonallyCorrected2DParametricPath::OriginalPathType
 

Definition at line 72 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef OrthogonalCorrectionTableType::Pointer itk::OrthogonallyCorrected2DParametricPath::OrthogonalCorrectionTablePointer
 

Definition at line 75 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef VectorContainer<unsigned, double> itk::OrthogonallyCorrected2DParametricPath::OrthogonalCorrectionTableType
 

Definition at line 74 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef Superclass::OutputType itk::OrthogonallyCorrected2DParametricPath::OutputType
 

Output type

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 64 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef SmartPointer<Self> itk::OrthogonallyCorrected2DParametricPath::Pointer
 

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 54 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef OrthogonallyCorrected2DParametricPath itk::OrthogonallyCorrected2DParametricPath::Self
 

Standard class typedefs.

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 52 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef ParametricPath<2> itk::OrthogonallyCorrected2DParametricPath::Superclass
 

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 53 of file itkOrthogonallyCorrected2DParametricPath.h.

typedef Superclass::VectorType itk::OrthogonallyCorrected2DParametricPath::VectorType
 

Reimplemented from itk::ParametricPath< 2 >.

Definition at line 71 of file itkOrthogonallyCorrected2DParametricPath.h.


Constructor & Destructor Documentation

itk::OrthogonallyCorrected2DParametricPath::OrthogonallyCorrected2DParametricPath  )  [protected]
 

itk::OrthogonallyCorrected2DParametricPath::~OrthogonallyCorrected2DParametricPath  )  [inline, protected]
 

Definition at line 116 of file itkOrthogonallyCorrected2DParametricPath.h.


Member Function Documentation

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< double, ContinuousIndex< double, VDimension >, VDimension >.

Definition at line 107 of file itkOrthogonallyCorrected2DParametricPath.h.

virtual OutputType itk::OrthogonallyCorrected2DParametricPath::Evaluate const InputType input  )  const [virtual]
 

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

Implements itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

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.

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

Implements itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

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

virtual const char* itk::OrthogonallyCorrected2DParametricPath::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ParametricPath< 2 >.

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]
 

virtual OffsetType itk::ParametricPath< VDimension >::IncrementInput InputType input  )  const [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 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.

Implements itk::Path< double, ContinuousIndex< double, VDimension >, VDimension >.

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

Needed for Pipelining

Definition at line 96 of file itkOrthogonallyCorrected2DParametricPath.h.

References NULL.

itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::itkStaticConstMacro PathDimension  ,
unsigned  int,
VDimension 
[inherited]
 

Path dimension. The dimension of a path is fixed at construction.

static Pointer itk::OrthogonallyCorrected2DParametricPath::New  )  [static]
 

New() method for dynamic construction

itk::ParametricPath< VDimension >::ParametricPath  )  [protected, inherited]
 

itk::Path< double , ContinuousIndex< double, VDimension > , VDimension >::Path  )  [protected, inherited]
 

void itk::OrthogonallyCorrected2DParametricPath::PrintSelf std::ostream &  os,
Indent  indent
const [protected]
 

Reimplemented from itk::ParametricPath< 2 >.

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

void itk::OrthogonallyCorrected2DParametricPath::SetOriginalPath const OriginalPathType originalPath  ) 
 

Set pointer to the original path. The path MUST be continuous in its first derivative to prevent discontinuities in the corrected path. The path should also be closed, since the first correction is applied to both the beginnning and the end of the original path.

virtual void itk::OrthogonallyCorrected2DParametricPath::SetOrthogonalCorrectionTable OrthogonalCorrectionTableType _arg  )  [virtual]
 

Set table of evenly-spaced orthogonal offsets for the original path.

These are determined by the original path* virtual InputType itk::OrthogonallyCorrected2DParametricPath::StartOfInput  )  const [inline, virtual]
 

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

Definition at line 103 of file itkOrthogonallyCorrected2DParametricPath.h.


Member Data Documentation

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

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.


The documentation for this class was generated from the following file:
Generated at Sun Jul 9 21:03:43 2006 for ITK by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2000