iuf2DNonParametricSource.c File Reference

#include <stdlib.h>
#include <iuf.h>
#include <iufSourcePrivate.h>
#include <iufPositionPrivate.h>

Data Structures
struct	Iuf2DNonParametricSource

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...
int	iuf2DNonParametricSourceSave (iu2dnps_t source, hid_t handle)
	Saves a 2D non-parametric ultrasound source to an HDF5 handle. More...
iu2dnps_t	iuf2DNonParametricSourceLoad (hid_t handle)
	Loads a 2D non-parametric ultrasound source fom a HDF5 handle. More...

---

Data Structure Documentation

Iuf2DNonParametricSource

struct Iuf2DNonParametricSource

Data Fields
struct IufSource	base
int	numLocations
struct Iuf2DPosition *	pLocations

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

iuf2DNonParametricSourceLoad()

iu2dnps_t iuf2DNonParametricSourceLoad

(

hid_t

handle

)

Loads a 2D non-parametric ultrasound source fom a HDF5 handle.

Returns

Returns the 2D non-parametric source when successfull or IU2DP_INVALID in case of an error.

Parameters

handle

The HDF5 handle to load from

iuf2DNonParametricSourceSave()

int iuf2DNonParametricSourceSave	(	iu2dnps_t	source,
		hid_t	handle
	)

Saves a 2D non-parametric ultrasound source to an HDF5 handle.

Returns

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

Parameters

source	The 2D non-parameric source to save
handle	The HDF5 handle to save to

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