#include <itkFourierSeriesPath.h>

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 coefficients (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 59 of file itkFourierSeriesPath.h.

Inheritance diagram for itk::FourierSeriesPath< VDimension >:

Collaboration diagram for itk::FourierSeriesPath< VDimension >:

Public Types
using	CoefficientsPointer = typename CoefficientsType::Pointer

using	CoefficientsType = VectorContainer<unsigned int, VectorType>

using	ConstPointer = SmartPointer<const Self>

using	ContinuousIndexType = ContinuousIndex<double, VDimension>

using	IndexType = Index<VDimension>

using	OffsetType = Offset<VDimension>

using	Pointer = SmartPointer<Self>

using	Self = FourierSeriesPath

using	Superclass = ParametricPath<VDimension>

using	VectorType = Vector<double, VDimension>

Public Types inherited from itk::ParametricPath< VDimension >
using	ConstPointer = SmartPointer<const Self>

using	ContinuousIndexType = ContinuousIndex<SpacePrecisionType, VDimension>

using	IndexType = Index<VDimension>

using	InputType

using	OffsetType = Offset<VDimension>

using	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

using	IndexType

using	InputType

using	OffsetType

using	OutputType

using	Pointer

using	Self

using	Superclass

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
void	AddHarmonic (const VectorType &CosCoefficients, const VectorType &SinCoefficients)

virtual::itk::LightObject::Pointer	CreateAnother () const

OutputType	Evaluate (const InputType &input) const override

VectorType	EvaluateDerivative (const InputType &input) const override

const char *	GetNameOfClass () const override

void	Initialize () override


void	Clear ()

Public Member Functions inherited from itk::ParametricPath< VDimension >
IndexType	EvaluateToIndex (const InputType &input) const override

virtual const InputType &	GetDefaultInputStepSize () const

const char *	GetNameOfClass () const override

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

const char *	GetNameOfClass () const override

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

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () 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 ()

void	UpdateSource () const

virtual bool	VerifyRequestedRegion ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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) const

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
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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 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 val)

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 () override=default

Protected Member Functions inherited from itk::ParametricPath< VDimension >
	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 ()

virtual void	PropagateResetPipeline ()

	~DataObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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 Attributes
CoefficientsPointer	m_CosCoefficients {}

CoefficientsPointer	m_SinCoefficients {}

Additional Inherited Members
Static Public Attributes inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
static constexpr unsigned int	PathDimension

Protected Attributes inherited from itk::ParametricPath< VDimension >
InputType	m_DefaultInputStepSize {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ CoefficientsPointer

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::CoefficientsPointer = typename CoefficientsType::Pointer

Definition at line 85 of file itkFourierSeriesPath.h.

◆ CoefficientsType

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::CoefficientsType = VectorContainer<unsigned int, VectorType>

Definition at line 84 of file itkFourierSeriesPath.h.

◆ ConstPointer

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 68 of file itkFourierSeriesPath.h.

◆ ContinuousIndexType

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::ContinuousIndexType = ContinuousIndex<double, VDimension>

Basic data-structure types used

Definition at line 80 of file itkFourierSeriesPath.h.

◆ IndexType

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::IndexType = Index<VDimension>

Definition at line 81 of file itkFourierSeriesPath.h.

◆ OffsetType

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::OffsetType = Offset<VDimension>

Definition at line 82 of file itkFourierSeriesPath.h.

◆ Pointer

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::Pointer = SmartPointer<Self>

Definition at line 67 of file itkFourierSeriesPath.h.

◆ Self

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::Self = FourierSeriesPath

Standard class type aliases.

Definition at line 65 of file itkFourierSeriesPath.h.

◆ Superclass

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::Superclass = ParametricPath<VDimension>

Definition at line 66 of file itkFourierSeriesPath.h.

◆ VectorType

template<unsigned int VDimension>

using itk::FourierSeriesPath< VDimension >::VectorType = Vector<double, VDimension>

Definition at line 83 of file itkFourierSeriesPath.h.

Constructor & Destructor Documentation

◆ FourierSeriesPath()

template<unsigned int VDimension>

itk::FourierSeriesPath< VDimension >::FourierSeriesPath ( )

protected

Referenced by GetNameOfClass().

◆ ~FourierSeriesPath()

template<unsigned int VDimension>

itk::FourierSeriesPath< VDimension >::~FourierSeriesPath ( )

overrideprotecteddefault

Member Function Documentation

◆ AddHarmonic()

template<unsigned int VDimension>

void itk::FourierSeriesPath< VDimension >::AddHarmonic	(	const VectorType &	CosCoefficients,
		const VectorType &	SinCoefficients )

Add another harmonic's frequency coefficients.

◆ Clear()

template<unsigned int VDimension>

void itk::FourierSeriesPath< VDimension >::Clear ( )

inline

Clear all frequency coefficients (including the "DC" coefficients).

Definition at line 102 of file itkFourierSeriesPath.h.

References m_CosCoefficients, m_SinCoefficients, and itk::Object::Modified().

Referenced by Initialize().

◆ CreateAnother()

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

◆ Evaluate()

template<unsigned int VDimension>

OutputType itk::FourierSeriesPath< VDimension >::Evaluate ( const InputType & input ) const

overridevirtual

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

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

◆ EvaluateDerivative()

template<unsigned int VDimension>

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.

Reimplemented from itk::ParametricPath< VDimension >.

◆ GetNameOfClass()

template<unsigned int VDimension>

const char * itk::FourierSeriesPath< VDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

References FourierSeriesPath().

◆ Initialize()

template<unsigned int VDimension>

void itk::FourierSeriesPath< VDimension >::Initialize ( )

inlineoverridevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 115 of file itkFourierSeriesPath.h.

References Clear().

◆ New()

template<unsigned int VDimension>

static Pointer itk::FourierSeriesPath< VDimension >::New ( )

static

New() method for dynamic construction

◆ PrintSelf()

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

Member Data Documentation

◆ m_CosCoefficients

template<unsigned int VDimension>

CoefficientsPointer itk::FourierSeriesPath< VDimension >::m_CosCoefficients {}

private

Definition at line 127 of file itkFourierSeriesPath.h.

Referenced by Clear().

◆ m_SinCoefficients

template<unsigned int VDimension>

CoefficientsPointer itk::FourierSeriesPath< VDimension >::m_SinCoefficients {}

private

Definition at line 128 of file itkFourierSeriesPath.h.

Referenced by Clear().

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

itkFourierSeriesPath.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CoefficientsPointer

◆ CoefficientsType

◆ ConstPointer

◆ ContinuousIndexType

◆ IndexType

◆ OffsetType

◆ Pointer

◆ Self

◆ Superclass

◆ VectorType

Constructor & Destructor Documentation

◆ FourierSeriesPath()

◆ ~FourierSeriesPath()

Member Function Documentation

◆ AddHarmonic()

◆ Clear()

◆ CreateAnother()

◆ Evaluate()

◆ EvaluateDerivative()

◆ GetNameOfClass()

◆ Initialize()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ m_CosCoefficients

◆ m_SinCoefficients