.. highlightlang:: us

.. _auto_xy_mult:

auto_xy_Mult
============

.. index:: auto_xy_Mult

.. us.tag  auto_xy_Mult NOTREADYENGLISH auto_xy

:ref:`auto_xy_Mult` creates a new dataset by
multiplying the y-coordinates of the given 2D datasets.

.. function::  hDataNew = auto_xy_Mult(hData, hData2)
    hDataNew = auto_xy_Mult(hData_Layer, hData2)

.. 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:: hData2

   *hData2* is a handle of the second 2D dataset.

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

* The interpolated y-coordinates are multiplied element wise
  (ymult = Y1 * Y2).

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

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

:sub:`id-193296`