iufIqPatternList.h File Reference

#include <iufIqPattern.h>
#include <iufReceiveChannelMapDict.h>

Go to the source code of this file.

Macros
#define	IUIQPAL_INVALID   (iuiqpal_t) NULL

Typedefs
typedef IufIqPatternList *	iuiqpal_t

Functions
iuiqpal_t	iufIqPatternListCreate (int numPatterns, iudmd_t demodulationDict, iurcmd_t receiveChannelMapDict)
	Create a patternList of size numPattern. Using the IufReceiveSettingsDict and IufReceiveChannelMapDict to set the data dimensions. More...
int	iufIqPatternListDelete (iuiqpal_t list)
	Delete the IQ patternList without deleting the individual patterns. More...
int	iufIqPatternListDeepDelete (iuiqpal_t list)
	Delete the patternList and the individual patterns. More...
int	iufIqPatternListCompare (iuiqpal_t reference, iuiqpal_t actual)
	Compare two IQ patternLists with each other. More...
int	iufIqPatternListGetSize (iuiqpal_t list)
	Get the number of patterns in the list. More...
iuiqpa_t	iufIqPatternListGet (iuiqpal_t list, int index)
	Get the pattern at index from the IufPatternList. More...
int	iufIqPatternListSet (iuiqpal_t list, iuiqpa_t member, int index)
	Set a pattern at index in the IufPatternList. More...

Macro Definition Documentation

IUIQPAL_INVALID

#define IUIQPAL_INVALID   (iuiqpal_t) NULL

Typedef Documentation

iuiqpal_t

typedef IufIqPatternList* iuiqpal_t

The IQ pattern list describes the transmit-receive structure of an acquisition. It contains an array of patterns where a pattern is a reference to a {pulse, source, ReceiveChannelMap, apodization, demodulation} tuple, defined at a certain timestamp. Since we restrict ourselves to a rectangular memory alignment, not all combinations of arbitrary settings are possible, i.e. during an acquistion of an IufPatternList sequence the numSamplesPerLine, numChannels and numPulses need to remain constant over the frames. To guarantee that, the receiveSettings and receiveChannelMap (dictionaries) need to be known during the creation of a IufPatternList.

Function Documentation

iufIqPatternListCompare()

int iufIqPatternListCompare	(	iuiqpal_t	reference,
		iuiqpal_t	actual
	)

Compare two IQ patternLists with each other.

Returns

Returns IUF_TRUE when the patterns lists are equal and IUF_FALSE otherwise.

Parameters

reference	The IufPatternList to compare to
actual	The IufPatternList to compare with

iufIqPatternListCreate()

iuiqpal_t iufIqPatternListCreate	(	int	numPatterns,
		iudmd_t	demodulationDict,
		iurcmd_t	receiveChannelMapDict
	)

Create a patternList of size numPattern. Using the IufReceiveSettingsDict and IufReceiveChannelMapDict to set the data dimensions.

Returns

Returns an empty list for numPattern patterns, or IUPAL_INVALID in case of an error.

Parameters

numPatterns	The number of patterns that will be in the list
demodulationDict	The demodulation dictionary
receiveChannelMapDict	The receiveChannelMap dictionary

iufIqPatternListDeepDelete()

int iufIqPatternListDeepDelete

(

iuiqpal_t

list

)

Delete the patternList and the individual patterns.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE otherwise.

Parameters

list	The IufPatternList of interest.

iufIqPatternListDelete()

int iufIqPatternListDelete

(

iuiqpal_t

list

)

Delete the IQ patternList without deleting the individual patterns.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE in case of an invalid list.

Parameters

list	The IufPatternList of interest.

iufIqPatternListGet()

iuiqpa_t iufIqPatternListGet	(	iuiqpal_t	list,
		int	index
	)

Get the pattern at index from the IufPatternList.

Returns

Returns the IufPattern in case of success or IUPAL_INVALID in case of an error.

Parameters

list	The IufIqPatternList of interest
index	the pattern index

iufIqPatternListGetSize()

int iufIqPatternListGetSize

(

iuiqpal_t

list

)

Get the number of patterns in the list.

Returns

Returns the numPattern or -1 in case of an invalid argument.

Parameters

list	The IufPatternList

iufIqPatternListSet()

int iufIqPatternListSet	(	iuiqpal_t	list,
		iuiqpa_t	member,
		int	index
	)

Set a pattern at index in the IufPatternList.

Returns

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

Parameters

list	The IufIqPatternList of interest
member	the IufIqPattern
index	THe loction of the IufPattern