iuf2DParametricSource.h File Reference

#include "iufPosition.h"

Go to the source code of this file.

Macros
#define	IU2DPS_INVALID   (iu2dps_t) NULL

Typedefs
typedef Iuf2DParametricSource *	iu2dps_t

Functions
iu2dps_t	iuf2DParametricSourceCreate (int numLocations, float fNumber, float deltaTheta, float startTheta)
	Create an ultrasound source for generating a pulseform based on numLocations points. The points are described directly by their 2D position (i.e. not parametrically) . More...
int	iuf2DParametricSourceDelete (iu2dps_t source)
	Delete a 2D parametric source. More...
int	iuf2DParametricSourceCompare (iu2dps_t reference, iu2dps_t actual)
	Compares two 2D parametric sources. It does not matter which is the reference and the actual. More...
float	iuf2DParametricSourceGetFNumber (iu2dps_t source)
	Returns the fNumber of this source, or NAN if the source is invalid. More...
float	iuf2DParametricSourceGetDeltaTheta (iu2dps_t source)
	Returns the angular delta in radians between source points or NAN if the source is invalid. More...
float	iuf2DParametricSourceGetStartTheta (iu2dps_t source)
	Returns the angle of the first source point or NAN if the source is invalid. More...
int	iuf2DParametricSourceGetNumLocations (iu2dps_t source)
	Gets the number of source locations that are triggered simulatenously. More...
int	iuf2DParametricSourceSetFNumber (iu2dps_t source, float FNumber)
	Sets the fNumber of the parametric sources, return IUF_E_OK when successful or IUF_ERR_VALUE in case the source is incorrect. More...
int	iuf2DParametricSourceSetDeltaTheta (iu2dps_t source, float deltaTheta)
	Sets the delta between sources, return IUF_E_OK when successful or IUF_ERR_VALUE in case the source is incorrect. More...
int	iuf2DParametricSourceSetStartTheta (iu2dps_t source, float startTheta)

Macro Definition Documentation

IU2DPS_INVALID

#define IU2DPS_INVALID   (iu2dps_t) NULL

An invalid 2D Non-Parametric Source

Typedef Documentation

iu2dps_t

typedef Iuf2DParametricSource* iu2dps_t

The 2D parametric Sources describes one or multiple point sources from which a pulse originates simulatanously. You can create a source with a predefined number of locations and a paramteric description of where these points are located. The parameters decribe points on a circlular arc, defined by the fNumber (radiuf relative to the aperture), a starting angle and a delta angle (both in radians). iuf2DParametricSourceGetPosition() and iuf2DParametricSourceGetPosition() respectively.

Function Documentation

iuf2DParametricSourceCompare()

int iuf2DParametricSourceCompare	(	iu2dps_t	reference,
		iu2dps_t	actual
	)

Compares two 2D parametric sources. It does not matter which is the reference and the actual.

Returns

IUF_TRUE if reference and actual are identical sources, and IUF_FALSE in all other cases.

Parameters

reference	2D non-parametric source to compare
actual	2D non-parametric source to compare with.

iuf2DParametricSourceCreate()

iu2dps_t iuf2DParametricSourceCreate	(	int	numLocations,
		float	fNumber,
		float	deltaTheta,
		float	startTheta
	)

Create an ultrasound source for generating a pulseform based on numLocations points. The points are described directly by their 2D position (i.e. not parametrically) .

Returns

returns the created 2D non-parameric source.

Parameters

numLocations	The number of source locations that are triggered simulatenously
fNumber	the fNumber is the Focal depth (radiuf of the circle where the sources are positions) over the aperture diameter.
deltaTheta	The arc length in radians between sources
startTheta	the angle of the first source

iuf2DParametricSourceDelete()

int iuf2DParametricSourceDelete

(

iu2dps_t

source

)

Delete a 2D parametric source.

Returns

Returns IUF_E_OK on success or IUF_ERR_VALUE in case of an error.

Parameters

source

the source that will be deleted

iuf2DParametricSourceGetDeltaTheta()

float iuf2DParametricSourceGetDeltaTheta

(

iu2dps_t

source

)

Returns the angular delta in radians between source points or NAN if the source is invalid.

Parameters

source

The source of interest

iuf2DParametricSourceGetFNumber()

float iuf2DParametricSourceGetFNumber

(

iu2dps_t

source

)

Returns the fNumber of this source, or NAN if the source is invalid.

Parameters

source

The source of interest

iuf2DParametricSourceGetNumLocations()

int iuf2DParametricSourceGetNumLocations

(

iu2dps_t

source

)

Gets the number of source locations that are triggered simulatenously.

Returns

The number of source locations that are triggered simulatenously.

Parameters

source

The source of interest

iuf2DParametricSourceGetStartTheta()

float iuf2DParametricSourceGetStartTheta

(

iu2dps_t

source

)

Returns the angle of the first source point or NAN if the source is invalid.

Parameters

source

The source of interest

iuf2DParametricSourceSetDeltaTheta()

int iuf2DParametricSourceSetDeltaTheta	(	iu2dps_t	source,
		float	deltaTheta
	)

Sets the delta between sources, return IUF_E_OK when successful or IUF_ERR_VALUE in case the source is incorrect.

Parameters

source	The source of interest
deltaTheta	the value of the delta angle

iuf2DParametricSourceSetFNumber()

int iuf2DParametricSourceSetFNumber	(	iu2dps_t	source,
		float	FNumber
	)

Sets the fNumber of the parametric sources, return IUF_E_OK when successful or IUF_ERR_VALUE in case the source is incorrect.

Parameters

source	The source of interest
FNumber	the value of the fNumber

iuf2DParametricSourceSetStartTheta()

int iuf2DParametricSourceSetStartTheta	(	iu2dps_t	source,
		float	startTheta
	)

Parameters

source	The source of interest
startTheta	the value of the starting angle