iufTransmitApodizationDict.h File Reference

#include <stdio.h>
#include <iufTransmitApodization.h>

Go to the source code of this file.

Macros
#define	IUTAD_INVALID   (iutad_t) NULL

Typedefs
typedef IufTransmitApodizationDict *	iutad_t
	A transmit apodization is a weighting function of the amplitudes of the transducer elements. This is a dictionary of these functions. More...

Functions
iutad_t	iufTransmitApodizationDictCreate (void)
	Creates a IufTransmitApodizationDict. More...
int	iufTransmitApodizationDictDelete (iutad_t dict)
	Deletes the IufTransmitApodizationDict object without deleting each IufTransmitApodization separately. More...
int	iufTransmitApodizationDictDeepDelete (iutad_t dict)
	Deletes a IufTransmitApodizationDict object and all its IufTransmitApodization s. More...
int	iufTransmitApodizationDictCompare (iutad_t reference, iutad_t actual)
	Compares if two IufTransmitApodizationDict objects are equal. More...
size_t	iufTransmitApodizationDictGetSize (iutad_t dict)
	Get the number of IufTransmitApodization objects in the dictionary. More...
iuta_t	iufTransmitApodizationDictGet (iutad_t dict, char *key)
	Get the IufTransmitApodization with the label key from the dict. More...
char **	iufTransmitApodizationDictGetKeys (iutad_t dict)
	Get the keys currently available in the dict. More...
int	iufTransmitApodizationDictSet (iutad_t dict, char *key, iuta_t member)
	Add a IufTransmitApodization with the label key to the dict. More...

Macro Definition Documentation

IUTAD_INVALID

#define IUTAD_INVALID   (iutad_t) NULL

Typedef Documentation

iutad_t

typedef IufTransmitApodizationDict* iutad_t

A transmit apodization is a weighting function of the amplitudes of the transducer elements. This is a dictionary of these functions.

Function Documentation

iufTransmitApodizationDictCompare()

int iufTransmitApodizationDictCompare	(	iutad_t	reference,
		iutad_t	actual
	)

Compares if two IufTransmitApodizationDict objects are equal.

Returns

returns IUF_TRUE if the objects are equal and IUF_FALSE if they differ. The order of the arguments doesn't matter

Parameters

reference	the IufTransmitApodizationDict to compare to
actual	the IufTransmitApodizationDict to compare with

iufTransmitApodizationDictCreate()

iutad_t iufTransmitApodizationDictCreate

(

void

)

Creates a IufTransmitApodizationDict.

Returns

Returns an allocated empty IufTransmitApodizationDict

iufTransmitApodizationDictDeepDelete()

int iufTransmitApodizationDictDeepDelete

(

iutad_t

dict

)

Deletes a IufTransmitApodizationDict object and all its IufTransmitApodization s.

Returns

returns IUF_TRUE if the dictionary could be deleted or IUF_ERR_VALUE if the dictionary was invalid

Parameters

dict	The IufTransmitApodizationDict that is to be deleted

iufTransmitApodizationDictDelete()

int iufTransmitApodizationDictDelete

(

iutad_t

dict

)

Deletes the IufTransmitApodizationDict object without deleting each IufTransmitApodization separately.

Returns

returns IUF_TRUE if the dictionary could be deleted or IUF_ERR_VALUE if the dictionary was invalid

Parameters

dict	The IufTransmitApodizationDict that is to be deleted

iufTransmitApodizationDictGet()

iuta_t iufTransmitApodizationDictGet	(	iutad_t	dict,
		char *	key
	)

Get the IufTransmitApodization with the label key from the dict.

Returns

requested IufTransmitApodization or NULL in case of an error.

Parameters

dict	the IufTransmitApodizationDict of interest
key	the label of the IufTransmitApodization

iufTransmitApodizationDictGetKeys()

char** iufTransmitApodizationDictGetKeys

(

iutad_t

dict

)

Get the keys currently available in the dict.

Returns

array (with size iufTransmitApodizationDictGetSize) of keys.

Parameters

dict	the IufTransmitApodizationDict of interest

iufTransmitApodizationDictGetSize()

size_t iufTransmitApodizationDictGetSize

(

iutad_t

dict

)

Get the number of IufTransmitApodization objects in the dictionary.

Returns

the number of IufTransmitApodization objects.

Parameters

dict	the IufTransmitApodizationDict of interest

iufTransmitApodizationDictSet()

int iufTransmitApodizationDictSet	(	iutad_t	dict,
		char *	key,
		iuta_t	member
	)

Add a IufTransmitApodization with the label key to the dict.

Returns

IUF_E_OK if the IufTransmitApodization could be added or IUF_ERR_VALUE in case of an error.

Parameters

dict	the IufTransmitApodizationDict that receives a new IufTransmitApodization
key	the label of the IufTransmitApodization
member	the IufTransmitApodization that is added