.. _auto_binout_extract_from_paths:

*BINOUT EXTRACT FROM PATHS*
===========================

Extracts time-history responses from LS-DYNA binout files by resolving a user-supplied list of binout paths (binout://file/id:legend/component format) against one or more simulations. Optionally applies scale, clip, filter, and transformation operations to each extracted curve before saving results as a response dataset and/or a named response template.

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

Tagged: ``LS-DYNA``, ``binout``, ``clip``, ``extraction``, ``filter``, ``response``, ``scale``, ``template``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - One or more LS-DYNA simulation IDs (remote lookup, repeatable) whose binout files will be read; required — select the target simulation(s) from the platform registry.
   * - Paths
     - paths
     - dataset
     - —
     - 
     - Dataset whose rows each contain a binout path in the form binout://file/id:legend/component; populated from the simulation's binout menu API or supplied manually.
   * - Path Column Name
     - path_column
     - scalar
     - path
     - 
     - Name of the column in the paths dataset that holds the binout path strings; defaults to 'path' — change only if your dataset uses a different column name.
   * - Name Column Name
     - name_column
     - scalar
     - name
     - 
     - Name of the column in the paths dataset that provides the human-readable response name for each extracted curve; defaults to 'name' — change only if your dataset uses a different column name.
   * - Scale factors
     - scale_def
     - textarea
     - —
     - 
     - Comma-separated scale-factor overrides in the format name/xsf/ysf (e.g. accel/1.0/9810.0) applied to named curves before clipping and filtering; leave blank if no scaling is needed.
   * - Filter Definitions
     - filter_def
     - textarea
     - —
     - 
     - Comma-separated filter definitions in the format name/filter_type/filter_freq/time_sf/acc_sf (e.g. accel/SAE/60/1e-3/1.0); leave blank if no filtering is needed.
   * - Clip Definitions
     - clip_def
     - textarea
     - —
     - 
     - Comma-separated clip window definitions in the format name/xmin/xmax/ymin/ymax; leave blank if full time-range data should be kept.
   * - Transformations Definitions
     - transform_def
     - dataset
     - —
     - 
     - Dataset-style transformation table (columns: name, xsf, ysf, xoffset, yoffset, xmin, ymin, filter_type, filter_freq) applied in SCALE → CLIP → FILTER order; preferred over the text inputs when multiple transforms are needed.
   * - Layout Definitions
     - layout_def
     - dataset
     - —
     - 
     - Optional dataset defining plot layout for the extracted responses (columns: name, page, layout, window); leave empty if no custom plot layout is required.
   * - Template Name
     - template_id
     - 
     - —
     - 
     - String name for the response template to be created from the extracted responses; leave blank if saving a named template is not required.
   * - Expressions
     - expressions
     - dataset
     - —
     - 
     - Optional dataset of derived-channel expressions to append (columns: name, type, expression) using platform composite-expression syntax; leave empty if no derived channels are needed.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Responses
     - responses
     - dataset
     - Dataset containing all extracted (and optionally transformed) time-history response curves from the binout files, one row per response channel.
   * - Responsetemplate
     - template_id
     - integer
     - Integer ID of the newly created response template in the platform's responsetemplates registry; populated only when a template_name was provided as input.

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

- cae.postprocessing.extraction
- cae.postprocessing.response
- data.curve.transform

.. raw:: html

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