ldas-tools-filters  2.6.6
Public Member Functions | Private Attributes | List of all members
Filters::Interpolate< T > Class Template Reference

Class which implements Lagrange interpolation of a vector. More...

#include <Interpolate.hh>

Public Member Functions

 Interpolate (const double alpha, const size_t order)
 Constructor. More...
 
double getAlpha () const
 Get alpha parameter. More...
 
size_t getOrder () const
 Get order parameter. More...
 
void apply (std::valarray< T > &x)
 Apply the interpolation. More...
 
 Interpolate (const double alpha, const size_t order)
 Constructor. More...
 
double getAlpha () const
 Get alpha parameter. More...
 
size_t getOrder () const
 Get order parameter. More...
 
void apply (std::valarray< T > &x)
 Apply the interpolation. More...
 
 Interpolate (const double alpha, const size_t order)
 Constructor. More...
 
double getAlpha () const
 Get alpha parameter. More...
 
size_t getOrder () const
 Get order parameter. More...
 
void apply (std::valarray< T > &x)
 Apply the interpolation. More...
 

Private Attributes

double m_alpha
 alpha parameter is only stored for getAlpha() More...
 
LinFilt< double, T > m_filt
 the filter used for interpolation. More...
 

Detailed Description

template<class T>
class Filters::Interpolate< T >

Class which implements Lagrange interpolation of a vector.

Constructor & Destructor Documentation

◆ Interpolate() [1/3]

template<class T >
Filters::Interpolate< T >::Interpolate ( const double  alpha,
const size_t  order 
)

Constructor.

Parameters
[in]alphainterpolation parameter, 0 < alpha < 1
[in]orderorder of Lagrange polynomial used for interpolation
Exceptions
invalid_argumentThrown if alpha <= 0 or alpha >= 1

◆ Interpolate() [2/3]

template<class T >
Filters::Interpolate< T >::Interpolate ( const double  alpha,
const size_t  order 
)

Constructor.

Parameters
[in]alphainterpolation parameter, 0 < alpha < 1
[in]orderorder of Lagrange polynomial used for interpolation
Exceptions
invalid_argumentThrown if alpha <= 0 or alpha >= 1

◆ Interpolate() [3/3]

template<class T >
Filters::Interpolate< T >::Interpolate ( const double  alpha,
const size_t  order 
)

Constructor.

Parameters
[in]alphainterpolation parameter, 0 < alpha < 1
[in]orderorder of Lagrange polynomial used for interpolation
Exceptions
invalid_argumentThrown if alpha <= 0 or alpha >= 1

Member Function Documentation

◆ apply() [1/3]

template<class T >
void Filters::Interpolate< T >::apply ( std::valarray< T > &  x)

Apply the interpolation.

The data contained in x is interpolated and the result returned in x.

Parameters
[in]xthe data to be interpolated
Exceptions
invalid_argumentThrown if x.size() == 0

◆ apply() [2/3]

template<class T >
void Filters::Interpolate< T >::apply ( std::valarray< T > &  x)

Apply the interpolation.

The data contained in x is interpolated and the result returned in x.

Parameters
[in]xthe data to be interpolated
Exceptions
invalid_argumentThrown if x.size() == 0

◆ apply() [3/3]

template<class T >
void Filters::Interpolate< T >::apply ( std::valarray< T > &  x)

Apply the interpolation.

The data contained in x is interpolated and the result returned in x.

Parameters
[in]xthe data to be interpolated
Exceptions
invalid_argumentThrown if x.size() == 0

◆ getAlpha() [1/3]

template<class T >
double Filters::Interpolate< T >::getAlpha
inline

Get alpha parameter.

◆ getAlpha() [2/3]

template<class T >
double Filters::Interpolate< T >::getAlpha ( ) const

Get alpha parameter.

◆ getAlpha() [3/3]

template<class T >
double Filters::Interpolate< T >::getAlpha ( ) const

Get alpha parameter.

◆ getOrder() [1/3]

template<class T >
size_t Filters::Interpolate< T >::getOrder
inline

Get order parameter.

◆ getOrder() [2/3]

template<class T >
size_t Filters::Interpolate< T >::getOrder ( ) const

Get order parameter.

◆ getOrder() [3/3]

template<class T >
size_t Filters::Interpolate< T >::getOrder ( ) const

Get order parameter.

Member Data Documentation

◆ m_alpha

template<class T >
double Filters::Interpolate< T >::m_alpha
private

alpha parameter is only stored for getAlpha()

◆ m_filt

template<class T >
LinFilt< double, T > Filters::Interpolate< T >::m_filt
private

the filter used for interpolation.


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