ZPGFilter Class Reference

Produce a filter defined by a set of zeros, poles and a gain factor. More...

#include <Sample.h>

Public Member Functions
void	SetGain (const double aGainRe, const double aGainIm)
	Set a filter gain.
void	SetPole (const unsigned int aPoleIndex, const double aPoleRe, const double aPoleIm)
	Set a filter pole.
void	SetZero (const unsigned int aZeroIndex, const double aZeroRe, const double aZeroIm)
	Set a filter zero.
void	WToZ (void)
	Move from the W- to Z-plane.
Constructors and destructors
	ZPGFilter (const unsigned int aNumZeros, const unsigned int aNumPoles)
	Constructor of the ZPGFilter class.
virtual	~ZPGFilter (void)
	Destructor of the ZPGFilter class.

Private Attributes
double	gain [2]
	Complex gain.
unsigned int	npoles
	Number of poles.
unsigned int	nzeros
	Number of zeros.
double *	poles [2]
	Complex poles.
double *	zeros [2]
	Complex zeros.

Friends
class	IIRFilter

Detailed Description

Produce a filter defined by a set of zeros, poles and a gain factor.

This class is designed to create and use a filter defined by zeros and poles.

Author

Florent Robinet

Constructor & Destructor Documentation

ZPGFilter()

ZPGFilter::ZPGFilter	(	const unsigned int	aNumZeros,
		const unsigned int	aNumPoles
	)

Constructor of the ZPGFilter class.

Parameters

[in]	aNumZeros	Number of zeros.
[in]	aNumPoles	Number of poles.

~ZPGFilter()

ZPGFilter::~ZPGFilter ( void  )

virtual

Destructor of the ZPGFilter class.

Member Function Documentation

SetGain()

void ZPGFilter::SetGain ( const double  aGainRe, const double  aGainIm  )

inline

Set a filter gain.

Parameters

[in]	aGainRe	Gain real part.
[in]	aGainIm	Gain imaginary part.

SetPole()

void ZPGFilter::SetPole ( const unsigned int  aPoleIndex, const double  aPoleRe, const double  aPoleIm  )

inline

Set a filter pole.

Parameters

[in]	aPoleIndex	Pole index.
[in]	aPoleRe	Pole real part.
[in]	aPoleIm	Pole imaginary part.

SetZero()

void ZPGFilter::SetZero ( const unsigned int  aZeroIndex, const double  aZeroRe, const double  aZeroIm  )

inline

Set a filter zero.

Parameters

[in]	aZeroIndex	Zero index.
[in]	aZeroRe	Zero real part.
[in]	aZeroIm	Zero imaginary part.

WToZ()

void ZPGFilter::WToZ

(

void

)

Move from the W- to Z-plane.

Friends And Related Symbol Documentation

IIRFilter

friend class IIRFilter

friend

Member Data Documentation

gain

double ZPGFilter::gain[2]

private

Complex gain.

npoles

unsigned int ZPGFilter::npoles

private

Number of poles.

nzeros

unsigned int ZPGFilter::nzeros

private

Number of zeros.

poles

double* ZPGFilter::poles[2]

private

Complex poles.

zeros

double* ZPGFilter::zeros[2]

private

Complex zeros.

---

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

• src/Streams/Sample.h
• src/Streams/Sample.cc