.. _auto_curve_clipx_by_intersection:

*CLIP BY INTERSECTION WITH Y-AXIS*
==================================

Clips a curve along the X-axis at the point where it intersects a virtual Y-axis, constructed at a specified X value or at the curve's max, min, or average Y value. Use this worker to truncate a curve at a meaningful reference point derived from its own data or a user-defined X coordinate.

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

Classification: **process**.

Tagged: ``average``, ``clip``, ``clipping``, ``curve``, ``intersection``, ``max``, ``min``, ``truncate``.

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 curve (X-Y vector) to be clipped; provide any time-history or signal curve whose X range should be truncated at the computed intersection point.
   * - X-Value where the Y-axis is created for Intersection
     - xvalue
     - scalar
     - 0.0
     - 
     - X-coordinate at which the virtual Y-axis is placed for intersection when value_type is set to 'At X specified'; dimensionless scalar, defaults to 0.0 and is ignored for max/min/average modes.
   * - Type of clip
     - value_type
     - scalar
     - max
     - 
     - Determines how the clipping X position is chosen: 'At X specified' uses the explicit xvalue, 'Max' clips at the X of the curve's peak Y, 'Min' clips at the X of the lowest Y, and 'Average' clips at the X closest to the mean Y; defaults to 'Max'.
   * - Digitize
     - digitize
     - scalar
     - -1
     - 
     - Number of points to re-sample (digitize) the curve to before computing the intersection; set to -1 (default) to skip digitization and use the curve as-is.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curve_derivative_output_1
     - curve_derivative_output_1
     - vector
     - The clipped output curve (X-Y vector) truncated at the intersection point determined by the chosen clip type and X 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_clipx_by_intersection <https://www.d3view.com/api/workflow/example?id=curve_clipx_by_intersection>`_

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