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

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

#include <itkFourierSeriesPath.h>

Inheritance diagram for itk::FourierSeriesPath< VDimension >:

Inheritance graph
[legend]
Collaboration diagram for itk::FourierSeriesPath< VDimension >:

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Represent a closed path through ND Space by its frequency components.

This class is intended to represent closed parametric paths through an image which are defined by their Fourier coeficients (frequency components). The paths must be closed and defined over the interval [0,1], where the paths' values at input 0 and input 1 are identical. The user can control how many harmonics (how high of frequency components) are represented by a given instantiation of this class. Classic applications of this class include smoothing other closed paths (by finding and using only the first n harmonics of their frequency components) and interpolating exact derivatives of other closed paths by first converting the other paths to FourierSeriesPaths, which have an exactly defined algebraic derivative. (As many harmonics as are necessary to adequately approximate the original path should be used when approximating derivatives.)

See also:
OrthogonallyCorrectedParametricPath

EllipseParametricPath

PolyLineParametricPath

ParametricPath

ChainCodePath

Path

ContinuousIndex

Index

Offset

Vector

Definition at line 61 of file itkFourierSeriesPath.h.

Public Types

typedef CoefficientsType::Pointer CoefficientsPointer
typedef VectorContainer< unsigned,
VectorType
CoefficientsType
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< SelfPointer
typedef FourierSeriesPath Self
typedef ParametricPath< VDimension > Superclass
typedef Vector< double, VDimension > VectorType

Public Member Functions

void AddHarmonic (const VectorType &CosCoefficients, const VectorType &SinCoefficients)
Clear all frequency coefficients (including the"DC"coefficients).*/void Clear()
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)
virtual InputType StartOfInput () const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

Protected Attributes

InputType m_DefaultInputStepSize


Member Typedef Documentation

template<unsigned int VDimension>
typedef CoefficientsType::Pointer itk::FourierSeriesPath< VDimension >::CoefficientsPointer
 

Definition at line 87 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>
typedef VectorContainer<unsigned, VectorType> itk::FourierSeriesPath< VDimension >::CoefficientsType
 

Definition at line 86 of file itkFourierSeriesPath.h.

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

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 69 of file itkFourierSeriesPath.h.

template<unsigned int VDimension>
typedef ContinuousIndex<double,VDimension> itk::FourierSeriesPath< VDimension >::ContinuousIndexType
 

Basic data-structure types used

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 82 of file itkFourierSeriesPath.h.

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

All paths must be mapable to index space

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 83 of file itkFourierSeriesPath.h.

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

Input type

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 72 of file itkFourierSeriesPath.h.

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

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 84 of file itkFourierSeriesPath.h.

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

Output type

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 78 of file itkFourierSeriesPath.h.

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

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 68 of file itkFourierSeriesPath.h.

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

Standard class typedefs.

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 66 of file itkFourierSeriesPath.h.

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

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 67 of file itkFourierSeriesPath.h.

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

Reimplemented from itk::ParametricPath< VDimension >.

Definition at line 85 of file itkFourierSeriesPath.h.


Constructor & Destructor Documentation

template<unsigned int VDimension>
itk::FourierSeriesPath< VDimension >::FourierSeriesPath  )  [protected]
 

template<unsigned int VDimension>
itk::FourierSeriesPath< VDimension >::~FourierSeriesPath  )  [inline, protected]
 

Definition at line 121 of file itkFourierSeriesPath.h.


Member Function Documentation

template<unsigned int VDimension>
void itk::FourierSeriesPath< VDimension >::AddHarmonic const VectorType CosCoefficients,
const VectorType SinCoefficients
 

Add another harmonic's frequency coefficients.

template<unsigned int VDimension>
Clear all frequency itk::FourierSeriesPath< VDimension >::coefficients including the"DC"  coefficients  )  [inline]
 

Definition at line 101 of file itkFourierSeriesPath.h.

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.

template<unsigned int VDimension>
virtual OutputType itk::FourierSeriesPath< VDimension >::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 >.

template<unsigned int VDimension>
virtual VectorType itk::FourierSeriesPath< VDimension >::EvaluateDerivative const InputType input  )  const [virtual]
 

Evaluate the first derivative of the ND output with respect to the 1D input. This is an exact, algebraic function.

Reimplemented from itk::ParametricPath< VDimension >.

template<unsigned int VDimension>
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 >.

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

template<unsigned int VDimension>
virtual const char* itk::FourierSeriesPath< VDimension >::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ParametricPath< VDimension >.

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]
 

template<unsigned int VDimension>
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 >.

template<unsigned int VDimension>
virtual void itk::FourierSeriesPath< VDimension >::Initialize void   )  [inline, virtual]
 

Needed for Pipelining

Definition at line 114 of file itkFourierSeriesPath.h.

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

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

template<unsigned int VDimension>
static Pointer itk::FourierSeriesPath< VDimension >::New  )  [static]
 

New() method for dynamic construction

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

template<unsigned int VDimension>
void itk::FourierSeriesPath< VDimension >::PrintSelf std::ostream &  os,
Indent  indent
const [protected]
 

Reimplemented from itk::ParametricPath< VDimension >.

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

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.


Member Data Documentation

template<unsigned int VDimension>
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 19:48:52 2006 for ITK by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2000