Documentation Home Page HYPERSIM Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Advanced | SIDSEUIL

OVERSHOOT TIME – [SIDSEUIL]
Computes the period of time during which a threshold value is reached in a signal.


CATEGORY
Advanced


DESCRIPTION
The function computes the period of time and different results related to the overshoot time during which a threshold value is reached in a signal, either on a rising or a falling edge(Slope).

It computes the beginning and ending time and duration of the threshold condition.

To perform the analysis, a new signal is generated with the three signals specified as input parameters and following the type of threshold specified.

Based on the slope value, resulting signal calculated as follow:

Rise(m)Resulting signal is the maximum of the three signals.
Fall(d)Resulting signal is the minimum of the three signals.


When samples do not belong to the signal part specified, values are replaced by 0.0.

User must specify three input signals. However, if only one signal is to be used, then the same name should be given to all three signals. When only one signal is processed, the maximum and minimum samples will result in one identical signal. Similarly, if two signals are to be processed, the third signal to be used can be identical to one of the first two.


RESULT VARIABLES AND PARAMETERS

tsedFrom the starting time of the analysis, course of the generated signal to find the time at which the threshold value is reached based on the type of threshold specified. The time is returned in milliseconds [ms] and is relative to time 0.
tsef

From the ending time of the analysis, course of the generated signal towards the beginning to find the time at which the threshold value is reached based on the type of threshold specified. The time is returned in milliseconds [ms] and is relative to time 0.

duseDifference between tsef and tsed in milliseconds [ms]. This result represents the period of time during which the threshold value is reached.
Signal_1First signal to analyze.
Signal_2

Second signal to analyze.

Signal_3

Third signal to analyze.

Signal_Part

Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions of the four distinct parts of a signal:

Neg

Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos

Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig

The original input signal is used for the calculations.

Abs

The calculations are done on the absolute value of the input signal.

ThresholdValue of threshold to be reached on the specified part of the signal.
Slope

Type of threshold to reach: the threshold value can be reached on a rise (m) or a fall (d).

Rise(m)On the resulting signal, the threshold is considered to be reached when the first sample of the analyzed signal exceeds the specified threshold (tsed). From the ending time of the analysis, the threshold is considered to end when the first sample of the analyzed signal exceeds the specified threshold (tsef).
Fall(d)On the resulting signal, the threshold is considered to be reached when the first sample is smaller than the specified threshold (tsed). From the ending time of the analysis, the threshold is considered to end when the first sample of the analyzed signal is smaller than the specified threshold (tsef).
Begin_timeTime at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.
End_timeTime at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.
FactorMultiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results. The multiplying factor applies only to the tsed and tsef results.It does not apply to the duse result.


SYNTAX

[tsed, tsef, duse] = sidseuil(sig1, sig2, sig3, "sig", threshold, "m", 0, HUGE, factor)


CHARACTERISTICS
Data type support
Double Floating point


EXAMPLE

The following figures show Sidseuil function examples on Rise and Fall:

Sidseuil function on a rise:

Sidseuil function on a fall:


The next figures show the different limit cases of the Sidseuil function:


OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323