iuf3DParametricSource.h File Reference

#include "iufPosition.h"

Go to the source code of this file.

Macros
#define	IU3DPS_INVALID   (iu3dps_t) NULL

Typedefs
typedef Iuf3DParametricSource *	iu3dps_t

Functions
iu3dps_t	iuf3DParametricSourceCreate (int numThetaLocations, int numPhiLocations, float fNumber, float deltaTheta, float startTheta, float deltaPhi, float startPhi)
	Construct a (number of) source point(s) using a parametric description of their locations. More...
int	iuf3DParametricSourceDelete (iu3dps_t source)
	Deletes the 3D source. More...
int	iuf3DParametricSourceCompare (iu3dps_t reference, iu3dps_t actual)
	Compares 2 3D parametric sources checks if the contents of the two 3D sources are identical. the order of the arguments don't matter. More...
float	iuf3DParametricSourceGetFNumber (iu3dps_t source)
	Return the FNumber of the 3D parametric source. More...
float	iuf3DParametricSourceGetDeltaTheta (iu3dps_t source)
	Return the delta angle between two thetas of the 3D parametric source. More...
float	iuf3DParametricSourceGetStartTheta (iu3dps_t source)
	Return the starting angle theta. More...
float	iuf3DParametricSourceGetDeltaPhi (iu3dps_t source)
	Return the delta angle between two phis of the 3D parametric source. More...
int	iuf3DParametricSourceGetNumThetaLocations (iu3dps_t source)
	Return the number of sources in theta dimension. More...
int	iuf3DParametricSourceGetNumPhiLocations (iu3dps_t source)
	Return the number of sources in phi dimension. More...
float	iuf3DParametricSourceGetStartPhi (iu3dps_t source)
	Return the starting angle phi. More...
int	iuf3DParametricSourceSetFNumber (iu3dps_t source, float FNumber)
int	iuf3DParametricSourceSetDeltaTheta (iu3dps_t source, float deltaTheta)
int	iuf3DParametricSourceSetStartTheta (iu3dps_t source, float startTheta)
int	iuf3DParametricSourceSetDeltaPhi (iu3dps_t source, float deltaPhi)
int	iuf3DParametricSourceSetStartPhi (iu3dps_t source, float startPhi)

Macro Definition Documentation

IU3DPS_INVALID

#define IU3DPS_INVALID   (iu3dps_t) NULL

Typedef Documentation

iu3dps_t

typedef Iuf3DParametricSource* iu3dps_t

The 3D parametric sources describes source locations from which a pulse originates simulatanously with a set of parameters. A 2D array of sources on a spherical

Function Documentation

iuf3DParametricSourceCompare()

int iuf3DParametricSourceCompare	(	iu3dps_t	reference,
		iu3dps_t	actual
	)

Compares 2 3D parametric sources checks if the contents of the two 3D sources are identical. the order of the arguments don't matter.

Returns

The comparison returns IUF_FALSE if the parametric sources differ, IUF_TRUE if their content is equal

Parameters

reference	The 3D parametric source to compare with
actual	The 3D parametric source to compare

iuf3DParametricSourceCreate()

iu3dps_t iuf3DParametricSourceCreate	(	int	numThetaLocations,
		int	numPhiLocations,
		float	fNumber,
		float	deltaTheta,
		float	startTheta,
		float	deltaPhi,
		float	startPhi
	)

Construct a (number of) source point(s) using a parametric description of their locations.

the sources are points in 3D space on a spherical surface, the radiuf of this sphere is defined by the fNumber the locations are on a grid described by a start, delta and numLocations in the specific dimension. The total number of locations

Parameters

numThetaLocations	The number of sources in theta dimension
numPhiLocations	The number of sources int phi dimension
fNumber	The apertuseSize-source dustance ratio
deltaTheta	the distance between sources along the Theta dimension
startTheta	the first angle in the Theta dimension
deltaPhi	the distance between sources along the Phi dimension
startPhi	the first angle in the Phi dimension

iuf3DParametricSourceDelete()

int iuf3DParametricSourceDelete

(

iu3dps_t

source

)

Deletes the 3D source.

Returns

When the source is deleted it return IUF_E_OK, otherwise IUF_ERR_VALUE

Parameters

source

The 3D source to be deleted

iuf3DParametricSourceGetDeltaPhi()

