eLynx::Math::BSpline1< F > Class Template Reference

1D spline interface. More...

#include <BSpline.h>

Inheritance diagram for eLynx::Math::BSpline1< F >:

List of all members.

Public Types
typedef F	type
Public Member Functions
template<typename T >
	BSpline1 (const int32 *iX, uint32 iWidth, const T *iData)
	Class constructor.
virtual bool	IsUseful () const
	Verifies that spline can be used for interpolation.
virtual std::pair< int32, int32 >	GetRange () const
	Returns the interpolation range in form of [X1, Xn)
virtual F	Evaluate (int32 iX) const
	Computes an interpolation at a given point.

---

Detailed Description

template<typename F>
class eLynx::Math::BSpline1< F >

1D spline interface.

DEGREE specifies the order of the interpolation. F specifies the type of the interpolated values. For example, for all interger types T (short, int32, long) F is double. For Pixel<uint16> input type F should be Pixel<double>. Idealy, this should be done via template metaprogramming

---

Constructor & Destructor Documentation

template<typename F >

template<typename T >

eLynx::Math::BSpline1< F >::BSpline1	(	const int32 *	iX,
		uint32	iWidth,
		const T *	iData
	)

Class constructor.

T specifies type of the input values iX is array of unique positions sorted in the ascending order.

Parameters:

iX	array of coordinates.
iWidth	number of coordinates in an array.
iData	values at the given points.

---

Member Function Documentation

template<typename F >

virtual F eLynx::Math::BSpline1< F >::Evaluate

(

int32

iX )

const [virtual]

Computes an interpolation at a given point.

The point must fall into the range returned by GetRange method.

Parameters:

iX	point's coordinate.

Returns:

the interpolation value.

Implements eLynx::Math::ISpline1D< F, 3 >.

template<typename F >

virtual std::pair<int32,int32> eLynx::Math::BSpline1< F >::GetRange

(

)

const [virtual]

Returns the interpolation range in form of [X1, Xn)

Returns:

interpolation range.

Implements eLynx::Math::ISpline1D< F, 3 >.

template<typename F >

virtual bool eLynx::Math::BSpline1< F >::IsUseful

(

)

const [virtual]

Verifies that spline can be used for interpolation.

Returns:

true if spline was initialize properly.

Implements eLynx::Math::ISpline1D< F, 3 >.

---

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

• E:/dev/eLynx/include/elx/math/BSpline.h