previous next Up Title Contents

UtRamp Module


The CheckPars_Ramp(...) Routine

Syntax
BOOLN CheckPars_Ramp(SignalDataPtr theSignal, double timeInterval);


Description
This function checks that theSignal to be ramped has been initialised, and that the ramp interval is not greater than the signal length. It also sets the signalData rampFlag to TRUE


Returns
TRUE if this function succeeeds, otherwise it returns FALSE.


Example(s)
RampUpOutSignal_Ramp(...) routine.

The Linear_Ramp(...) Routine

Syntax
double Linear_Ramp(ChanLen step, ChanLen intervalIndex);


Description
This is a standard ramp function, to be passed as an argument to the Ramp_UP and Ramp_Down routines. It varies from 0 to 1 as the step ranges from 0 to the intervalIndex length.


Returns
ramp value for step, with respect to intervalIndex.


Example(s)

The RampUpOutSignal_Ramp(...) Routine

Syntax
void RampUpOutSignal_Ramp(EarObjectPtr data, double (*RampFunction)(ChanLen, ChanLen), double timeInterval);


Description
This function searches for the first non-zero signal intensity in each channel of the data EarObject's output signal. It then starts the ramp from the preceding zero (or the start of the signal if there are no preceding zero's). The rampFunction argument defines the type of ramp used, and the timeInterval defines the ramp interval.


Returns
none.


Example(s)

The RampDownOutSignal_Ramp(...) Routine

Syntax
void RampDownOutSignal_Ramp(EarObjectPtr data, double (*RampFunction)(ChanLen, ChanLen), double timeInterval);


Description
This function searches for the last non-zero signal intensity from the end of each channel of the data EarObject's output signal. It then starts the ramp from the following zero (or from the end of the signal if there are no following zero's). The rampFunction argument defines the type of ramp used, and the timeInterval defines the ramp interval.


Returns
none


Example(s)

The Sine_Ramp(...) Routine

Syntax
double Sine_Ramp(ChanLen step, ChanLen intervalIndex);


Description
This is a standard ramp function, to be passed as an argument to the Ramp_UP and Ramp_Down routines. It varies from 0 to 1 as the step ranges from 0 to the intervalIndex length.


Returns
ramp value for step, with respect to intervalIndex..


Example(s)


previous next Up Title Contents