iuf2DTransducerElement.h File Reference

#include <iuf2DSize.h>
#include <iufPosition.h>
#include <iufTransducer.h>

Go to the source code of this file.

Macros
#define	IU2DTE_INVALID   (iu2dte_t) NULL

Typedefs
typedef Iuf2DTransducerElement *	iu2dte_t
	A 2D transducer element describes a physical ultasound element. In 2D space such an element is described by a 2D size at a 2D position under a single angle theta.Typically, a transducer has a list of these elements. Elements are created first with iuf2DTransducerElementCreate(), and then added to a list using iuf2DTransducerSetElement() More...

Functions
iu2dte_t	iuf2DTransducerElementCreate (iu2dp_t pos, float theta, iu2ds_t size)
	Creates a 2D transducer element that is decribed by a 2D position, an angle theta and a 2D size. More...
int	iuf2DTransducerElementDeepDelete (iu2dte_t element)
	Removes the 2D element object an its sub-objects. More...
int	iuf2DTransducerElementDelete (iu2dte_t element)
	Removes the 2D element object without deleting the position and size sub-objects. More...
int	iuf2DTransducerElementCompare (iu2dte_t reference, iu2dte_t actual)
	Compares the values of 2 transducer elements. the order of the arguments don't matter. More...
iu2dp_t	iuf2DTransducerElementGetPosition (iu2dte_t element)
	returns the 2D position of the iuf2DTransducerElement. More...
float	iuf2DTransducerElementGetAngle (iu2dte_t element)
	returns the angle of the iuf2DTransducerElement. More...
iu2ds_t	iuf2DTransducerElementGetSize (iu2dte_t element)
	returns the 2D size of the iuf2DTransducerElement. More...

Macro Definition Documentation

IU2DTE_INVALID

#define IU2DTE_INVALID   (iu2dte_t) NULL

Typedef Documentation

iu2dte_t

typedef Iuf2DTransducerElement* iu2dte_t

A 2D transducer element describes a physical ultasound element. In 2D space such an element is described by a 2D size at a 2D position under a single angle theta.Typically, a transducer has a list of these elements. Elements are created first with iuf2DTransducerElementCreate(), and then added to a list using iuf2DTransducerSetElement()

Function Documentation

iuf2DTransducerElementCompare()

int iuf2DTransducerElementCompare	(	iu2dte_t	reference,
		iu2dte_t	actual
	)

Compares the values of 2 transducer elements. the order of the arguments don't matter.

Returns

IUF_FALSE in case the elements are different and IUF_TRUE when the element are identical.

Parameters

reference	the transducer element to be compared
actual	the transducer element that is compared

iuf2DTransducerElementCreate()

iu2dte_t iuf2DTransducerElementCreate	(	iu2dp_t	pos,
		float	theta,
		iu2ds_t	size
	)

Creates a 2D transducer element that is decribed by a 2D position, an angle theta and a 2D size.

Returns

returns the created element or IU2DTE_INVALID in case of invalid parameters.

Parameters

pos	the 2D position (x,z) in meters
theta	the angle over the y-axis in radians of the element
size	the size (sx,sz) in meters of the element

iuf2DTransducerElementDeepDelete()

int iuf2DTransducerElementDeepDelete

(

iu2dte_t

element

)

Removes the 2D element object an its sub-objects.

Returns

IUF_ERR_VALUE in case something went wrong or IUF_TRUE when the element has been successfully deleted.

iuf2DTransducerElementDelete()

int iuf2DTransducerElementDelete

(

iu2dte_t

element

)

Removes the 2D element object without deleting the position and size sub-objects.

Returns

IUF_ERR_VALUE in case something went wrong or IUF_TRUE when the element has been successfully deleted.

iuf2DTransducerElementGetAngle()

float iuf2DTransducerElementGetAngle

(

iu2dte_t

element

)

returns the angle of the iuf2DTransducerElement.

Returns

the angle of the iuf2DTransducerElement (theta) in radians.

Parameters

element

the element of interest

iuf2DTransducerElementGetPosition()

iu2dp_t iuf2DTransducerElementGetPosition

(

iu2dte_t

element

)

returns the 2D position of the iuf2DTransducerElement.

Returns

the 2D position of the iuf2DTransducerElement (x,z) in meters.

Parameters

element

the element of interest

iuf2DTransducerElementGetSize()

iu2ds_t iuf2DTransducerElementGetSize

(

iu2dte_t

element

)

returns the 2D size of the iuf2DTransducerElement.

Returns

the 2D size of the iuf2DTransducerElement (sx,sz) in meters.

Parameters

element

the element of interest