IUF-SDK-3
Interventional Ultrasound Library
iuf3DNonParametricSource.c File Reference
#include <stdlib.h>
#include <string.h>
#include <memory.h>
#include <iuf.h>
#include <iufSourcePrivate.h>
#include <iufPositionPrivate.h>

Data Structures

struct  Iuf3DNonParametricSource
 

Functions

iu3dnps_t iuf3DNonParametricSourceCreate (int numLocations)
 
int iuf3DNonParametricSourceDelete (iu3dnps_t source)
 Delete a 3D non-parametric source. More...
 
int iuf3DNonParametricSourceCompare (iu3dnps_t reference, iu3dnps_t actual)
 Compares two 3D non-parametric sources. More...
 
iu3dp_t iuf3DNonParametricSourceGetPosition (iu3dnps_t source, int index)
 Gets the index -th 3D position of a 3D non-parametric source. More...
 
int iuf3DNonParametricSourceGetNumLocations (iu3dnps_t source)
 Gets he number of points the source has. More...
 
int iuf3DNonParametricSourceSetPosition (iu3dnps_t source, iu3dp_t pos, int index)
 Sets the 3D position pos on the index -th location for the 3D non-parametric source iuf3DNonParametricSource. More...
 
int iuf3DNonParametricSourceSave (iu3dnps_t source, hid_t handle)
 
iu3dnps_t iuf3DNonParametricSourceLoad (hid_t handle)
 

Data Structure Documentation

◆ Iuf3DNonParametricSource

struct Iuf3DNonParametricSource
Data Fields
struct IufSource base
IUF_BOOL deepDelete
int numLocations
struct Iuf3DPosition * pLocations

Function Documentation

◆ iuf3DNonParametricSourceCompare()

int iuf3DNonParametricSourceCompare ( iu3dnps_t  reference,
iu3dnps_t  actual 
)

Compares two 3D non-parametric sources.

Returns
IUF_TRUE if reference and actual are identical sources, and IUF_FALSE in all other cases.
Parameters
reference3D non-parametric source to compare
actual2D non-parametric source to compare with

◆ iuf3DNonParametricSourceCreate()

iu3dnps_t iuf3DNonParametricSourceCreate ( int  numLocations)

An invalid 3D Non-Parametric Source

Parameters
numLocationsThe number of points the source has.

◆ iuf3DNonParametricSourceDelete()

int iuf3DNonParametricSourceDelete ( iu3dnps_t  source)

Delete a 3D non-parametric source.

Returns
Returns IUF_E_OK on success or IUF_ERR_VALUE in case of an error.
Parameters
sourceThe source that is deleted

◆ iuf3DNonParametricSourceGetNumLocations()

int iuf3DNonParametricSourceGetNumLocations ( iu3dnps_t  source)

Gets he number of points the source has.

Returns
The number of points the source has.
Parameters
source2D non-parametric source with positions

◆ iuf3DNonParametricSourceGetPosition()

iu3dp_t iuf3DNonParametricSourceGetPosition ( iu3dnps_t  source,
int  index 
)

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

Returns
The 3D position or IU3DP_INVALID if that position does not exist.
Parameters
source3D non-parametric source with positions
indexthe index of the position list

◆ iuf3DNonParametricSourceLoad()

iu3dnps_t iuf3DNonParametricSourceLoad ( hid_t  handle)

◆ iuf3DNonParametricSourceSave()

int iuf3DNonParametricSourceSave ( iu3dnps_t  source,
hid_t  handle 
)

◆ iuf3DNonParametricSourceSetPosition()

int iuf3DNonParametricSourceSetPosition ( iu3dnps_t  source,
iu3dp_t  pos,
int  index 
)

Sets the 3D position pos on the index -th location for the 3D non-parametric source iuf3DNonParametricSource.

Returns
Returns IUF_E_OK on success or IUF_ERR_VALUE in case of an error.
Parameters
sourcethe 3D non-parametric source
posthe 3D position to be set
indexthe index of the position