lti::cubicSpline< T >::parameters Class Reference

the parameters for the class cubicSpline More...

#include <ltiCubicSpline.h>

Inheritance diagram for lti::cubicSpline< T >::parameters:

[legend]

Collaboration diagram for lti::cubicSpline< T >::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
bool	write (ioHandler &handler, const bool complete=true) const
bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
bool	useNaturalDerivatives
double	derivativeAtFirstPoint
double	derivativeAtLastPoint
tpointList< T >	samplingPoints

---

Detailed Description

template<class T>
class lti::cubicSpline< T >::parameters

the parameters for the class cubicSpline

---

Constructor & Destructor Documentation

template<class T >

lti::cubicSpline< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

References lti::cubicSpline< T >::parameters::derivativeAtFirstPoint, lti::cubicSpline< T >::parameters::derivativeAtLastPoint, lti::cubicSpline< T >::parameters::samplingPoints, and lti::cubicSpline< T >::parameters::useNaturalDerivatives.

Referenced by lti::cubicSpline< T >::parameters::clone().

template<class T >

lti::cubicSpline< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

References lti::cubicSpline< T >::parameters::copy().

template<class T >

lti::cubicSpline< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

---

Member Function Documentation

template<class T >

virtual functor::parameters* lti::cubicSpline< T >::parameters::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Implements lti::variablySpacedSamplesInterpolator::parameters.

References lti::cubicSpline< T >::parameters::parameters().

template<class T >

parameters& lti::cubicSpline< T >::parameters::copy

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

References lti::variablySpacedSamplesInterpolator::parameters::copy(), lti::cubicSpline< T >::parameters::derivativeAtFirstPoint, lti::cubicSpline< T >::parameters::derivativeAtLastPoint, lti::cubicSpline< T >::parameters::samplingPoints, and lti::cubicSpline< T >::parameters::useNaturalDerivatives.

Referenced by lti::cubicSpline< T >::parameters::operator=(), and lti::cubicSpline< T >::parameters::parameters().

template<class T >

const char* lti::cubicSpline< T >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

template<class T >

parameters& lti::cubicSpline< T >::parameters::operator=

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

References lti::cubicSpline< T >::parameters::copy().

template<class T >

bool lti::cubicSpline< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[inline, virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also read, otherwise only the data block will be read.

Returns:

true if write was successful

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

References lti::cubicSpline< T >::parameters::derivativeAtFirstPoint, lti::cubicSpline< T >::parameters::derivativeAtLastPoint, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), lti::cubicSpline< T >::parameters::samplingPoints, and lti::cubicSpline< T >::parameters::useNaturalDerivatives.

template<class T >

bool lti::cubicSpline< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [inline, virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::variablySpacedSamplesInterpolator::parameters.

References lti::cubicSpline< T >::parameters::derivativeAtFirstPoint, lti::cubicSpline< T >::parameters::derivativeAtLastPoint, lti::cubicSpline< T >::parameters::samplingPoints, lti::cubicSpline< T >::parameters::useNaturalDerivatives, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

double lti::cubicSpline< T >::parameters::derivativeAtFirstPoint

This parameter saves the derivative at the begin of the function.

If the spline should start horizontal the parameter has to be zero. If the parameter useNaturalDerivatives is true this value has no effect. Default value: 0.0

Referenced by lti::cubicSpline< T >::parameters::copy(), lti::cubicSpline< T >::parameters::parameters(), lti::cubicSpline< T >::parameters::read(), and lti::cubicSpline< T >::parameters::write().

template<class T >

double lti::cubicSpline< T >::parameters::derivativeAtLastPoint

This parameter saves the derivative at the end of the function.

If the spline should end horizontal the parameter has to be zero. If the parameter useNaturalDerivatives is true this value has no effect. Default value: 0.0

Referenced by lti::cubicSpline< T >::parameters::copy(), lti::cubicSpline< T >::parameters::parameters(), lti::cubicSpline< T >::parameters::read(), and lti::cubicSpline< T >::parameters::write().

template<class T >

tpointList<T> lti::cubicSpline< T >::parameters::samplingPoints

This is the list of the sampling points.

Every x-value must be unique in this tpointList<T> and the list must consist of at least three points, or the apply method will fail Default value: empty list!

Referenced by lti::cubicSpline< T >::parameters::copy(), lti::cubicSpline< T >::parameters::parameters(), lti::cubicSpline< T >::parameters::read(), and lti::cubicSpline< T >::parameters::write().

template<class T >

bool lti::cubicSpline< T >::parameters::useNaturalDerivatives

This boolean controls if the algorithm uses the derivative values given within the parameters object (false), or if the functor should calculate the optimal derivatives (true).

Default value: true

Referenced by lti::cubicSpline< T >::parameters::copy(), lti::cubicSpline< T >::parameters::parameters(), lti::cubicSpline< T >::parameters::read(), and lti::cubicSpline< T >::parameters::write().

---

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

• ltiCubicSpline.h