iufNonParametricPulse.h File Reference

Go to the source code of this file.

Macros
#define	IUNPP_INVALID   (iunpp_t) NULL

Typedefs
typedef IufNonParametricPulse *	iunpp_t

Functions
iunpp_t	iufNonParametricPulseCreate (int numPulseValues)
	Create an IufNonParametricPulse for a wave function with numPulseValues {time,voltage} pairs. More...
int	iufNonParametricPulseDelete (iunpp_t pulse)
	Delete an IufNonParametricPulse. More...
int	iufNonParametricPulseCompare (iunpp_t reference, iunpp_t actual)
	Compare two IufNonParametricPulse with each other. More...
int	iufNonParametricPulseGetNumValues (iunpp_t pulse)
	Get the number of {time, voltage} pairs. More...
float	iufNonParametricPulseGetValueAmplitude (iunpp_t pulse, int index)
	Get the voltage value at location index. More...
float	iufNonParametricPulseGetValueTime (iunpp_t pulse, int index)
	Get the time at location index. More...
int	iufNonParametricPulseSetValue (iunpp_t pulse, int index, float pulseTime, float pulseAmplitude)
	Set a {time, voltage} pair at location index. More...

Macro Definition Documentation

IUNPP_INVALID

#define IUNPP_INVALID   (iunpp_t) NULL

Typedef Documentation

iunpp_t

typedef IufNonParametricPulse* iunpp_t

A non parametric pulse describes an ultrasound transmit pulse using a piecewise linear approximation with a number of {time,voltage} pairs.

Function Documentation

iufNonParametricPulseCompare()

int iufNonParametricPulseCompare	(	iunpp_t	reference,
		iunpp_t	actual
	)

Compare two IufNonParametricPulse with each other.

Returns

Returns IUF_TRUE in case the pulses are equal and IUF_FALSE otherwise

Parameters

reference	The IufNonParametricPulse to compare to
actual	The IufNonParametricPulse to compare with

iufNonParametricPulseCreate()

iunpp_t iufNonParametricPulseCreate

(

int

numPulseValues

)

Create an IufNonParametricPulse for a wave function with numPulseValues {time,voltage} pairs.

Returns

Returns the created IufNonParametricPulse or IUNPP_INVALID in case of an error.

Parameters

numPulseValues

number of points to describe the pulse waveform

iufNonParametricPulseDelete()

int iufNonParametricPulseDelete

(

iunpp_t

pulse

)

Delete an IufNonParametricPulse.

Returns

Returns IUF_E_OK when succesful or IUF_ERR_VALUE when the argument is invalid.

Parameters

pulse

The IufNonParametricPulse that is to be deleted.

iufNonParametricPulseGetNumValues()

int iufNonParametricPulseGetNumValues

(

iunpp_t

pulse

)

Get the number of {time, voltage} pairs.

Returns

Returns the number of {time, voltage} pairs or -1 in case of an error

Parameters

pulse

The IufNonParametricPulse of interest

iufNonParametricPulseGetValueAmplitude()

float iufNonParametricPulseGetValueAmplitude	(	iunpp_t	pulse,
		int	index
	)

Get the voltage value at location index.

Returns

Returns the voltage at index in Volt or IUF_ERR_VALUE in case of an error

Parameters

pulse	The IufNonParametricPulse of interest
index	The index of the {time, voltage} pairs

iufNonParametricPulseGetValueTime()

float iufNonParametricPulseGetValueTime	(	iunpp_t	pulse,
		int	index
	)

Get the time at location index.

Returns

Returns the time at index in seconds or IUF_ERR_VALUE in case of an error

Parameters

pulse	The IufNonParametricPulse of interest
index	The index of the {time, voltage} pairs

iufNonParametricPulseSetValue()

int iufNonParametricPulseSetValue	(	iunpp_t	pulse,
		int	index,
		float	pulseTime,
		float	pulseAmplitude
	)

Set a {time, voltage} pair at location index.

Returns

Returns IUF_E_OK when succesful and IUF_ERR_VALUE in case of invalid parameters

Parameters

pulse	The IufNonParametricPulse of interest
index	The index of the {time, voltage} pairs
pulseTime	the time in seconds
pulseAmplitude	the amplitude in Volt