> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/scopeview/use-functions/advanced-functions/advanced-or-siseuil.md).

# Advanced | SISEUIL

## OVERSHOOT STATISTICS – \[SISEUIL]

Compute overshoot statistics of a signal using a threshold condition.

## **CATEGORY**

Advanced

![](https://content.gitbook.com/content/fwfLeQP2Iaoefor0ZUNi/blobs/UqvspeREJofNLDX986Mg/image2018%209%2025_8%2023%2048.png)

## **DESCRIPTION**

This function is used to compute overshoot statistics using a threshold condition. It also generates a logical signal with these overshoot times on the signal studied.

## **RESULT VARIABLES AND PARAMETERS**

<table data-header-hidden><thead><tr><th width="191"></th><th></th></tr></thead><tbody><tr><td><strong>Moyd</strong></td><td>Sample mean computed on the first Time interval (Average Time Length) in milliseconds of the analyzed signal from the start of the signal. Afterwards, the signal overshoots are analyzed from the Starting time.</td></tr><tr><td><strong>ttot</strong></td><td>Sum of the overshoot times on the threshold value for the signal analyzed. This result is specified in milliseconds [ms].</td></tr><tr><td><strong>tmax</strong></td><td>Longest overshoot time specified in milliseconds [ms].</td></tr><tr><td><strong>ncnt</strong></td><td>Number of times when the threshold overshoot duration is longer than the specified Delay ON.</td></tr><tr><td><strong>logi</strong></td><td>The logical signal has a value of 1 from the start of an overshoot plus the Delay ON value. It remains at 1 until the end of the overshoot plus the specified Delay OFF value. For all other cases, the value of the logical signal is 0. The overshoot times which do not exceed the Delay ON value are not shown in the logical signal.</td></tr><tr><td><strong>Threshold (+/-)</strong></td><td>Difference with the mean of the starting samples to set the threshold value to reach. The threshold value used for overshoot calculations is the threshold difference added to the mean result (the mean of the time interval samples from the start of the study). This difference is expressed in the units of the signals.<br>- <strong>Example</strong>: Let, the mean moyd = 40.0. If the threshold difference is = 15.0, then the threshold value used is 55.0. If the threshold difference is = -15.0, then the threshold value used is 25.0.<br>- The threshold direction is set by the sign of the threshold. If the difference is negative, then the threshold value is smaller than moyd. Hence, overshoots going towards the bottom part of the graph are looked for, since the start of the study is not considered as an overshoot. This case is shown in first example below. If the difference is positive, then the threshold value is greater than moyd. Hence, overshoots going towards the top part of the graph are looked for, since the start of the study is not considered as an overshoot. This case is shown in the second example.<br>- To be considered as an overshoot, the signal must reach the threshold and return under this threshold within the set limits of the analysis. Thus, if a signal is above a threshold throughout the analysis, then the ncnt, ttot and tmax results will be null.</td></tr><tr><td><strong>Average Time Length</strong></td><td>Time interval in milliseconds [ms] from time 0 on which the initial mean will be computed and serving to set the threshold. A null value is not valid.</td></tr><tr><td><strong>Delay ON</strong></td><td>Minimal time during which the overshoot must last in order to be considered as a count. This time is specified in milliseconds [ms].</td></tr><tr><td><strong>Delay OFF</strong></td><td>Minimal time during which the logical signal generated must stay at 1 following the end of an overshoot. This time is specified in milliseconds [ms].</td></tr><tr><td><strong>Begin_time</strong></td><td>Time 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.</td></tr><tr><td><strong>End_time</strong></td><td>Time 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.<br>The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences to compute the fundamental frequency.</td></tr><tr><td><strong>Factor</strong></td><td>Multiplying 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 factor applies to the moyd, tmax and ttot results.</td></tr></tbody></table>

## **SYNTAX**

**\[moyd, ttot, tmax, ncnt, logi]** = siseuil( input, 0.5, 1.0, 0.5, 0.25, 0, HUGE, 1)

## **CHARACTERISTICS**

Data type support

Double Floating point

## **EXAMPLE**

The first figure shows a case where the threshold difference is negative.

![](https://content.gitbook.com/content/fwfLeQP2Iaoefor0ZUNi/blobs/qUYGPjyQtEGYopvKEkaw/image2018%209%2025_8%2024%2030.png)

The second figure shows a case where the threshold difference is positive.

![](https://content.gitbook.com/content/fwfLeQP2Iaoefor0ZUNi/blobs/g5buWF674wrToE7xqz9G/image2018%209%2025_8%2024%2043.png)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/scopeview/use-functions/advanced-functions/advanced-or-siseuil.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
