The class of Finite Impulse Response filters. More...

#include <aims/signalfilter/firfilter.h>

Collaboration diagram for AimsFIRFilter:

[legend]

Public Member Functions
Constructor and Destructor
	AimsFIRFilter (float fs, float fc, float deltaf, float deltap, float deltas, int type)
	Constructor dedicated to lowpass filters or highpass filters. More...

	AimsFIRFilter (float fs, float fl, float fh, float deltaf, float deltap, float deltas, int type)
	Constructor dedicated to stopband filters or passband filters. More...

virtual	~AimsFIRFilter ()
	Destructor free the impulse response. More...

Material and methods
float	fSampling () const
	Return the sampling frequency. More...

float	fCut () const
	Return the cut frequency (highpass or lowpass) More...

float	fLow () const
	Return the low cut frequency (bandpass or bandstop) More...

float	fHigh () const
	Return the high cut frequency (bandpass or bandstop) More...

float	deltaF () const
	Return the frequency step. More...

float	deltaP () const
	Return the passband ripple. More...

float	deltaS () const
	Return the stopband ripple. More...

int	type () const
	Return the type of the filter. More...

carto::VolumeRef< float >	process (const carto::rc_ptr< carto::Volume< float > > &data, AimsDirectionAxis dir=AIMS_X_DIRECTION)
	Send a filter processing on a data according to a direction. More...

Protected Member Functions
Methods
void	numberOfFIRFilterCoef ()
	Process the number of coefficients. More...

carto::VolumeRef< float >	kaiserWindow ()
	Return a Kaiser window. More...

carto::VolumeRef< float >	idealImpulseResponse ()
	Return the ideal impulse response of the F.I.R. filter. More...

carto::VolumeRef< float >	impulseResponse ()
	Return the modified impulse response of the F.I.R. filter. More...

void	initialize ()
	send the process which evaluate the coefficients More...

Protected Attributes
float	_fSampling
	Sampling frequency. More...

float	_fCut
	Cut frequency. More...

float	_fLow
	Low cut frequency. More...

float	_fHigh
	High cut frequency. More...

float	_deltaF
	Frequency resolution. More...

float	_deltaP
	Residual ondulation in pass-band. More...

float	_deltaS
	Residual ondulation in stop-band. More...

float	_beta
	Beta parameter. More...

int	_type
	Type of the filter. More...

int	_nCoef
	Number of coefficients. More...

carto::VolumeRef< float > *	_impulseResponse
	Impulse response. More...

Detailed Description

The class of Finite Impulse Response filters.

Definition at line 77 of file firfilter.h.

Constructor & Destructor Documentation

◆ AimsFIRFilter() [1/2]

AimsFIRFilter::AimsFIRFilter	(	float	fs,
		float	fc,
		float	deltaf,
		float	deltap,
		float	deltas,
		int	type
	)

Constructor dedicated to lowpass filters or highpass filters.

Parameters

fs	sampling frequency
fc	cutting frequency
deltaf	frequency resolution or step
deltap	residual ripple in pass band
deltas	residual ripple in stop band
type	type of the FIR filter (AIMS_FIR_LOWPASS,AIMS_FIR_HIGHPASS)

◆ AimsFIRFilter() [2/2]

AimsFIRFilter::AimsFIRFilter	(	float	fs,
		float	fl,
		float	fh,
		float	deltaf,
		float	deltap,
		float	deltas,
		int	type
	)

Constructor dedicated to stopband filters or passband filters.

Parameters

fs	sampling frequency
fl	lower cutting frequency
fh	higher cutting frequency
deltaf	frequency resolution or step
deltap	residual ripple in pass band
deltas	residual ripple in stop band
type	type of the FIR filter (AIMS_FIR_BANDPASS,AIMS_FIR_BANDSTOP)

◆ ~AimsFIRFilter()

virtual AimsFIRFilter::~AimsFIRFilter ( )

virtual

Destructor free the impulse response.

Member Function Documentation

◆ deltaF()

float AimsFIRFilter::deltaF ( ) const

Return the frequency step.

◆ deltaP()

float AimsFIRFilter::deltaP ( ) const

Return the passband ripple.

◆ deltaS()

float AimsFIRFilter::deltaS ( ) const

