.. _auto_curve_clip_at_ymax:

*CLIP THE CURVE AFTER X WHERE Y IS MAX*
=======================================

Clips a curve at the X value where the Y value reaches its maximum, discarding all data points after that peak. Use this worker to truncate a signal or response curve so that only the rising portion up to (and including) the global Y-maximum is retained.

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

Classification: **process**.

Tagged: ``clip``, ``curve_transform``, ``peak``, ``truncate``, ``ymax``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve To Be Clipped
     - curvetobeclipped
     - vector
     - —
     - 
     - The input X-Y curve (vector) to be clipped; all data points after the X location of the global Y-maximum will be removed. Accepts any numeric curve — leave the default null if the curve is piped directly from an upstream worker.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curve_clip_at_ymax_output_1
     - curve_clip_at_ymax_output_1
     - vector
     - The truncated X-Y curve containing only the portion from the curve's start up to (and including) the point where Y is at its maximum value.

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

- data.curve.transform

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

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

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