iufPatternList.h File Reference

#include <iufPattern.h>
#include <iufReceiveSettingsDict.h>
#include <iufReceiveChannelMapDict.h>

Go to the source code of this file.

Macros
#define	IUPAL_INVALID   (iupal_t) NULL

Typedefs
typedef IufPatternList *	iupal_t

Functions
iupal_t	iufPatternListCreate (int numPatterns, iursd_t receiveSettingsDict, iurcmd_t receiveChannelMapDict)
	Create a patternList of size numPattern. Using the IufReceiveSettingsDict and IufReceiveChannelMapDict to set the data dimensions. More...
int	iufPatternListDelete (iupal_t list)
	Delete the patternList without deleting the individual patterns. More...
int	iufPatternListDeepDelete (iupal_t list)
	Delete the patternList and the individual patterns. More...
int	iufPatternListCompare (iupal_t reference, iupal_t actual)
	Compare two patternLists with each other. More...
int	iufPatternListGetSize (iupal_t list)
	Get the number of patterns in the list. More...
iupa_t	iufPatternListGet (iupal_t list, int index)
	Get the pattern at index from the IufPatternList. More...
int	iufPatternListSet (iupal_t list, iupa_t member, int index)
	Set a pattern at index in the IufPatternList. More...

Macro Definition Documentation

IUPAL_INVALID

#define IUPAL_INVALID   (iupal_t) NULL

Typedef Documentation

iupal_t

typedef IufPatternList* iupal_t

The 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, receiveSettings} 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

iufPatternListCompare()

int iufPatternListCompare	(	iupal_t	reference,
		iupal_t	actual
	)

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

iufPatternListCreate()

iupal_t iufPatternListCreate	(	int	numPatterns,
		iursd_t	receiveSettingsDict,
		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
receiveSettingsDict	The receiveSettings dictionary
receiveChannelMapDict	The receiveChannelMap dictionary

iufPatternListDeepDelete()

int iufPatternListDeepDelete

(

iupal_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.

iufPatternListDelete()

int iufPatternListDelete

(

iupal_t

list

)

Delete the 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.

iufPatternListGet()

iupa_t iufPatternListGet	(	iupal_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 IufPatternList of interest
index	the pattern index

iufPatternListGetSize()

int iufPatternListGetSize

(

iupal_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

iufPatternListSet()

int iufPatternListSet	(	iupal_t	list,
		iupa_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 IufPatternList of interest
member	the IufPattern
index	THe loction of the IufPattern