iuf2DNonParametricSource.h File Reference

File containing iuf2DNonParametricSource related declarations. More...

#include "iufPosition.h"

Go to the source code of this file.

Macros
#define	IU2DNPS_INVALID   (iu2dnps_t) NULL

Typedefs
typedef Iuf2DNonParametricSource *	iu2dnps_t

Functions
iu2dnps_t	iuf2DNonParametricSourceCreate (int numLocations)
	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	iuf2DNonParametricSourceDelete (iu2dnps_t source)
	Delete a 2D non-parametric source. More...
int	iuf2DNonParametricSourceCompare (iu2dnps_t reference, iu2dnps_t actual)
	Compares two 2D non-parametric sources. More...
iu2dp_t	iuf2DNonParametricSourceGetPosition (iu2dnps_t source, int index)
	Gets the index -th 2D position of a 2D non-parametric source. More...
int	iuf2DNonParametricSourceGetNumLocations (iu2dnps_t source)
	Gets he number of points the source has. More...
int	iuf2DNonParametricSourceSetPosition (iu2dnps_t source, iu2dp_t pos, int index)
	sets the 2D position pos on the index -th location for the 2D non-parametric source iuf2DNonParametricSource. More...

Detailed Description

File containing iuf2DNonParametricSource related declarations.

Macro Definition Documentation

IU2DNPS_INVALID

#define IU2DNPS_INVALID   (iu2dnps_t) NULL

An invalid 2D Non-Parametric Source

Typedef Documentation

iu2dnps_t

typedef Iuf2DNonParametricSource* iu2dnps_t

The 2D Non-Parametric Sources describes a list of locations from which a pulse originates simulatanously. You can create a source with a predefined number of locations and then get and set these locations with iuf2DNonParametricSourceGetPosition() and iuf2DNonParametricSourceGetPosition() respectively.

Function Documentation

iuf2DNonParametricSourceCompare()

int iuf2DNonParametricSourceCompare	(	iu2dnps_t	reference,
		iu2dnps_t	actual
	)

Compares two 2D non-parametric sources.

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

iuf2DNonParametricSourceCreate()

iu2dnps_t iuf2DNonParametricSourceCreate

(

int

numLocations

)

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 points the source has.

iuf2DNonParametricSourceDelete()

int iuf2DNonParametricSourceDelete

(

iu2dnps_t

source

)

Delete a 2D non-parametric source.

Returns

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

Parameters

source

The source that is deleted

iuf2DNonParametricSourceGetNumLocations()

int iuf2DNonParametricSourceGetNumLocations

(

iu2dnps_t

source

)

Gets he number of points the source has.

Returns

The number of points the source has.

Parameters

source

2D non-parametric source with positions

iuf2DNonParametricSourceGetPosition()

iu2dp_t iuf2DNonParametricSourceGetPosition	(	iu2dnps_t	source,
		int	index
	)

Gets the index -th 2D position of a 2D non-parametric source.

Returns

The 2D position or IU2DP_INVALID if that position does not exist.

Parameters

source	2D non-parametric source with positions
index	the index of the position list

iuf2DNonParametricSourceSetPosition()

int iuf2DNonParametricSourceSetPosition	(	iu2dnps_t	source,
		iu2dp_t	pos,
		int	index
	)

sets the 2D position pos on the index -th location for the 2D non-parametric source iuf2DNonParametricSource.

Returns

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

Parameters

source	the 2D non-parametric source
pos	the 2D position to be set
index	the index of the position