> 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/miscellaneous-functions/misc.-or-amod.md).

# Misc. | AMOD

## **MODAL ANALYSIS – \[AMOD]**

This function outputs modal analysis of a single input signal.

## **CATEGORY**

Miscellaneous

<figure><img src="https://1028368895-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfwfLeQP2Iaoefor0ZUNi%2Fuploads%2FGECwjEstobqt8j2C63rO%2Fimage.png?alt=media&amp;token=591d37ae-392e-4924-90e4-647444f2bdc2" alt=""><figcaption></figcaption></figure>

## **DESCRIPTION**

The modal analysis returns the dynamic parameters containing the amplitude, damping, frequency, phase shift and damping ratio of each complex mode identified in the input signal by processing it through an ERA/Prony algorithm method.

To return the modal analysis results, the analyzed input signal is presumed as the impulse-response of a black-box dynamic state-space system. The system identification of this dynamic system is obtained by applying the Eigensystem realization algorithm (ERA) based on Hankel matrices, singular value decomposition and Markov parameters calculation to the input signal. From this system identification, the Prony approach algorithm is then applied to obtain the dynamic parameters based on the system’s equation and residual terms calculation.

## **RESULT VARIABLES AND PARAMETERS**

<table><thead><tr><th width="247.60003662109375">Model Reconstructed Signal</th><th>Input signal reconstructed with the dynamic parameters from the k complex mode identified in the analysis</th></tr></thead><tbody><tr><td><strong>Amplitude</strong></td><td>Modal amplitude [ak]</td></tr><tr><td><strong>Damping</strong></td><td>Modal damping value [σk]</td></tr><tr><td><strong>Frequency</strong></td><td>Modal frequency [fk]</td></tr><tr><td><strong>Phase</strong></td><td>Phase shift [ϴk]</td></tr><tr><td><strong>Damping Ratio</strong></td><td>Modal relative damping ratio [ζk]</td></tr><tr><td><strong>Signal</strong></td><td>The input signal to be analyzed</td></tr><tr><td><strong>Low Frequency</strong></td><td>Low-frequency limit for oscillatory modes for the input signal. This limit must be set so there is at least a complete period in the window selected for analysis.</td></tr></tbody></table>

It must respect the following:

$$
0.05,Hz \le f\_{low} \le f\_{high} \\\[8pt]
$$

**High Frequency:** High-frequency limit for oscillatory modes for the input signal. It must be defined in a way so under sampling is avoided:

$$
f\_{high} \le \frac{1}{4 \cdot sampling\ rate} \\\[8pt]
$$

**Amplitude Limit:** Proportional maximum between the highest and lowest amplitudes of oscillatory mode displayed.

$$
a\_k \ge \left(\frac{a\_{k\ max}}{Amp.\ lim}\right) \\\[8pt] 1 \le a\_k \le 100 \\\[8pt]
$$

**Damping Ratio Limit:** Minimum relative damping of oscillatory modes displayed.

$$
0 \le Damping\ Ratio\ Limit \le 0.70477 \\\[8pt]
$$

<table data-header-hidden><thead><tr><th width="161.99993896484375"></th><th></th></tr></thead><tbody><tr><td><strong>Trigger Time</strong></td><td>Time at which the analysis begin. It must be determined in a way that at least a period of Low Frequency is observable. The starting time will be floored to the first sample available.</td></tr><tr><td><strong>Model Order</strong></td><td>Number of elements kept for the minimal realization of ERA.</td></tr><tr><td><strong>0</strong></td><td>Model order is automatically set with the singular values decomposition evaluation of the Hankel matrix.</td></tr><tr><td><strong>Greater than 0</strong></td><td>Model order is manually set to this value. However if the chosen order is greater than the maximal order permitted for the computation of Hankel matrix, the order will be set automatically.</td></tr><tr><td><strong>Filtering Mode (optional) [On =1 , Off = 0]</strong></td><td>Define if bandpass filter is applied or not. Low and High Frequency parameters will define the cutoff frequencies.</td></tr></tbody></table>

## **SYNTAX**

**\[Reconstructed\_Signal,Amplitude,Damping,Frequency,Phase,Damping\_Ratio]**=amod(sig,Low\_Freq,High\_Freq,Amp\_Lim,Damp\_R\_Lim,Trig,8,0)

{% hint style="info" %}
That 8 is the Order and 0 is the filter. Since these only accept integer value, parameters cannot be set by variable.
{% endhint %}

## **CHARACTERISTICS**

Data type support

Double Floating point

Integer for Model Order and Filtering Mode

## **EXAMPLE**

For this example, a simple signal is constructed with ScopeView.

<figure><img src="https://1028368895-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfwfLeQP2Iaoefor0ZUNi%2Fuploads%2FVAzR9UfCqRRCvI2VcxfT%2Fimage.png?alt=media&amp;token=23b805b4-618c-4c90-a350-10ba2d356f89" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1028368895-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfwfLeQP2Iaoefor0ZUNi%2Fuploads%2FHbumHgHwk4x5qtbeWCv1%2Fimage.png?alt=media&amp;token=a423da0a-fb1c-4f5e-a350-33ee2aaeaa9f" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1028368895-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfwfLeQP2Iaoefor0ZUNi%2Fuploads%2FbOA8ZIBkEqnZH0HBiL7I%2Fimage.png?alt=media&amp;token=ae9267f8-9e54-49d1-a279-a9a3b4aab65d" alt=""><figcaption></figcaption></figure>


---

# 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/miscellaneous-functions/misc.-or-amod.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.
