UTILSLIB::FilterKernel Class Reference

The FilterKernel class provides methods to create/design a FIR filter kernel. More...

#include <filterkernel.h>

Public Member Functions
	FilterKernel ()
	FilterKernel creates a default FilterKernel object.
	FilterKernel (const QString &sFilterName, int iFilterType, int iOrder, double dCenterfreq, double dBandwidth, double dParkswidth, double dSFreq, int iDesignMethod)
void	prepareFilter (int iDataSize)
Eigen::RowVectorXd	applyConvFilter (const Eigen::RowVectorXd &vecData, bool bKeepOverhead=false) const
void	applyFftFilter (Eigen::RowVectorXd &vecData, bool bKeepOverhead=false)
QString	getName () const
void	setName (const QString &sFilterName)
double	getSamplingFrequency () const
void	setSamplingFrequency (double dSFreq)
int	getFilterOrder () const
void	setFilterOrder (int iOrder)
double	getCenterFrequency () const
void	setCenterFrequency (double dCenterFreq)
double	getBandwidth () const
void	setBandwidth (double dBandwidth)
double	getParksWidth () const
void	setParksWidth (double dParksWidth)
double	getHighpassFreq () const
void	setHighpassFreq (double dHighpassFreq)
double	getLowpassFreq () const
void	setLowpassFreq (double dLowpassFreq)
Eigen::RowVectorXd	getCoefficients () const
void	setCoefficients (const Eigen::RowVectorXd &vecCoeff)
Eigen::RowVectorXcd	getFftCoefficients () const
void	setFftCoefficients (const Eigen::RowVectorXcd &vecFftCoeff)
FilterParameter	getDesignMethod () const
void	setDesignMethod (int iDesignMethod)
FilterParameter	getFilterType () const
void	setFilterType (int iFilterType)
QString	getShortDescription () const

Static Public Attributes
static QVector< FilterParameter >	m_designMethods
static QVector< FilterParameter >	m_filterTypes

Detailed Description

The FilterKernel class provides methods to create/design a FIR filter kernel.

The FilterKernel class provides methods to create/design a FIR filter kernel

Definition at line 122 of file filterkernel.h.

Constructor & Destructor Documentation

FilterKernel() [1/2]

FilterKernel::FilterKernel

(

)

FilterKernel creates a default FilterKernel object.

Definition at line 71 of file filterkernel.cpp.

FilterKernel() [2/2]

FilterKernel::FilterKernel	(	const QString &	sFilterName,
		int	iFilterType,
		int	iOrder,
		double	dCenterfreq,
		double	dBandwidth,
		double	dParkswidth,
		double	dSFreq,
		int	iDesignMethod )

Constructs a FilterKernel object

Parameters

[in]	sFilterName	Defines the name of the generated filter.
[in]	type	Tyep of the filter: LPF, HPF, BPF, NOTCH (from enum FilterType).
[in]	iOrder	Represents the order of the filter, the higher the higher is the stopband attenuation.
[in]	dCenterfreq	Determines the center of the frequency - normed to sFreq/2 (nyquist).
[in]	dBandwidth	Ignored if FilterType is set to LPF,HPF. if NOTCH/BPF: bandwidth of stop-/passband - normed to sFreq/2 (nyquist).
[in]	dParkswidth	Determines the width of the filter slopes (steepness) - normed to sFreq/2 (nyquist).
[in]	dSFreq	The sampling frequency.
[in]	designMethod	Specifies the design method to use. Choose between Cosind and Tschebyscheff.

Definition at line 89 of file filterkernel.cpp.

Member Function Documentation

applyConvFilter()

RowVectorXd FilterKernel::applyConvFilter	(	const Eigen::RowVectorXd &	vecData,
		bool	bKeepOverhead = false ) const

Applies the current filter to the input data using convolution in time domain.

Parameters

[in]	vecData	Holds the data to be filtered.
[in]	bKeepOverhead	Whether the result should still include the overhead information in front and back of the data. Default is set to false.

Returns

the filtered data in form of a RowVectorXd.

Definition at line 132 of file filterkernel.cpp.

applyFftFilter()

void FilterKernel::applyFftFilter	(	Eigen::RowVectorXd &	vecData,
		bool	bKeepOverhead = false )

Applies the current filter to the input data using multiplication in frequency domain.

Parameters

[in,out]	vecData	Holds the data to be filtered. Gets overwritten with its filtered result.
[in]	bKeepOverhead	Whether the result should still include the overhead information in front and back of the data. Default is set to false.

Returns

the filtered data in form of a RowVectorXd.

Definition at line 156 of file filterkernel.cpp.

