.. _auto_curve_value_check:

*COMPUTE THE SLOPE OF THE CURVE*
================================

Extracts a statistical value (min, max, or average Y) from a curve within a specified X range and checks it against a target threshold using a chosen comparison operator. Returns a configurable pass or fail scalar result. Use this worker to validate curve-based KPIs against acceptance criteria inside a workflow.

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

Classification: **process**.

Tagged: ``comparison``, ``curve``, ``kpi``, ``pass_fail``, ``threshold``, ``value_check``, ``yavg``, ``ymax``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve To Be Looked Up
     - curvetobelookedup
     - vector
     - —
     - 
     - Input curve (X-Y vector) on which the value check will be performed; supply any time-history or response curve loaded from simulation or test data.
   * - X Min
     - x_min
     - scalar
     - 0.0
     - 
     - Lower bound of the X-axis window over which the statistical value is computed; default 0.0 (use matching engineering units, e.g. seconds or mm).
   * - X Max
     - x_max
     - scalar
     - 0.0
     - 
     - Upper bound of the X-axis window over which the statistical value is computed; default 0.0 — set to the end of the region of interest in the same units as x_min.
   * - Check Value
     - check_value
     - string
     - first
     - 
     - Statistic to extract from the windowed curve for comparison: 'ymin' (minimum Y), 'ymax' (maximum Y), or 'yavg' (average Y); default 'first' falls back to the first available option.
   * - Check Type
     - check_type
     - string
     - lt
     - 
     - Comparison operator applied between the extracted statistic and target_value: 'lt' (<), 'lte' (≤), 'gt' (>), or 'gte' (≥); default 'lt'.
   * - Target Value
     - target_value
     - scalar
     - 0.0
     - 
     - Scalar threshold against which the extracted curve statistic is compared; must be in the same units as the curve Y-axis; default 0.0.
   * - Return Type Pass
     - return_type_pass
     - string
     - pass
     - 
     - Value returned by the worker when the check condition is satisfied (pass); configure to a meaningful scalar code or numeric flag for downstream logic.
   * - Return Type Fail
     - return_type_fail
     - string
     - fail
     - 
     - 

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curve_value_check_output_1
     - curve_value_check_output_1
     - scalar
     - Scalar result of the value check — returns the configured pass value when the comparison condition is met, or the fail value otherwise.

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

- cae.postprocessing.response
- data.curve.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=curve_value_check <https://www.d3view.com/api/workflow/example?id=curve_value_check>`_

.. raw:: html

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