.. highlightlang:: us

.. _auto_xy_mean:

auto_xy_Mean
============

.. index:: auto_xy_Mean

.. us.tag  auto_xy_Mean NOTREADYENGLISH auto_xy

Creates a new dataset from the mean
values of the y coordinates of the given 2D datasets.

.. function::  hDataNew = auto_xy_Mean(hData, hvData)
    hDataNew = auto_xy_Mean(hData_Layer, hvData)

.. us.return

**Return Value**

*hDataNew* is the handle of the new dataset.

.. us.params

**Parameters**

.. uparam:: hData

   *hData* is the handle of a 2D dataset. The new
   dataset *hDataNew* will be added to the layer (diagram) in which the
   dataset *hData* is located.

.. uparam:: hData_Layer

   *hData_Layer* is a vector with two elements.
   The first element is a handle of a 2D dataset and the second element is
   a handle of a layer (diagram) to which the new dataset should be
   added.

.. uparam:: hvData

   *hvData* is a vector of handles of 2D Datasets.

.. us.comment

**Comment**

The x coordinates of all given datasets must be strictly
increasing The x coordinates of the given datasets do not have to be
identical.

The new dataset is calculated as following:

*  The x range is calculated where all datasets overlap.

* The the new x range a new x coordinate vector (xs) is
  calculated which contain the x coordinates of all given datasets.

* The y coordinates for each datasets for the new
  x vector xs is calculated by linear interpolation.

* A new vector with y coorinates is calculated by finding
  the mean values elementwise (ymean = (Y1 + Y2 + .. + Yn) / n).

*  A new dataset will be created (xs, ymean).

.. seealso::
   :ref:`overview-automation`,
   :ref:`PageGetLayerHandle`

:sub:`id-1123814`