iufReceiveSettings.h File Reference

#include <iufTGC.h>

Go to the source code of this file.

Macros
#define	IURS_INVALID   (iurs_t) NULL

Typedefs
typedef IufReceiveSettings *	iurs_t

Functions
iurs_t	iufReceiveSettingsCreate (float sampleFrequency, int numSamplesPerLine, int numTGCentries)
int	iufReceiveSettingsDelete (iurs_t receiveSettings)
	Deletes the IufReceiveSettings and also the TGC function that it might contain. More...
int	iufReceiveSettingsCompare (iurs_t reference, iurs_t actual)
	Compare two receive settings with each other, including their TGC function. More...
float	iufReceiveSettingsGetSampleFrequency (iurs_t receiveSettings)
	Returns the sampleFrequency setting. More...
int	iufReceiveSettingsGetNumSamplesPerLine (iurs_t receiveSettings)
	Returns the number of samples per line. More...
int	iufReceiveSettingsGetNumTGCentries (iurs_t receiveSettings)
	Gets the number of [time,gain] paira that the TGC has. More...
iutgc_t	iufReceiveSettingsGetTGC (iurs_t receiveSettings)
	Gets the TGC object of the receive settings. More...

Macro Definition Documentation

IURS_INVALID

#define IURS_INVALID   (iurs_t) NULL

Typedef Documentation

iurs_t

typedef IufReceiveSettings* iurs_t

The receive settings contain the digitization settings of a transducer's data acquisition. It contains the sample frequency and the number of samples that are taken each line and the TGC info. Typically, constructing this object is part of the setup of an IufInputFile. Start by creating a iufReceiveSettings object using iufReceiveSettingsCreate() and use the iufTGCSet() function to add the TGC function. Typically the constructed setting is added to an IufReceiveSettingsDict, which is part of the IufInputFile instance.

Function Documentation

iufReceiveSettingsCompare()

int iufReceiveSettingsCompare	(	iurs_t	reference,
		iurs_t	actual
	)

Compare two receive settings 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

iufReceiveSettingsCreate()

iurs_t iufReceiveSettingsCreate	(	float	sampleFrequency,
		int	numSamplesPerLine,
		int	numTGCentries
	)

Parameters

sampleFrequency	The sampling frequency in Hz
numSamplesPerLine	The number of samples per acquired line
numTGCentries	The size of the TGC function

iufReceiveSettingsDelete()

int iufReceiveSettingsDelete

(

iurs_t

receiveSettings

)

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

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE otherwise

Parameters

receiveSettings

The receive settings of interest.

iufReceiveSettingsGetNumSamplesPerLine()

int iufReceiveSettingsGetNumSamplesPerLine

(

iurs_t

receiveSettings

)

Returns the number of samples per line.

Returns

The number of samples each line has

Parameters

receiveSettings

the receive settings of interest

iufReceiveSettingsGetNumTGCentries()

int iufReceiveSettingsGetNumTGCentries

(

iurs_t

receiveSettings

)

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

Returns

The number of TGC entries

Parameters

receiveSettings

the receive settings of interest

iufReceiveSettingsGetSampleFrequency()

float iufReceiveSettingsGetSampleFrequency

(

iurs_t

receiveSettings

)

Returns the sampleFrequency setting.

Returns

The sample frequency in Hz

Parameters

receiveSettings

the receive settings of interest

iufReceiveSettingsGetTGC()

iutgc_t iufReceiveSettingsGetTGC

(

iurs_t

receiveSettings

)

Gets the TGC object of the receive settings.

Returns

the IufTGC object

Parameters

receiveSettings

the receive settings of interest