.. highlight:: us

.. index:: plateau computation
.. index:: plateau_computation
.. index:: Step statistics

.. _plateau_computation:
 
plateau_computation
===================

.. us.tag plateau_computation Interpolation New6803

:ref:`plateau_computation` computes a statistic for each plateau defined
by rvPlateau using the corresponding values from rvData.

A variety of statistical operations can be applied independently to each
detected plateau (e.g. mean, minimum, maximum, standard deviation).

.. function::  rmXY = plateau_computation(rvPlateau, rvData, rsOperation, bTable);

.. us.return

**Return Value**

*rmXY* is a vector whose content depends on *bTable*. With *bTable* = 0, the
computed statistic is assigned to all samples of each plateau (all other samples
are set to #INF), whereas with *bTable* = 1, a single value per plateau is
returned, suitable for tabular representation or further processing.
 
.. us.params

**Parameters**

.. uparam:: rvPlateau

	*rvPlateau* is the channel displaying the plateaus.

.. uparam:: rvData

	*rvData* is the channel for which the statistic is going to be computed.

.. uparam:: rsOperation

	Is the statistic to compute on *rvData* for each plateau in *rvPlateau*

.. uparam:: bTable

	*bTable* states whether the data is provided :
    
	  * as a vector of the same lenght of the original data, but 0 out of the
	    steps and the results of the computation on each plateau.
	  * as a vector with as many points as steps, useful to be represented as 
	    a table in a report.

.. us.example

**Example**

In the example below, the signal *rvData* (green) is average on each plateau
(blue).

  .. image:: S:/uniplot-obj/images/xyfilter_plateau_computation.*
     :width: 100%

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2026.3
     - New.

.. seealso::
   :ref:`overview-mathematic`,
   :ref:`data-plateaus-computation`,
   :ref:`data-find-plateaus`,
   :ref:`find_plateau`,
   :ref:`filter-functions-for-xy-datasets`

:sub:`id-707603`