.. _auto_curve_clip:

*DISCARD THE POINTS IF THE X-VALUE AND Y-VALUE IS OUTSIDE OF THE RANGE SPECIFIED BELOW*
=======================================================================================

Clips a curve by discarding any points whose x-value or y-value falls outside the specified minimum/maximum bounds. Use this worker to restrict a curve to a rectangular region of interest before further processing or analysis.

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

Classification: **process**.

Tagged: ``bounding_box``, ``clip``, ``clipxy``, ``curve_clip``, ``range_filter``, ``transformations``.

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 pair) to be clipped; all points outside the specified x/y bounds will be removed.
   * - X Min
     - x_min
     - float
     - 0.0
     - 
     - Lower bound on the x-axis (float); any point with x < x_min is discarded — defaults to 0.0, set explicitly to enable x-axis lower clipping.
   * - X Max
     - x_max
     - float
     - 0.0
     - 
     - Upper bound on the x-axis (float); any point with x > x_max is discarded — defaults to 0.0, set explicitly to enable x-axis upper clipping.
   * - Y Min
     - ymin
     - float
     - 0.0
     - 
     - Lower bound on the y-axis (float); any point with y < y_min is discarded — defaults to 0.0, set explicitly to enable y-axis lower clipping.
   * - Y Max
     - ymax
     - float
     - 0.0
     - 
     - Upper bound on the y-axis (float); any point with y > y_max is discarded — defaults to 0.0, set explicitly to enable y-axis upper clipping.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curve_clip_output_1
     - curve_clip_output_1
     - vector
     - The clipped output curve (x/y vector pair) containing only the points that fall within the specified x_min/x_max and y_min/y_max bounds.

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

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