Return the stopband ripple.

◆ fCut()

float AimsFIRFilter::fCut ( ) const

Return the cut frequency (highpass or lowpass)

◆ fHigh()

float AimsFIRFilter::fHigh ( ) const

Return the high cut frequency (bandpass or bandstop)

◆ fLow()

float AimsFIRFilter::fLow ( ) const

Return the low cut frequency (bandpass or bandstop)

◆ fSampling()

float AimsFIRFilter::fSampling ( ) const

Return the sampling frequency.

◆ idealImpulseResponse()

carto::VolumeRef<float> AimsFIRFilter::idealImpulseResponse ( )

protected

Return the ideal impulse response of the F.I.R. filter.

◆ impulseResponse()

carto::VolumeRef<float> AimsFIRFilter::impulseResponse ( )

protected

Return the modified impulse response of the F.I.R. filter.

◆ initialize()

void AimsFIRFilter::initialize ( )

protected

send the process which evaluate the coefficients

◆ kaiserWindow()

carto::VolumeRef<float> AimsFIRFilter::kaiserWindow ( )

protected

Return a Kaiser window.

◆ numberOfFIRFilterCoef()

void AimsFIRFilter::numberOfFIRFilterCoef ( )

protected

Process the number of coefficients.

◆ process()

carto::VolumeRef<float> AimsFIRFilter::process	(	const carto::rc_ptr< carto::Volume< float > > &	data,
		AimsDirectionAxis	dir = `AIMS_X_DIRECTION`
	)

Send a filter processing on a data according to a direction.

Parameters

data	1D/2D/3D or 4D data const reference to process
dir	direction of filtering (AIMS_X_DIRECTION, AIMS_Y_DIRECTION,.)

◆ type()

int AimsFIRFilter::type ( ) const

Return the type of the filter.

Member Data Documentation

◆ _beta

float AimsFIRFilter::_beta

protected

Beta parameter.

Definition at line 94 of file firfilter.h.

◆ _deltaF

float AimsFIRFilter::_deltaF

protected

Frequency resolution.

Definition at line 88 of file firfilter.h.

◆ _deltaP

float AimsFIRFilter::_deltaP

protected

Residual ondulation in pass-band.

Definition at line 90 of file firfilter.h.

◆ _deltaS

float AimsFIRFilter::_deltaS

protected

Residual ondulation in stop-band.

Definition at line 92 of file firfilter.h.

◆ _fCut

float AimsFIRFilter::_fCut

protected

Cut frequency.

Definition at line 82 of file firfilter.h.

◆ _fHigh

float AimsFIRFilter::_fHigh

protected

High cut frequency.

Definition at line 86 of file firfilter.h.

◆ _fLow

float AimsFIRFilter::_fLow

protected

Low cut frequency.

Definition at line 84 of file firfilter.h.

◆ _fSampling

float AimsFIRFilter::_fSampling

protected

Sampling frequency.

Definition at line 80 of file firfilter.h.

◆ _impulseResponse

carto::VolumeRef<float>* AimsFIRFilter::_impulseResponse

protected

Impulse response.

Definition at line 100 of file firfilter.h.

◆ _nCoef

int AimsFIRFilter::_nCoef

protected

Number of coefficients.

Definition at line 98 of file firfilter.h.

◆ _type

int AimsFIRFilter::_type

protected

Type of the filter.

Definition at line 96 of file firfilter.h.

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

aims/signalfilter/firfilter.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AimsFIRFilter() [1/2]

◆ AimsFIRFilter() [2/2]

◆ ~AimsFIRFilter()

Member Function Documentation

◆ deltaF()

◆ deltaP()

◆ deltaS()

◆ fCut()

◆ fHigh()

◆ fLow()

◆ fSampling()

◆ idealImpulseResponse()

◆ impulseResponse()

◆ initialize()

◆ kaiserWindow()

◆ numberOfFIRFilterCoef()

◆ process()

◆ type()

Member Data Documentation

◆ _beta

◆ _deltaF

◆ _deltaP

◆ _deltaS

◆ _fCut

◆ _fHigh

◆ _fLow

◆ _fSampling

◆ _impulseResponse

◆ _nCoef

◆ _type