iufTransmitApodization.h File Reference

#include <iufTypes.h>

Go to the source code of this file.

Macros
#define	IUTA_INVALID   (iuta_t) NULL

Typedefs
typedef IufTransmitApodization *	iuta_t

Functions
iuta_t	iufTransmitApodizationCreate (float *apodization, int numElements)
	Construct an IufTransmitApodization of size numElements. More...
int	iufTransmitApodizationDelete (iuta_t transmitApodization)
	Delete a IufTransmitApodization of size numElements. More...
IUF_BOOL	iufTransmitApodizationCompare (iuta_t reference, iuta_t actual)
	Compare two IufTransmitApodization objects with each other. More...
float	iufTransmitApodizationGetElement (iuta_t transmitApodization, int idx)
	Get a single value from the transmit apodization function. More...
int	iufTransmitApodizationGetNumElements (iuta_t transmitApodization)
	Get the number of ekements that the transducer has. More...
int	iufTransmitApodizationSetElement (iuta_t transmitApodization, int idx, float attenuation)
	Set the value of a single elements of the transmit apodization function at index idx. More...

Macro Definition Documentation

IUTA_INVALID

#define IUTA_INVALID   (iuta_t) NULL

Typedef Documentation

iuta_t

typedef IufTransmitApodization* iuta_t

a transmit apodization describes an attenuation function for the amplitudes of the transducer's transmit elements. Amplitude gains should be a floating point value in the range [0.0, 1.0]. The size of the apodization function is equal to the number of elements that the corresponding transducer has.

Function Documentation

iufTransmitApodizationCompare()

IUF_BOOL iufTransmitApodizationCompare	(	iuta_t	reference,
		iuta_t	actual
	)

Compare two IufTransmitApodization objects with each other.

Returns

Returns IUF_TRUE in case the IufTransmitApodization objects are equal and IUF_FALSE otherwise

Parameters

reference	The IufTransmitApodization to compare to
actual	The IufTransmitApodization to compare with

iufTransmitApodizationCreate()

iuta_t iufTransmitApodizationCreate	(	float *	apodization,
		int	numElements
	)

Construct an IufTransmitApodization of size numElements.

The attenuation values are checked that they are within the allowed range [0.0,1.0]. The apodization should contain numElements float values.

Parameters

apodization	The transmit apodization values (numElements items)
numElements	The number of ekements that the transducer has.

iufTransmitApodizationDelete()

int iufTransmitApodizationDelete

(

iuta_t

transmitApodization

)

Delete a IufTransmitApodization of size numElements.

Returns

IUF_E_OK in case of success or IUF_ERR_VALUE in case the IufTransmitApodization is invalid

Parameters

transmitApodization

The IufTransmitApodization that is to be deleted.

iufTransmitApodizationGetElement()

float iufTransmitApodizationGetElement	(	iuta_t	transmitApodization,
		int	idx
	)

Get a single value from the transmit apodization function.

Returns

Returns the floating point value of the transmit apodization function at index idx

Parameters

transmitApodization	The IufTransmitApodization of interest
idx	the index in the transmit apodization function. Should be smaller than numElements

iufTransmitApodizationGetNumElements()

int iufTransmitApodizationGetNumElements

(

iuta_t

transmitApodization

)

Get the number of ekements that the transducer has.

Returns

Returns the number of ekements that the transducer has.

Parameters

transmitApodization

The IufTransmitApodization of interest

iufTransmitApodizationSetElement()

int iufTransmitApodizationSetElement	(	iuta_t	transmitApodization,
		int	idx,
		float	attenuation
	)

Set the value of a single elements of the transmit apodization function at index idx.

The attenuation value is checked that it is within the allowed range [0.0,1.0] and the index idx is checked for its range [0,numElements].

Returns

Returns IUF_E_OK in case the element was set, IUF_ERR_VALUE otherwise.

Parameters

transmitApodization	The transmit apodization of interest
idx	The index of the vlaue to be set
attenuation	The attenuation value to set.