stepinfo

typhoon.test.signals.stepinfo(signal, settling_time_threshold=2, settling_time_threshold_abs=None, rise_time_thresholds=(0.1, 0.9), ss_during=None, initial_value_override=None, final_value_override=None, evaluate_from_time=None)

Calculates important step characteristics of a given signal: rise time, settling time, overshoot, and others.

This function works also for signals which does not start at zero (e.g. step change from x0 to x1, both different than 0).

User can override initial values and final values. Overriding initial values are useful in the case of a response already starting at 0, and specifying final values is useful for noisy signals or responses with still oscillatory behaviour at the end of the signal.

If the step does not start at 0 seconds of the capture, the initial time can be specified at ‘evaluate_from_time’

Parameters:

• signal (Pandas Series) – Signal to analyze

• settling_time_threshold (float) – Threshold/band, in percentage of the total step, around final value for computing the settling time. Default: 2%

• settling_time_threshold_abs (float) – Absolute threshold/band around final value for computing the settling time. If defined, overwrites ‘settling_time_threshold’

• rise_time_thresholds (tuple of float) – Thresholds from which to compute the start and end of the rise time. Default: (0.1, 0.9)

• ss_during (tuple of float) – Defines the time interval, in seconds, to compute the average and ripple of the signal. If it is not defined, it will consider the time interval from the settling time until the end of the capture.

• initial_value_override (float) – Manually specifies initial value to consider (instead of the first signal value)

• final_value_override (float) – Manually specifies final value to consider (instead of the last signal value)

• evaluate_from_time (float) – Defines the starting time to evaluate the step in seconds

Returns:

Contains the characteristics of the signal.

Return type:

StepInfo