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

#include <itkFourierSeriesPath.h>

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

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 58 of file itkFourierSeriesPath.h.

Public Types

typedef CoefficientsType::Pointer CoefficientsPointer
 
typedef VectorContainer
< unsigned, VectorType
CoefficientsType
 
typedef SmartPointer< const SelfConstPointer
 
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 Types inherited from itk::ParametricPath< VDimension >
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

void AddHarmonic (const VectorType &CosCoefficients, const VectorType &SinCoefficients)
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual OutputType Evaluate (const InputType &input) const override
 
virtual VectorType EvaluateDerivative (const InputType &input) const override
 
virtual const char * GetNameOfClass () const
 
virtual void Initialize (void) override
 
void Clear ()
 
- Public Member Functions inherited from itk::ParametricPath< VDimension >
virtual VectorType EvaluateDerivative (const InputType &input) const
 
virtual IndexType EvaluateToIndex (const InputType &input) const override
 
virtual const InputTypeGetDefaultInputStepSize () const
 
virtual 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
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 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 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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
 

Static Public Member Functions

static Pointer New ()
 
- 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 ()
 

Protected Member Functions

 FourierSeriesPath ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~FourierSeriesPath ()
 
- Protected Member Functions inherited from itk::ParametricPath< VDimension >
 ParametricPath ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~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 ()
 

Private Member Functions

 FourierSeriesPath (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

CoefficientsPointer m_CosCoefficients
 
CoefficientsPointer m_SinCoefficients
 

Additional Inherited Members

- Static Public Attributes inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
static const unsigned int PathDimension
 
- Protected Attributes inherited from itk::ParametricPath< VDimension >
InputType m_DefaultInputStepSize
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 83 of file itkFourierSeriesPath.h.

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

Definition at line 82 of file itkFourierSeriesPath.h.

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

Definition at line 66 of file itkFourierSeriesPath.h.

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

Basic data-structure types used

Definition at line 78 of file itkFourierSeriesPath.h.

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

Definition at line 79 of file itkFourierSeriesPath.h.

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

Input type

Definition at line 69 of file itkFourierSeriesPath.h.

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

Definition at line 80 of file itkFourierSeriesPath.h.

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

Output type

Definition at line 75 of file itkFourierSeriesPath.h.

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

Definition at line 65 of file itkFourierSeriesPath.h.

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

Standard class typedefs.

Definition at line 63 of file itkFourierSeriesPath.h.

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

Definition at line 64 of file itkFourierSeriesPath.h.

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

Definition at line 81 of file itkFourierSeriesPath.h.

Constructor & Destructor Documentation

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

Definition at line 116 of file itkFourierSeriesPath.h.

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

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>
void itk::FourierSeriesPath< VDimension >::Clear ( void  )
inline
template<unsigned int VDimension>
virtual::itk::LightObject::Pointer itk::FourierSeriesPath< VDimension >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<unsigned int VDimension>
virtual OutputType itk::FourierSeriesPath< VDimension >::Evaluate ( const InputType input) const
overridevirtual

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

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

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

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

template<unsigned int VDimension>
virtual void itk::FourierSeriesPath< VDimension >::Initialize ( void  )
inlineoverridevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 109 of file itkFourierSeriesPath.h.

References itk::FourierSeriesPath< VDimension >::Clear().

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

New() method for dynamic construction

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

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

Member Data Documentation

template<unsigned int VDimension>
CoefficientsPointer itk::FourierSeriesPath< VDimension >::m_CosCoefficients
private

Definition at line 123 of file itkFourierSeriesPath.h.

Referenced by itk::FourierSeriesPath< VDimension >::Clear().

template<unsigned int VDimension>
CoefficientsPointer itk::FourierSeriesPath< VDimension >::m_SinCoefficients
private

Definition at line 124 of file itkFourierSeriesPath.h.

Referenced by itk::FourierSeriesPath< VDimension >::Clear().


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