> 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-simxhart.md).

# Advanced | SIMXHART

## HARMONIC MAXIMUM – \[SIMXHART]

Computes the maximum of the amplitudes of a given harmonic.

## CATEGORY

Advanced

![](https://content.gitbook.com/content/fwfLeQP2Iaoefor0ZUNi/blobs/iw7YmdzwOWEtxIaYgf90/image2018%209%2025_8%2010%2015.png)

## DESCRIPTION

The function allows computing the maximum of the amplitudes of a given harmonic in a moving window over a signal. This window is equal to the length of a cycle with respect to the fundamental frequency. This function computes module (amplitude) and angle (phase) for the symmetric components and its real and imaginary components.

If the number of samples to establish the length of a cycle is greater than the number of samples found between the starting and ending times of the sequence, then the length of the window used is equal to the number of samples between the starting and ending times (in other words ending time starting-time).

## RESULT VARIABLES AND PARAMETERS

<table data-header-hidden><thead><tr><th width="163"></th><th></th></tr></thead><tbody><tr><td><strong>Module (m)</strong></td><td>Maximum of module (or amplitude) for the symmetric components of a harmonic. It is computed for each window moving over the signal, multiplied by the absolute value of the factor.</td></tr><tr><td><strong>Phase (a)</strong></td><td>Angle a (or phase) of the symmetric component sequence associated with the maximum module found. Value is between -180 and 180 degrees [°].<br>Since the module is multiplied by the absolute value of the factor, the phase is modified if the multiplying factor is negative. In this case, 180 degrees are added to the phase.</td></tr><tr><td><strong>Phase (a0)</strong></td><td>Angle a0 (or phase) of the symmetric component sequence associated with the maximum module found. Value is between 0 and 360 degrees [°].</td></tr><tr><td><strong>Real (r)</strong></td><td>Real part r of the required symmetric component sequence (m * cos(a)).</td></tr><tr><td><strong>Imaginary (i)</strong></td><td>Imaginary part i of the required symmetric component sequence (m * sin(a)).</td></tr><tr><td><strong>Signal</strong></td><td>Input signal to perform analysis</td></tr><tr><td><strong>Freq</strong></td><td>Fundamental frequency of the signal in Hertz [Hz], normally compute with the sifreq function. This fundamental frequency in hertz serves to establish the length of time the window moves over the analyzed signal. In fact, this window is equal to one cycle (in number of samples). lfen = rate/ freq [samples].</td></tr><tr><td><strong>Harmonic number</strong></td><td>Number of harmonic to compute.<br>- <strong>0</strong>: DC;<br>- <strong>1</strong>: Fundamental;<br>- <strong>2</strong>: 2nd harmonic;<br>- <strong>n</strong>: nth harmonic (max. 30).</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 size of the acquisition buffer. 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><strong>Note</strong> : The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences used 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.</td></tr></tbody></table>

## SYNTAX

**\[m, a, a0, r, i]** = simxhart( input, 60, 1, 0, HUGE, 1)

## CHARACTERISTICS

Data type support

Double Floating point

## EXAMPLE

In the following example, the function compute amplitude maximum of the third harmonic components of a signal.

![](https://content.gitbook.com/content/fwfLeQP2Iaoefor0ZUNi/blobs/16VM9KecBbDXVmIh35PM/image2018%209%2025_8%2013%2044.png)

The following diagram shows a window moving over a signal. The method used to compute the length of the window is also described.

![](https://content.gitbook.com/content/fwfLeQP2Iaoefor0ZUNi/blobs/bOyoGeJt8xYiq6xu1Jy0/image2019%206%2019_11%2051%2022.png)

The module of the harmonic is computed for each window from the start to the end of the limits and the function returns the maximum of the computed.

Let:

* **nbech:** number of samples to analyze for the signal
* **lfen:** number of samples in a window
* **nbfen:** number of windows for which the calculations are made

Then:

* **nbfen=nbech-lfen+1**

This set of points is used to find the maximum.


---

# 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-simxhart.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.
