iufFilter.h File Reference

Go to the source code of this file.

Macros
#define	IUF_PATH_FIRFILTER_KERNELSIZE   "KernelSize"
#define	IUF_PATH_FIRFILTER_COEFFICIENTS   "Coefficients"
#define	IUFIRFILTER_INVALID   (iuff_t) NULL

Typedefs
typedef IufFirFilter *	iuff_t

Functions
iuff_t	iufFirFilterCreate (int kernelSize)
	Create a FIR filter with n,m coefficients of kernelSize values. More...
int	iufFirFilterDelete (iuff_t filter)
	Frees the memory of the FirFilter object. More...
int	iufFirFilterCompare (iuff_t reference, iuff_t actual)
	Checks if two FirFilters are equal. More...
int	iufFirFilterGetKernelSize (iuff_t filter)
	Get the number of filter coefficients that the FirFilter has. More...
float	iufFirFilterGetCoefficient (iuff_t filter, int index)
	Get the gain value of a point in the TGC function at index. More...
int	iufFirFilterSetCoefficient (iuff_t filter, int index, float coefficient)
	Set a Filter COefficient at index. More...

Macro Definition Documentation

IUF_PATH_FIRFILTER_COEFFICIENTS

#define IUF_PATH_FIRFILTER_COEFFICIENTS   "Coefficients"

IUF_PATH_FIRFILTER_KERNELSIZE

#define IUF_PATH_FIRFILTER_KERNELSIZE   "KernelSize"

IUFIRFILTER_INVALID

#define IUFIRFILTER_INVALID   (iuff_t) NULL

Typedef Documentation

iuff_t

typedef IufFirFilter* iuff_t

A FIRFilter is described by kernelSize of filter coefficients.

Function Documentation

iufFirFilterCompare()

int iufFirFilterCompare	(	iuff_t	reference,
		iuff_t	actual
	)

Checks if two FirFilters are equal.

Returns

Returns IUF_TRUE if the filters are equal and IUF_FALSE otherwise

Parameters

reference	The FirFilter object to compare to
actual	The FirFilter object to compare with

iufFirFilterCreate()

iuff_t iufFirFilterCreate

(

int

kernelSize

)

Create a FIR filter with n,m coefficients of kernelSize values.

Returns

Returns the created coefficient array or NULL in case of a failure

Parameters

kernelSize

The number of filter coefficients

iufFirFilterDelete()

int iufFirFilterDelete

(

iuff_t

filter

)

Frees the memory of the FirFilter object.

Returns

Returns the created FirFilter object or NULL in case of a failure

Parameters

filter

The object to delete

iufFirFilterGetCoefficient()

float iufFirFilterGetCoefficient	(	iuff_t	filter,
		int	index
	)

Get the gain value of a point in the TGC function at index.

Returns

The gain value

Parameters

filter	The FirFilter object of interest
index	The index of the kernel

iufFirFilterGetKernelSize()

int iufFirFilterGetKernelSize

(

iuff_t

filter

)

Get the number of filter coefficients that the FirFilter has.

Returns

Returns the number of filter coefficients

Parameters

filter

The FirFilter object of interest

iufFirFilterSetCoefficient()

int iufFirFilterSetCoefficient	(	iuff_t	filter,
		int	index,
		float	coefficient
	)

Set a Filter COefficient at index.

Returns

Returns IUF_E_OK in case of success or IUF_ERR_VALUE in case of an error

Parameters

filter	The FirFilter of interest
index	The index of the kernel
coefficient	The filter coefficient value