iufPattern.h File Reference

Go to the source code of this file.

Macros
#define	IUPA_INVALID   (iupa_t) NULL

Typedefs
typedef IufPattern *	iupa_t

Functions
iupa_t	iufPatternCreate (float timeInFrame, const char *pPulseLabel, const char *pSourceLabel, const char *pChannelMapLabel, const char *pApodizationLabel, const char *pReceiveSettingsLabel)
	create a pattern at time timeInFrame using labels to reference a pulse, source, channelMap, apodization and receiveSettings respectively More...
int	iufPatternDelete (iupa_t pattern)
	Delete a pattern. More...
int	iufPatternCompare (iupa_t reference, iupa_t actual)
	Compare two patterns with each other. More...
const char *	iufPatternGetPulseLabel (iupa_t pattern)
	Get the pulse label of the IufPattern. More...
const char *	iufPatternGetSourceLabel (iupa_t pattern)
	Get the source label of the IufPattern. More...
const char *	iufPatternGetChannelMapLabel (iupa_t pattern)
	Get the receiveChannelMap label of the IufPattern. More...
const char *	iufPatternGetApodizationLabel (iupa_t pattern)
	Get the apodization label of the IufPattern. More...
const char *	iufPatternGetReceivesettingsLabel (iupa_t pattern)
	Get the receiveSettings label of the IufPattern. More...
float	iufPatternGetTimeInFrame (iupa_t pattern)
	Get the time of the IufPattern in the frame. More...

Macro Definition Documentation

IUPA_INVALID

#define IUPA_INVALID   (iupa_t) NULL

Typedef Documentation

iupa_t

typedef IufPattern* iupa_t

A pattern is the combinding structure for the transmit and receive of an ultrasound pulse at a certain time in a frame. It references a pulse, source, channelmap, transmit apodization and receive settings using a label to their respective dictionaries that are typically part of e.g. the IufInputFile structure.

Function Documentation

iufPatternCompare()

int iufPatternCompare	(	iupa_t	reference,
		iupa_t	actual
	)

Compare two patterns with each other.

Returns

Returns IUF_TRUE when the patterns are equal and IUF_FALSE otherwise.

Parameters

reference	The IufPattern to compare to
actual	The IufPattern to compare with

iufPatternCreate()

iupa_t iufPatternCreate	(	float	timeInFrame,
		const char *	pPulseLabel,
		const char *	pSourceLabel,
		const char *	pChannelMapLabel,
		const char *	pApodizationLabel,
		const char *	pReceiveSettingsLabel
	)

create a pattern at time timeInFrame using labels to reference a pulse, source, channelMap, apodization and receiveSettings respectively

Returns

Returns the created IufPattern or IUPA_INVALID in case of an error.

Parameters

timeInFrame	relative time (s) in a frame
pPulseLabel	the name of the pulse
pSourceLabel	the name of the source
pChannelMapLabel	the name of the channelMap
pApodizationLabel	the name of the apodization
pReceiveSettingsLabel	the name of the receiveSettings

iufPatternDelete()

int iufPatternDelete

(

iupa_t

pattern

)

Delete a pattern.

Returns

Returns IUF_E_OK in case of success and IUF_ERR_VALUE in case of an error.

Parameters

pattern

The IufPattern of interest

iufPatternGetApodizationLabel()

const char* iufPatternGetApodizationLabel

(

iupa_t

pattern

)

Get the apodization label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

pattern

The IufPattern of interest

iufPatternGetChannelMapLabel()

const char* iufPatternGetChannelMapLabel

(

iupa_t

pattern

)

Get the receiveChannelMap label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

pattern

The IufPattern of interest

iufPatternGetPulseLabel()

const char* iufPatternGetPulseLabel

(

iupa_t

pattern

)

Get the pulse label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

pattern

The IufPattern of interest

iufPatternGetReceivesettingsLabel()

const char* iufPatternGetReceivesettingsLabel

(

iupa_t

pattern

)

Get the receiveSettings label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

pattern

The IufPattern of interest

iufPatternGetSourceLabel()

const char* iufPatternGetSourceLabel

(

iupa_t

pattern

)

Get the source label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

pattern

The IufPattern of interest

iufPatternGetTimeInFrame()

float iufPatternGetTimeInFrame

(

iupa_t

pattern

)

Get the time of the IufPattern in the frame.

Returns

Returns the timestamp of the pattern in seconds or NAN in case of an error.

Parameters

pattern

The IufPattern of interest