getBandwidth()

double FilterKernel::getBandwidth

(

)

const

Definition at line 261 of file filterkernel.cpp.

getCenterFrequency()

double FilterKernel::getCenterFrequency

(

)

const

Definition at line 247 of file filterkernel.cpp.

getCoefficients()

Eigen::RowVectorXd FilterKernel::getCoefficients

(

)

const

Definition at line 317 of file filterkernel.cpp.

getDesignMethod()

UTILSLIB::FilterParameter FilterKernel::getDesignMethod

(

)

const

Definition at line 511 of file filterkernel.cpp.

getFftCoefficients()

Eigen::RowVectorXcd FilterKernel::getFftCoefficients

(

)

const

Definition at line 331 of file filterkernel.cpp.

getFilterOrder()

int FilterKernel::getFilterOrder

(

)

const

Definition at line 233 of file filterkernel.cpp.

getFilterType()

UTILSLIB::FilterParameter FilterKernel::getFilterType

(

)

const

Definition at line 521 of file filterkernel.cpp.

getHighpassFreq()

double FilterKernel::getHighpassFreq

(

)

const

Definition at line 289 of file filterkernel.cpp.

getLowpassFreq()

double FilterKernel::getLowpassFreq

(

)

const

Definition at line 303 of file filterkernel.cpp.

getName()

QString FilterKernel::getName

(

)

const

Definition at line 205 of file filterkernel.cpp.

getParksWidth()

double FilterKernel::getParksWidth

(

)

const

Definition at line 275 of file filterkernel.cpp.

getSamplingFrequency()

double FilterKernel::getSamplingFrequency

(

)

const

Definition at line 219 of file filterkernel.cpp.

getShortDescription()

QString FilterKernel::getShortDescription

(

)

const

Definition at line 501 of file filterkernel.cpp.

prepareFilter()

void FilterKernel::prepareFilter

(

int

iDataSize

)

Prepares a filter kernel to be used wiht a specific data block length. This is favorable to call before filtering, in order to avoid transforming the filter coefficients anew during filtering. This functions was introduced since one does not always know the data length of the data blocks to be filtered when designing the filter.

Parameters

[in]

iDataSize

The data size to setup the filters to.

Definition at line 116 of file filterkernel.cpp.

setBandwidth()

void FilterKernel::setBandwidth

(

double

dBandwidth

)

Definition at line 268 of file filterkernel.cpp.

setCenterFrequency()

void FilterKernel::setCenterFrequency

(

double

dCenterFreq

)

Definition at line 254 of file filterkernel.cpp.

setCoefficients()

void FilterKernel::setCoefficients

(

const Eigen::RowVectorXd &

vecCoeff

)

Definition at line 324 of file filterkernel.cpp.

setDesignMethod()

void FilterKernel::setDesignMethod

(

int

iDesignMethod

)

Definition at line 531 of file filterkernel.cpp.

setFftCoefficients()

void FilterKernel::setFftCoefficients

(

const Eigen::RowVectorXcd &

vecFftCoeff

)

Definition at line 338 of file filterkernel.cpp.

setFilterOrder()

void FilterKernel::setFilterOrder

(

int

iOrder

)

Definition at line 240 of file filterkernel.cpp.

setFilterType()

void FilterKernel::setFilterType

(

int

iFilterType

)

Definition at line 542 of file filterkernel.cpp.

setHighpassFreq()

void FilterKernel::setHighpassFreq

(

double

dHighpassFreq

)

Definition at line 296 of file filterkernel.cpp.

setLowpassFreq()

void FilterKernel::setLowpassFreq

(

double

dLowpassFreq

)

Definition at line 310 of file filterkernel.cpp.

setName()

void FilterKernel::setName

(

const QString &

sFilterName

)

Definition at line 212 of file filterkernel.cpp.

setParksWidth()

void FilterKernel::setParksWidth

(

double

dParksWidth

)

Definition at line 282 of file filterkernel.cpp.

setSamplingFrequency()

void FilterKernel::setSamplingFrequency

(

double

dSFreq

)

Definition at line 226 of file filterkernel.cpp.

Member Data Documentation

m_designMethods

QVector< UTILSLIB::FilterParameter > FilterKernel::m_designMethods

static

Vector of possible filter design methods.

Definition at line 230 of file filterkernel.h.

m_filterTypes

QVector< UTILSLIB::FilterParameter > FilterKernel::m_filterTypes

static

Vector of possible filter design types.

Definition at line 231 of file filterkernel.h.

---

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

• src/libraries/dsp/filterkernel.h
• src/libraries/dsp/filterkernel.cpp