Macros
#define	IUIQPA_INVALID (iuiqpa_t) NULL

Typedefs
typedef IufIqPattern *	iuiqpa_t

Functions
iuiqpa_t	iufIqPatternCreate (float timeInFrame, const char pPulseLabel, const char pSourceLabel, const char pChannelMapLabel, const char pApodizationLabel, const char *pDemodulationLabel)
	create a pattern at time `timeInFrame` using labels to reference a pulse, source, channelMap, apodization and receiveSettings respectively More...

int	iufIqPatternDelete (iuiqpa_t iufIqPattern)
	Delete a pattern. More...

int	iufIqPatternCompare (iuiqpa_t reference, iuiqpa_t actual)
	Compare two patterns with each other. More...

const char *	iufIqPatternGetPulseLabel (iuiqpa_t iufIqPattern)
	Get the pulse label of the IufPattern. More...

const char *	iufIqPatternGetSourceLabel (iuiqpa_t iufIqPattern)
	Get the source label of the IufPattern. More...

const char *	iufIqPatternGetChannelMapLabel (iuiqpa_t iufIqPattern)
	Get the receiveChannelMap label of the IufPattern. More...

const char *	iufIqPatternGetApodizationLabel (iuiqpa_t iufIqPattern)
	Get the apodization label of the IufPattern. More...

const char *	iufIqPatternGetDemodulationLabel (iuiqpa_t iufIqPattern)
	Get the receiveSettings label of the IufPattern. More...

float	iufIqPatternGetTimeInFrame (iuiqpa_t iufIqPattern)
	Get the time of the IufPattern in the frame. More...

Macro Definition Documentation

◆ IUIQPA_INVALID

#define IUIQPA_INVALID (iuiqpa_t) NULL

Typedef Documentation

◆ iuiqpa_t

typedef IufIqPattern* iuiqpa_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

◆ iufIqPatternCompare()

int iufIqPatternCompare	(	iuiqpa_t	reference,
		iuiqpa_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

◆ iufIqPatternCreate()

iuiqpa_t iufIqPatternCreate	(	float	timeInFrame,
		const char *	pPulseLabel,
		const char *	pSourceLabel,
		const char *	pChannelMapLabel,
		const char *	pApodizationLabel,
		const char *	pDemodulationLabel
	)

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
pDemodulationLabel	the name of the receiveSettings

◆ iufIqPatternDelete()

int iufIqPatternDelete ( iuiqpa_t iufIqPattern )

Delete a pattern.

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

Parameters