float iuf3DParametricSourceGetDeltaPhi

(

iu3dps_t

source

)

Return the delta angle between two phis of the 3D parametric source.

Returns

the anglular step size in radians (negative values are allowed) along the phi dimension

Parameters

source

The 3D parametric source that holds the dleta phi

iuf3DParametricSourceGetDeltaTheta()

float iuf3DParametricSourceGetDeltaTheta

(

iu3dps_t

source

)

Return the delta angle between two thetas of the 3D parametric source.

Returns

the anglular step size in radians (negative values are allowed) along the theta dimension

Parameters

source

The 3D parametric source that holds the delta theta

iuf3DParametricSourceGetFNumber()

float iuf3DParametricSourceGetFNumber

(

iu3dps_t

source

)

Return the FNumber of the 3D parametric source.

Returns

the fNumber (dimensionless of this source)

Parameters

source

The 3D parametric source that holds the fNumber

iuf3DParametricSourceGetNumPhiLocations()

int iuf3DParametricSourceGetNumPhiLocations

(

iu3dps_t

source

)

Return the number of sources in phi dimension.

Returns

The number of sources in phi dimension

Parameters

source

The source of interest

iuf3DParametricSourceGetNumThetaLocations()

int iuf3DParametricSourceGetNumThetaLocations

(

iu3dps_t

source

)

Return the number of sources in theta dimension.

Returns

The number of sources in theta dimension

Parameters

source

The source of interest

iuf3DParametricSourceGetStartPhi()

float iuf3DParametricSourceGetStartPhi

(

iu3dps_t

source

)

Return the starting angle phi.

Returns

the offset angle in radians along the phi axis

Parameters

source

The 3D parametric source that holds the sarting phi

iuf3DParametricSourceGetStartTheta()

float iuf3DParametricSourceGetStartTheta

(

iu3dps_t

source

)

Return the starting angle theta.

Returns

the offset angle in radians along the theta axis

Parameters

source

The 3D parametric source that has the start theta

iuf3DParametricSourceSetDeltaPhi()

int iuf3DParametricSourceSetDeltaPhi	(	iu3dps_t	source,
		float	deltaPhi
	)

Set the angular offset of sources

Returns

Returns IUF_E_OK when the delta has been set or IUF_ERR_VALUE when the 3D source is invalid

Parameters

source	The 3D parametric source of which the deltaPhi is set
deltaPhi	The angular delta is the arc-distance in rad between sources

iuf3DParametricSourceSetDeltaTheta()

int iuf3DParametricSourceSetDeltaTheta	(	iu3dps_t	source,
		float	deltaTheta
	)

Set the angular distance between sources

Returns

Returns IUF_E_OK when the delta has been set or IUF_ERR_VALUE when the 3D source is invalid

Parameters

source	The 3D parametric source of which the deltaTheta is set in theta dimension
deltaTheta	The angular delta is the arc-distance in rad between sources

iuf3DParametricSourceSetFNumber()

int iuf3DParametricSourceSetFNumber	(	iu3dps_t	source,
		float	FNumber
	)

Set the fNumber of the provided 3D parametric source

Returns

Returns IUF_E_OK when the fNumber has been set or IUF_ERR_VALUE when the 3D source is invalid

Parameters

source	The 3D parametric source of which the fNumber is set
FNumber	The fNumber is the ratio between source distance and the transducer's aperture width

iuf3DParametricSourceSetStartPhi()

int iuf3DParametricSourceSetStartPhi	(	iu3dps_t	source,
		float	startPhi
	)

Set the angular offset of the source in phi direction

Returns

Returns IUF_E_OK when the start value has been set or IUF_ERR_VALUE when the 3D source is invalid

Parameters

source	The 3D parametric source of which the startPhi is set
startPhi	The start angle is the offset in rad of the first source

iuf3DParametricSourceSetStartTheta()

int iuf3DParametricSourceSetStartTheta	(	iu3dps_t	source,
		float	startTheta
	)

Set the angular offset of the source in theta direction

Returns

Returns IUF_E_OK when the start value has been set or IUF_ERR_VALUE when the 3D source is invalid

Parameters

source	The 3D parametric source of which the start angle is set in theta dimension
startTheta	The start angle is the arc-offset in rad of the sources, i.e. the angle of the first source