.. _auto_dataset_compute_3d_euclidean_distance:

*DATASET COMPUTE 3D EUCLIDEAN DISTANCE*
=======================================

Computes the 3-D Euclidean distance between matched nodes in two datasets and reports the fraction of nodes whose normalised displacement exceeds a user-defined threshold. Use this worker to quantitatively compare two point-cloud or mesh-node datasets — for example, simulation vs. physical scan — by joining on a shared primary key and evaluating per-node spatial deviations.

When to use
-----------

Classification: **process**.

Tagged: ``3d``, ``euclidean_distance``, ``mesh_nodes``, ``node_comparison``, ``point_cloud``, ``sim_vs_test``, ``spatial_deviation``, ``threshold``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Dataset
     - dataset_1
     - dataset
     - —
     - 
     - First tabular dataset containing node coordinates (e.g. simulation result or reference scan); must include the primary-key column and the X, Y, Z coordinate columns.
   * - Dataset
     - dataset_2
     - dataset
     - —
     - 
     - Second tabular dataset containing node coordinates (e.g. physical measurement or alternative simulation); must share the same primary-key and coordinate column names as dataset_1.
   * - Primary Key
     - id_column
     - scalar
     - id
     - 
     - Name of the column used to join matching nodes between the two datasets (default: 'id'); leave as default when both datasets already use an 'id' column as the node identifier.
   * - XYZ Columns
     - xyz_column
     - scalar
     - x,y,z
     - 
     - Comma-separated list of column names holding the X, Y, Z spatial coordinates (default: 'x,y,z'); update if your datasets use different column names for the three spatial axes.
   * - Threshold
     - threshold
     - scalar
     - 0.01
     - 
     - Fractional threshold for flagging nodes with excessive displacement (default: 0.01 = 1 %); a node is counted as violating when its normalised Euclidean distance exceeds this value — decrease for stricter comparison, increase for more tolerance.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Percentage of Points violating the Threshold
     - euclidean_distance
     - scalar
     - Scalar fraction (0–1) of matched nodes whose normalised 3-D Euclidean distance exceeds the specified threshold; 0 indicates a perfect match, 1 indicates all nodes violate the threshold.

Disciplines
-----------

- data.correlation
- data.dataset.transform
- data.statistics

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=dataset_compute_3d_euclidean_distance <https://www.d3view.com/api/workflow/example?id=dataset_compute_3d_euclidean_distance>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>dataset_compute_3d_euclidean_distance</code>. Schema hash: <code>7cc7be2b1465</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>