.. _auto_curve_peaks:

*LIST NUMBER OF PEAKS OR PEAK VALUE. PEAKS ARE COMPUTED BASED ON THE SLOPE OF THE CURVE. IT IS EXPECTED THE CURVE BE SMOOTH TO AVOID LOCAL PEAKS.*
==================================================================================================================================================

Detects peaks in a curve by analysing slope sign changes and returns either a count or a representative peak value (first, last, average, min, or maximum). The input curve should be smooth to avoid spurious local-peak detection. Use this worker to extract peak-count or peak-amplitude KPIs from time-history or load curves.

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

Classification: **process**.

Tagged: ``curve_peaks``, ``kpi``, ``peak_detection``, ``peaks``, ``slope``, ``time_history``, ``transformations``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve From Which The Peaks Are To Be Computed
     - curvefromwhichthepeaksaretobecomputed
     - vector
     - —
     - 
     - The input curve (x/y vector pair) on which peak detection is performed; should be pre-smoothed to avoid spurious local peaks — accepts any continuous time-history or load curve.
   * - Peak Computing Type
     - peak_computing_type
     - string
     - value
     - 
     - Method used to identify peaks from the slope of the curve (e.g. 'value'); leave at default 'value' unless a custom peak-detection strategy is required.
   * - Return Type
     - return_type
     - string
     - count
     - 
     - Determines what scalar is returned: 'count' (number of peaks), 'first', 'last', 'average', 'min', or 'maximum' peak value; defaults to 'count'.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curve_peaks_output_1
     - curve_peaks_output_1
     - scalar
     - A single scalar: either the total number of detected peaks (when return_type='count') or the selected peak amplitude (first, last, average, min, or maximum) in the same units as the input curve's y-axis.

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

- data.curve.transform
- data.signal_processing
- 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_peaks <https://www.d3view.com/api/workflow/example?id=curve_peaks>`_

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