.. _auto_curves_spragueandgeererror:

*COMPUTE THE SPRAGUE AND GEER ERROR AND RETURN EITHER THE PHASE, MAGNITUDE OR SHAPE ERRORS. USEFUL FOR COMPARING TWO SIMULATIONS OR SIMULATION AND TEST*
========================================================================================================================================================

Computes the Sprague and Geer error metrics between two curves, returning the Phase, Magnitude, or Shape error as a scalar value. Use this worker to quantitatively compare two simulation curves or a simulation against physical test data.

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

Classification: **process**.

Tagged: ``correlation``, ``curve_comparison``, ``magnitude_error``, ``phase_error``, ``shape_error``, ``sim_vs_test``, ``sprague_geer``, ``validation``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Baseline Curve
     - baseline_curve
     - vector
     - —
     - 
     - The baseline (data) curve to compare against the reference; accepts a time-history or frequency-domain vector (any consistent units); used as the second argument in the Sprague–Geer calculation.
   * - Reference Curve
     - reference_curve
     - vector
     - —
     - 
     - The reference curve (e.g., physical test result or trusted simulation) against which the baseline is evaluated; must share the same domain axis and units as the baseline curve.
   * - Return type
     - returntype
     - scalar
     - PhaseError
     - 
     - Selects which Sprague–Geer error metric to return: 'PhaseError' (default, timing/phase discrepancy), 'MagnitudeError' (amplitude discrepancy), or 'ShapeError' (combined shape discrepancy).

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curves_spragueandgeererror_output_1
     - curves_spragueandgeererror_output_1
     - scalar
     - Scalar Sprague–Geer error value (dimensionless) for the selected error type (Phase, Magnitude, or Shape); lower values indicate closer agreement between the two curves.

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_spragueandgeererror <https://www.d3view.com/api/workflow/example?id=curves_spragueandgeererror>`_

.. 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_spragueandgeererror</code>. Schema hash: <code>9f34dbb19f44</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>