.. _auto_curves_match_input_selector:

*COMPUTE THE DIFFERENCE BETWEEN A COLLECTION OF CURVES TO A REFERENCE AND RETURN THE INPUT THAT HAS THE LOWEST ERROR*
=====================================================================================================================

Compares a collection of candidate curves against a reference curve using a selectable distance/error metric, then returns the corresponding input curve (from a separate input set) whose candidate had the lowest error. Use this worker when you need to automatically select the best-matching simulation run or test channel from a pool of alternatives.

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

Classification: **process**.

Tagged: ``best_match``, ``curve_comparison``, ``curve_matching``, ``dtw``, ``error_metric``, ``euclidean``, ``frechet``, ``input_selector``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Reference Curve
     - reference_curve
     - vector
     - —
     - 
     - The single reference (baseline) curve that all candidate curves are compared against; if a CurveGroup is supplied only the first curve is used.
   * - Curves To Be Compared With The Reference
     - curvestobecomparedwiththereference
     - vector
     - —
     - 
     - The pool of candidate curves (CurveGroup or list of vectors) whose error relative to the reference is measured to identify the best match.
   * - Input Curves To Be Selected From
     - inputcurvestobeselectedfrom
     - vector
     - —
     - 
     - A parallel set of input curves (e.g. raw simulation channels) from which the winner is returned; must be index-aligned with the candidate curves.
   * - Match Type
     - match_type
     - list
     - raw
     - 
     - Distance/error metric used for comparison: raw, abs, max, max-max-diff, critical_resultant, euclidean-distance, frechet, dynamic-time-warping, ratio_ydiff, or pdtw; defaults to 'raw'.
   * - Digitize Points
     - numberofpointstodigitize
     - list
     - 100
     - 
     - Reference, Input and Candidate curves will be regenerated using this
   * - Normalize
     - normalize
     - list
     - no
     - 
     - Normalize the curves by dividing the y-values by the y-max from the curve
   * - Xmin
     - xmin
     - scalar
     - 0
     - 
     - Skip values before this point
   * - Xmax
     - xmax
     - scalar
     - 0
     - 
     - Skip values after this point
   * - Sync Curves
     - sync
     - list
     - yes
     - 
     - If the curves xmin and xmax dont match, sync the curves upto xmin
   * - Enforce Monotonic
     - skip_drop
     - list
     - no
     - 
     - Decreasing y-values will be discarded
   * - Diff Ratio Threshold
     - diff_ratio_threshold
     - scalar
     - 0.1
     - 
     - Only applies if the diff type is ratio based
   * - Remove Outliers
     - remove_outliers
     - list
     - no
     - 
     - Remote outliers

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curves_match_input_selector_output_1
     - curves_match_input_selector_output_1
     - vector
     - The single curve from the input set that corresponds to the candidate with the lowest computed error relative to the reference curve.

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

- data.correlation
- data.curve.pair

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

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

.. raw:: html

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