.. _auto_curve_clipx_by_dataset:

*DISCARD THE POINTS IF THE X-VALUE IS OUTSIDE OF THE RANGE SPECIFIED USING A DATASET*
=====================================================================================

Clips a curve by discarding all points whose x-value falls outside the [x_min, x_max] range defined by columns in a supplied dataset. Use this worker when x-axis bounds are stored in a tabular dataset rather than hard-coded scalar values.

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

Classification: **process**.

Tagged: ``clip``, ``curve``, ``dataset-driven``, ``filter``, ``transformations``, ``trim``, ``x-range``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve To Be Trimmed
     - curvetobetrimmed
     - vector
     - —
     - 
     - The input curve (x/y vector) whose points will be clipped; any point with an x-value outside [x_min, x_max] will be removed.
   * - X Min
     - clip_dataset
     - dataset
     - 0.0
     - 
     - A dataset (table) that contains at least one row with the x_min and x_max bound values; the relevant columns are selected via x_min_col and x_max_col.
   * - X Min Col
     - x_min_col
     - scalar
     - 1.0
     - 
     - Name or index of the column in clip_dataset that holds the lower x-bound; points with x below this value are discarded. Defaults to column '1.0' (first column).
   * - X Max Col
     - x_max_col
     - scalar
     - 1.0
     - 
     - Name or index of the column in clip_dataset that holds the upper x-bound; points with x above this value are discarded. Defaults to column '1.0' (first column).

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curve_clipx_by_dataset_output_1
     - curve_clipx_by_dataset_output_1
     - vector
     - The trimmed output curve containing only the points whose x-values fall within the [x_min, x_max] range read from the dataset.

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

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