.. _auto_curves_collector:

*COLLECTS CURVES*
=================

Collects and filters curves (responses) available in the current workflow context by matching their names against a user-defined pattern. Supports substring, prefix/suffix, regex, and list-based matching strategies, with optional down-sampling and result count limiting. Use this worker to gather a subset of curves for downstream batch processing or analysis.

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

Classification: **process**.

Tagged: ``batch``, ``collector``, ``curves``, ``downsample``, ``filter``, ``pattern``, ``response``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Pattern
     - pattern
     - string
     - —
     - 
     - String pattern used to filter curves by name; leave blank to match all curves. Interpreted according to the selected Location mode (e.g., a substring, prefix, regex, or comma-separated list).
   * - Location
     - location
     - scalar
     - anywhere
     - 
     - Controls how the pattern is applied to curve names; options are 'anywhere' (default), 'contains', 'starts_with', 'ends_with', 'does_not_start_with', 'does_not_end_with', 'regex', 'not_regex', or 'list'. Default 'anywhere' matches the pattern anywhere in the name.
   * - Limit
     - limit
     - scalar
     - -1
     - 
     - Maximum number of matching curves to return; use -1 (default) for no limit, or select 10/25/50/75/100/200/250 to cap the result set size.
   * - Down Sample
     - down_sample
     - scalar
     - none
     - 
     - Down-sampling strategy applied to each collected curve before output; options include 'none' (no resampling), 'raw', 'digitize', 'critical' (retain critical points), 'skip_every', and 'skip_by_value'. Default is 'none'.
   * - Option 1
     - option1
     - scalar
     - —
     - 
     - Optional value 1 based on Down-sampling. If digitize
   * - Option 2
     - option2
     - scalar
     - —
     - 
     - Optional value 2 based on type of down sampling.
   * - Sort Curves
     - sort_curves
     - scalar
     - no
     - 
     - Sort curves based on value or name
   * - Sort By
     - sort_by
     - string
     - ymax
     - 
     - Sort order. Default is Ascending based on Y-Max
   * - Sort Order
     - sort_order
     - string
     - asc
     - 
     - Order of the Curves. Default is High to low
   * - Sort Limit
     - sort_limit
     - scalar
     - 5
     - 
     - Limit the number of curves returned. By default return all curves
   * - Name Regex
     - name_regex
     - scalar
     - —
     - 
     - You can limt the sort to just the curves that matches this regular expression.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curves_collector_output_1
     - curves_collector_output_1
     - vector
     - Vector (list) of curves matching the specified pattern and filters, with down-sampling applied if configured; passed to downstream curve-processing workers.

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

- cae.postprocessing.response
- data.curve.pair
- 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=curves_collector <https://www.d3view.com/api/workflow/example?id=curves_collector>`_

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