ldas-tools-filters  2.6.4
Classes | Functions
Filters Namespace Reference

author: "Eric Rotthoff/L. S. Finn" More...

Classes

class  basic_array
 This class implements a trivial exception-safe C-style array. More...
 
class  HannWindow
 A class representing a Hann window. More...
 
class  Interpolate
 Class which implements Lagrange interpolation of a vector. More...
 
class  KaiserWindow
 A class representing a Kaiser window. More...
 
class  LinFilt
 Class for performing linear filtering on arbitrary data sequences. More...
 
class  LinFiltBase
 Virtual base class for LinFilt - required for RTTI. More...
 
class  LinFiltCoeffTraits
 
class  LinFiltStateTraits
 
class  LinFiltTraits
 Traits for LinFilt objects. More...
 
class  LinFiltTraits< std::complex< float >, float >
 
class  RectangularWindow
 A class representing a rectangular window. More...
 
class  Window
 An abstract base class for window functions. More...
 

Functions

int gcd (int m, int n)
 Calculate the greatest common divisor of m and n using Euclid's method.
 
template<class T >
void designInterpolatingFilter (std::valarray< T > &b, const double alpha)
 Calculate FIR coefficients for an interpolating filter. More...
 
double Sinc (const double &x)
 Sinc(x) returns sin(pi*x)/(pi*x)
 
template<class Type >
std::valarray< Type > real (const std::valarray< Type > &Data)
 retrieve the real component of a valarray More...
 
template<class Type >
std::valarray< Type > real (const std::valarray< std::complex< Type > > &Data)
 retrieve the real component of a valarray More...
 
template<class Type >
std::valarray< Type > imag (const std::valarray< Type > &Data)
 retrieve the imaginary component of a valarray More...
 
template<class Type >
std::valarray< Type > imag (const std::valarray< std::complex< Type > > &Data)
 retrieve the imaginary component of a valarray More...
 
template<class T >
std::valarray< T > abs (const std::valarray< std::complex< T > > &in)
 calculate the absolute value of a valarray
 
template<class T >
std::valarray< T > arg (const std::valarray< std::complex< T > > &in)
 calculate the arg of a valarray
 
template<class Type >
std::valarray< Type > conj (const std::valarray< Type > &Data)
 retrieve the conjugate of a valarray
 
template<class Type >
std::valarray< std::complex< Type > > conj (const std::valarray< std::complex< Type > > &Data)
 retrieve the conjugate of a valarray
 
template<class OutType , class InType >
void valarray_copy (std::valarray< OutType > &out, const std::valarray< InType > &in)
 copy from an arbitrary valarray to an arbitrary valarray More...
 
template<>
void valarray_copy (std::valarray< std::complex< float > > &out, const std::valarray< std::complex< double > > &in)
 Specialisation to deal with complex<double> to complex<float>
 

Detailed Description

author: "Eric Rotthoff/L. S. Finn"

Function Documentation

◆ designInterpolatingFilter()

template<class T >
void Filters::designInterpolatingFilter ( std::valarray< T > &  b,
const double  alpha 
)

Calculate FIR coefficients for an interpolating filter.

This function designs a FIR filter for interpolating the values in a vector with a Lagrange polynomial of order b.size() - 1.

Parameters
[out]bthe array to fill with Lagrange polynomial coefficients.
[in]alphainterpolation parameter
Exceptions
invalid_argumentThrown if b.size() == 0
invalid_argumentThrown if alpha <= 0 or alpha >= 1

◆ imag() [1/2]

template<class Type >
std::valarray< Type > Filters::imag ( const std::valarray< Type > &  Data)

retrieve the imaginary component of a valarray

Parameters
[in]DataData set from which to extract the imaginary compoenent.
Returns
imaginary component of Data

◆ imag() [2/2]

template<class Type >
std::valarray< Type > Filters::imag ( const std::valarray< std::complex< Type > > &  Data)

retrieve the imaginary component of a valarray

Parameters
[in]DataData set from which to extract the imaginary compoenent.
Returns
imaginary component of Data

◆ real() [1/2]

template<class Type >
std::valarray< Type > Filters::real ( const std::valarray< Type > &  Data)

retrieve the real component of a valarray

Parameters
[in]DataData set from which to extract the real compoenent.
Returns
real component of Data

◆ real() [2/2]

template<class Type >
std::valarray< Type > Filters::real ( const std::valarray< std::complex< Type > > &  Data)

retrieve the real component of a valarray

Parameters
[in]DataData set from which to extract the real compoenent.
Returns
real component of Data

◆ valarray_copy()

template<class OutType , class InType >
void Filters::valarray_copy ( std::valarray< OutType > &  out,
const std::valarray< InType > &  in 
)
inline

copy from an arbitrary valarray to an arbitrary valarray

Parameters
[out]outtarget
[in]insource