.. _auto_binout_extractor:

*BINOUT EXTRACTOR*
==================

Extracts time-history response vectors from LS-DYNA binout files associated with a simulation or uploaded file set. The user selects the binout branch, entity IDs, and components; the worker runs binout2xml parsing and returns the extracted vector plus a structured response record. Optionally auto-saves the extracted response back to the parent simulation.

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

Tagged: ``binout``, ``binout2xml``, ``d3hsp``, ``dyna_binout``, ``extraction``, ``ls-dyna``, ``response``, ``simlyzer``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Response Name
     - response_name
     - text
     - —
     - ✓
     - User-defined label assigned to the extracted response vector; used as the output name and, when auto-save is enabled, as the stored response name on the simulation.
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - Reference to an existing d3VIEW simulation record whose on-disk directory is used as the source for binout files; mutually exclusive with direct file upload — at least one of the two must be provided.
   * - Select Branch,ID, and Components
     - binout_info
     - custom
     - —
     - ✓
     - Structured selector (rendered by d3VIEW.BinoutInfoSelector) that captures the ASCII index file path, the binout branch/component list, and the entity ID list; all three sub-fields are required for extraction to proceed.
   * - Auto Save to Simulation
     - auto_save
     - select
     - no
     - 
     - Controls whether the extracted response is persisted back to the parent simulation record; set to 'yes' to save, default 'no' leaves the simulation unchanged.
   * - Force Reextract
     - force_extract
     - select
     - no
     - 
     - When set to 'yes', forces re-extraction even if a cached result already exists on disk; default 'no' reuses any previously extracted data.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Binout Output
     - binout_output
     - vector
     - The extracted time-history as a numeric vector (type: vector), labelled with the user-supplied response name; contains the raw time–value array from the binout component.
   * - Binout Logs
     - binout_logs
     - dataset
     - Dataset containing extraction log/diagnostic messages produced by the Simlyzer pipeline; useful for debugging failed or partial extractions.
   * - Responses
     - responses
     - dataset
     - Dataset record describing the extracted response in d3VIEW's response schema — includes name, type, data_source ('dyna_binout'), binout options, and the serialised vector value; suitable for downstream response-template or KPI workers.

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

- cae.postprocessing.extraction
- cae.postprocessing.response
- engineering.crash.dynamics

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