A.I.M.S algorithms


AimsFIRFilter Class Reference

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

#include <aims/signalfilter/firfilter.h>

Collaboration diagram for AimsFIRFilter:

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...
 
AimsData< float > process (const AimsData< 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...
 
AimsData< float > kaiserWindow ()
 Return a Kaiser window. More...
 
AimsData< float > idealImpulseResponse ()
 Return the ideal impulse response of the F.I.R. filter. More...
 
AimsData< 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

Data
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...
 
AimsData< float > * _impulseResponse
 Impulse response. More...
 

Detailed Description

The class of Finite Impulse Response filters.

Definition at line 73 of file firfilter.h.

Constructor & Destructor Documentation

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

Constructor dedicated to lowpass filters or highpass filters.

Parameters
fssampling frequency
fccutting frequency
deltaffrequency resolution or step
deltapresidual ripple in pass band
deltasresidual ripple in stop band
typetype of the FIR filter (AIMS_FIR_LOWPASS,AIMS_FIR_HIGHPASS)
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
fssampling frequency
fllower cutting frequency
fhhigher cutting frequency
deltaffrequency resolution or step
deltapresidual ripple in pass band
deltasresidual ripple in stop band
typetype of the FIR filter (AIMS_FIR_BANDPASS,AIMS_FIR_BANDSTOP)
virtual AimsFIRFilter::~AimsFIRFilter ( )
virtual

Destructor free the impulse response.

Member Function Documentation

float AimsFIRFilter::deltaF ( ) const

Return the frequency step.

float AimsFIRFilter::deltaP ( ) const

Return the passband ripple.

float AimsFIRFilter::deltaS ( ) const

Return the stopband ripple.

float AimsFIRFilter::fCut ( ) const

Return the cut frequency (highpass or lowpass)

float AimsFIRFilter::fHigh ( ) const

Return the high cut frequency (bandpass or bandstop)

float AimsFIRFilter::fLow ( ) const

Return the low cut frequency (bandpass or bandstop)

float AimsFIRFilter::fSampling ( ) const

Return the sampling frequency.

AimsData<float> AimsFIRFilter::idealImpulseResponse ( )
protected

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

AimsData<float> AimsFIRFilter::impulseResponse ( )
protected

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

void AimsFIRFilter::initialize ( )
protected

send the process which evaluate the coefficients

AimsData<float> AimsFIRFilter::kaiserWindow ( )
protected

Return a Kaiser window.

void AimsFIRFilter::numberOfFIRFilterCoef ( )
protected

Process the number of coefficients.

AimsData<float> AimsFIRFilter::process ( const AimsData< float > &  data,
AimsDirectionAxis  dir = AIMS_X_DIRECTION 
)

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

Parameters
data1D/2D/3D or 4D data const reference to process
dirdirection of filtering (AIMS_X_DIRECTION, AIMS_Y_DIRECTION,.)
int AimsFIRFilter::type ( ) const

Return the type of the filter.

Member Data Documentation

float AimsFIRFilter::_beta
protected

Beta parameter.

Definition at line 92 of file firfilter.h.

float AimsFIRFilter::_deltaF
protected

Frequency resolution.

Definition at line 86 of file firfilter.h.

float AimsFIRFilter::_deltaP
protected

Residual ondulation in pass-band.

Definition at line 88 of file firfilter.h.

float AimsFIRFilter::_deltaS
protected

Residual ondulation in stop-band.

Definition at line 90 of file firfilter.h.

float AimsFIRFilter::_fCut
protected

Cut frequency.

Definition at line 80 of file firfilter.h.

float AimsFIRFilter::_fHigh
protected

High cut frequency.

Definition at line 84 of file firfilter.h.

float AimsFIRFilter::_fLow
protected

Low cut frequency.

Definition at line 82 of file firfilter.h.

float AimsFIRFilter::_fSampling
protected

Sampling frequency.

Definition at line 78 of file firfilter.h.

AimsData<float>* AimsFIRFilter::_impulseResponse
protected

Impulse response.

Definition at line 98 of file firfilter.h.

int AimsFIRFilter::_nCoef
protected

Number of coefficients.

Definition at line 96 of file firfilter.h.

int AimsFIRFilter::_type
protected

Type of the filter.

Definition at line 94 of file firfilter.h.


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