.. _auto_curves_sort:

*SORT THE CURVES BASED ON THE TYPE AND ORDER *
==============================================

Sorts a collection of curves by a chosen property (name, X/Y extrema, or point count) in ascending or descending order, with optional regex filtering and a result-count limit. Use this worker to rank or trim a curve set before downstream processing or visualization.

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

Classification: **process**.

Tagged: ``curve_group``, ``curves``, ``filter``, ``limit``, ``rank``, ``regex``, ``sort``, ``xmax``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curves To Be Sorted
     - curvestobesorted
     - vector
     - —
     - 
     - Collection of input curves to be sorted; accepts multiple curve objects — leave empty only if curves are supplied by a preceding node.
   * - Sort By
     - sort_by
     - string
     - ymax
     - 
     - Property used as the sort key: one of name, name_number_first/last/anywhere, num_points, ymax, ymin, xmax, or xmin; defaults to ymax.
   * - Sort Order
     - sort_order
     - string
     - asc
     - 
     - Direction of the sort — 'asc' for lowest-to-highest or 'desc' for highest-to-lowest; defaults to asc.
   * - Sort Limit
     - sort_limit
     - scalar
     - 5
     - 
     - Maximum number of curves to return after sorting (integer ≥ 1); defaults to 5 — set higher or leave blank to return all curves.
   * - Name Regex
     - name_regex
     - scalar
     - —
     - 
     - Optional regular-expression pattern applied to curve names before sorting, so only matching curves are considered; leave blank to include all curves.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curves_sort_output_1
     - curves_sort_output_1
     - vector
     - Ordered vector of curves ranked by the chosen sort key and direction, truncated to sort_limit entries if specified.

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

- data.curve.pair

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

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

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>curves_sort</code>. Schema hash: <code>d5e69029bb3a</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>