iuf3DTransducer.h File Reference

#include <iuf3DTransducerElement.h>
#include <iufHDF5.h>

Go to the source code of this file.

Macros
#define	IU3DT_INVALID   (iu3dt_t) NULL

Typedefs
typedef Iuf3DTransducer *	iu3dt_t
	A 3D transducer is described by a name, 3D shape, centerfrequency and a list of elements. A transducer is created first by specifying these parameters with a call to iuf2DTransducerCreate(), followed by setting each of the elements using calls to iuf2DTransducerSetElement() More...

Functions
iu3dt_t	iuf3DTransducerCreate (char *name, IufTransducerShape shape, float centerFrequency, int numElements)
	Constructs the 3D transducer. More...
int	iuf3DTransducerDelete (iu3dt_t transducer)
	Deletes the 3D transducer without deleting the elements. More...
int	iuf3DTransducerDeepDelete (iu3dt_t transducer)
	Deletes the 3D transducer including the deletion of its elements. More...
int	iuf3DTransducerCompare (iu3dt_t reference, iu3dt_t actual)
	Comparing two transducers, return IUF_TRUE if they are equal and IUF_FALSE if they differ or in case of an error. The order of the arguments does no matter. More...
iu3dte_t	iuf3DTransducerGetElement (iu3dt_t transducer, int index)
	Return the elemntIndex -th transducer element from the transducer's element list. /return the requested 3D element from the transducer's element list. More...
int	iuf3DTransducerGetNumElements (iu3dt_t transducer)
	Gets the length of the transducer's element list. /return the size of the element list. More...
int	iuf3DTransducerSetElement (iu3dt_t transducer, int elementIndex, iu3dte_t element)
	Set a element in the transducer's element list at position elementIndex /return IUF_ERR_VALUE is case the element can not be set or IUF_E_OK in case of success. More...

Macro Definition Documentation

IU3DT_INVALID

#define IU3DT_INVALID   (iu3dt_t) NULL

Typedef Documentation

iu3dt_t

typedef Iuf3DTransducer* iu3dt_t

A 3D transducer is described by a name, 3D shape, centerfrequency and a list of elements. A transducer is created first by specifying these parameters with a call to iuf2DTransducerCreate(), followed by setting each of the elements using calls to iuf2DTransducerSetElement()

Function Documentation

iuf3DTransducerCompare()

int iuf3DTransducerCompare	(	iu3dt_t	reference,
		iu3dt_t	actual
	)

Comparing two transducers, return IUF_TRUE if they are equal and IUF_FALSE if they differ or in case of an error. The order of the arguments does no matter.

Parameters

reference	the 3D transducer to compare to
actual	the 3D transducer to compare with

iuf3DTransducerCreate()

iu3dt_t iuf3DTransducerCreate	(	char *	name,
		IufTransducerShape	shape,
		float	centerFrequency,
		int	numElements
	)

Constructs the 3D transducer.

Returns

Returns an allocated 3D tansducer, with uninitialized elements

Parameters

name	The name (label) of the transducer
shape	The 3D shape of the transducer: should be a IUF_PLANE, IUF_CYLINDER, or IUF_SPHERE.
centerFrequency	///< The operating frequency the transducer
numElements	The number of transducer elements this transducer has

iuf3DTransducerDeepDelete()

int iuf3DTransducerDeepDelete

(

iu3dt_t

transducer

)

Deletes the 3D transducer including the deletion of its elements.

Returns

Returns IUF_E_OK if the object could be deleted or IUF_ERR_VALUE in case this failed.

Parameters

transducer

The 3D transducer object that will be deleted

iuf3DTransducerDelete()

int iuf3DTransducerDelete

(

iu3dt_t

transducer

)

Deletes the 3D transducer without deleting the elements.

Returns

Returns IUF_E_OK if the object could be deleted or IUF_ERR_VALUE in case this failed.

Parameters

transducer

The 3D transducer object that will be deleted

iuf3DTransducerGetElement()

iu3dte_t iuf3DTransducerGetElement	(	iu3dt_t	transducer,
		int	index
	)

Return the elemntIndex -th transducer element from the transducer's element list. /return the requested 3D element from the transducer's element list.

Parameters

transducer	The 3D transducer of interest
index	The index of the element that is requested

iuf3DTransducerGetNumElements()

int iuf3DTransducerGetNumElements

(

iu3dt_t

transducer

)

Gets the length of the transducer's element list. /return the size of the element list.

Parameters

transducer

The transducer of interest

iuf3DTransducerSetElement()

int iuf3DTransducerSetElement	(	iu3dt_t	transducer,
		int	elementIndex,
		iu3dte_t	element
	)

Set a element in the transducer's element list at position elementIndex /return IUF_ERR_VALUE is case the element can not be set or IUF_E_OK in case of success.

Parameters

transducer	the transducer element
elementIndex	the position in the element list
element	the transducer element to be set