iufDemodulation.h File Reference

#include <iufTGC.h>
#include <iufFilter.h>

Go to the source code of this file.

Macros
#define	IUDM_INVALID   (iudm_t) NULL

Typedefs
typedef IufDemodulation *	iudm_t

Functions
iudm_t	iufDemodulationCreate (IufDemodulationMethod method, float sampleFrequency, float centerFrequency, int numSamplesPerLine, int numTGCentries, int filterKernelSize)
int	iufDemodulationDelete (iudm_t demodulation)
	Deletes the IufDemodulation and also the TGC function that it might contain. More...
int	iufDemodulationCompare (iudm_t reference, iudm_t actual)
	Compare two demodulation objects with each other, including their TGC function. More...
float	iufDemodulationGetSampleFrequency (iudm_t demodulation)
	Returns the sampleFrequency setting. More...
float	iufDemodulationGetCenterFrequency (iudm_t demodulation)
	Returns the centerFrequency (after demodulation) More...
int	iufDemodulationGetNumSamplesPerLine (iudm_t demodulation)
	Returns the number of samples per line. More...
int	iufDemodulationGetNumTGCentries (iudm_t demodulation)
	Gets the number of [time,gain] paira that the TGC has. More...
int	iufDemodulationGetPreFilterKernelSize (iudm_t demodulation)
	Gets the number of filter coefficients of the preFilter. More...
iutgc_t	iufDemodulationGetTGC (iudm_t demodulation)
	Gets the TGC object of the demodulation. More...
iuff_t	iufDemodulationGetPreFilter (iudm_t demodulation)
	Gets the fir filter object of the demodulation. More...
int	iufDemodulationSetTGC (iudm_t demodulation, iutgc_t tgc)
	set the TGC of IufDemodulation More...
int	iufDemodulationSetPreFilter (iudm_t demodulation, iuff_t preFilter)
	set the TGC of IufDemodulation More...

Macro Definition Documentation

IUDM_INVALID

#define IUDM_INVALID   (iudm_t) NULL

Typedef Documentation

iudm_t

typedef IufDemodulation* iudm_t

Function Documentation

iufDemodulationCompare()

int iufDemodulationCompare	(	iudm_t	reference,
		iudm_t	actual
	)

Compare two demodulation objects with each other, including their TGC function.

Returns

Returns IUF_TRUE when the settings are equal and IUF_FALSE otherwise

Parameters

reference	the receive settings to compare to
actual	the receive settings to compare with

iufDemodulationCreate()

iudm_t iufDemodulationCreate	(	IufDemodulationMethod	method,
		float	sampleFrequency,
		float	centerFrequency,
		int	numSamplesPerLine,
		int	numTGCentries,
		int	filterKernelSize
	)

Parameters

method	The downsampling method
sampleFrequency	The sampling frequency in Hz
centerFrequency	The center frequency in Hz after demodulation
numSamplesPerLine	The number of samples per acquired line
numTGCentries	The size of the TGC function
filterKernelSize	The size of the preFilter

iufDemodulationDelete()

int iufDemodulationDelete

(

iudm_t

demodulation

)

Deletes the IufDemodulation and also the TGC function that it might contain.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE otherwise

Parameters

demodulation

The receive settings of interest.

iufDemodulationGetCenterFrequency()

float iufDemodulationGetCenterFrequency

(

iudm_t

demodulation

)

Returns the centerFrequency (after demodulation)

Returns

The center frequency after demodulation in Hz

Parameters

demodulation

the demodulation of interest

iufDemodulationGetNumSamplesPerLine()

int iufDemodulationGetNumSamplesPerLine

(

iudm_t

demodulation

)

Returns the number of samples per line.

Returns

The number of samples each line has

Parameters

demodulation

the demodulation of interest

iufDemodulationGetNumTGCentries()

int iufDemodulationGetNumTGCentries

(

iudm_t

demodulation

)

Gets the number of [time,gain] paira that the TGC has.

Returns

The number of TGC entries

Parameters

demodulation

the demodulation of interest

iufDemodulationGetPreFilter()

iuff_t iufDemodulationGetPreFilter

(

iudm_t

demodulation

)

Gets the fir filter object of the demodulation.

Returns

the IufFirFilter object

Parameters

demodulation

the demodulation of interest

iufDemodulationGetPreFilterKernelSize()

int iufDemodulationGetPreFilterKernelSize

(

iudm_t

demodulation

)

Gets the number of filter coefficients of the preFilter.

Returns

the number of filter coefficients or -1 in case of an error.

Parameters

demodulation

the demodulation of interest

iufDemodulationGetSampleFrequency()

float iufDemodulationGetSampleFrequency

(

iudm_t

demodulation

)

Returns the sampleFrequency setting.

Returns

The sample frequency in Hz

Parameters

demodulation

the demodulation of interest

iufDemodulationGetTGC()

iutgc_t iufDemodulationGetTGC

(

iudm_t

demodulation

)

Gets the TGC object of the demodulation.

Returns

the IufTGC object

Parameters

demodulation

the demodulation of interest

iufDemodulationSetPreFilter()

int iufDemodulationSetPreFilter	(	iudm_t	demodulation,
		iuff_t	preFilter
	)

set the TGC of IufDemodulation

Returns

Returns IUF_E_OK when successful and IUF_ERR_VALUE otherwise

iufDemodulationSetTGC()

int iufDemodulationSetTGC	(	iudm_t	demodulation,
		iutgc_t	tgc
	)

set the TGC of IufDemodulation

Returns

Returns IUF_E_OK when successful and IUF_ERR_VALUE otherwise