.. highlightlang:: us

.. _auto_xy_interpolate:

auto_xy_Interpolate
===================

.. index:: auto_xy_Interpolate

.. us.tag  auto_xy_Interpolate NOTREADYENGLISH auto_xy

The function is obsolete. New scripts should use the :ref:`XYSetFilterFunctions` 
function.

:ref:`auto_xy_Interpolate` creates for each
given dataset a new dataset with the x-coordinates of all given
datasets.

.. function::  hvDataNew = auto_xy_Interpolate(hData, hvData)
    hvDataNew = auto_xy_Interpolate(hData_Layer, hvData)

.. us.return

**Return Value**

*hvDataNew* is a vector of the created dataset handles.

.. 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 dataset for the new
  x-vector xs is calculated by linear interpolation.

*  A new vector with y-coordinates is calculated (ys) for each dataset.

*  For each xs, ys pair a new dataset is created.

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

:sub:`id-652672`