.. highlightlang:: us

.. _auto_xyz_reldiv:

auto_xyz_RelDiv
===============

.. index:: auto_xyz_RelDiv

.. us.tag  auto_xyz_RelDiv NOTREADYENGLISH auto_xyz Changed5400

:ref:`auto_xyz_RelDiv` creates a new dataset by calculating
the relative distribution value of the z coordinates of the given 3D
datasets.

.. function::  hDataNew = auto_xyz_RelDiv(hData, hData2)
    hDataNew = auto_xyz_RelDiv(hData_Layer, hData2)
    hDataNew = auto_xyz_RelDiv(hData_Layer, hData2, nSourceType)

.. us.return

**Return Value**

*hDataNew* is the handle of the new 3D dataset.*hDataNew* is the handle of the new 3D dataset.

.. us.params

**Parameters**

.. uparam:: hData_Layer

   *hData_Layer* is a vector with one
   or two elements:

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

   * - Value
     - Meaning
   * - hData_Layer[1]
     - Handle of a dataset. The new dataset is added to the diagram to which the dataset hData_Layer[1] belongs.
   * - hData_Layer[1, 2]
     - The first element is the handle of a dataset and the second element is the handle of diagram (layer). The new dataset is added to the diagram with the handle hData_Layer[2].

.. uparam:: hData2

   *hData2* Is a second 3D dataset.

.. uparam:: hData_Layer

   *hData_Layer* is a vector with one or two
   elements:

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

   * - Value
     - Meaning
   * - hData_Layer[1]
     - Handle of a dataset. The new data set is added to the diagram to which the dataset hData_Layer[1] belongs.
   * - hData_Layer[1, 2]
     - The first element is the handle of a dataset and the second element is the handle of diagram (layer). The new dataset is added to the diagram with the handle hData_Layer[2].

.. uparam:: hData2

   *hData2* Is a second 3D dataset.

.. uparam:: nSourceType 

  *nSourceType* is one of the following values:

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

     * - Value
       - Description
     * - 1
       - Use the x,y coordinates of dataset 1 to calculate the result.
     * - 2
       - Use the x,y coordinates of dataset 2 to calculate the result.
     * - 3
       - Use the interpolation matrix to calculate the result (Default)

  For type 1 or 2 the z-coordinates for both datasets are calculated
  at the original x,y-coordinates and the results are added. 
  For type 3 the interpolation matrix is calculated at identical x,y 
  coordinates the than the matrices are added (Default).

  If both maps have identical or quasi identical x,y-coordinates the types 1 
  or 2 will calculate a better result.

.. us.comment

**Comment**

The two datasets could be created from a matrix or from XYZ
triples. Evaluates the formula z = (z1 - z2) / z1 * 100%.
(see :ref:`auto_xyz_Sub` for more about how the calculation is done)

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.40.0
     - New parameter *nSourceType*.

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

:sub:`id-1021616`