.. _auto_binout_timehistory_dataset:

*BINOUT TIMEHISTORY DATASET*
============================

Extracts binout time-history data from an LS-DYNA simulation and pivots it into a flat tabular dataset where each column represents a component+ID combination and each row represents a timestep. Supports filtering by file type, component, and ID, and offers three time-alignment strategies (fill_blanks, intersection, interpolation) plus optional row resampling. Use this worker when you need to convert raw binout responses into an analysis-ready dataset for downstream ML, visualization, or export.

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

Tagged: ``binout``, ``dataset``, ``extraction``, ``glstat``, ``interpolation``, ``ls-dyna``, ``matsum``, ``nodout``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation Id
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - The unique identifier of the LS-DYNA simulation whose binout files will be extracted; must resolve to a valid simulation record in d3VIEW.
   * - Binout File Types
     - binout_files
     - text
     - —
     - 
     - Comma-separated list of binout file types to include (e.g., 'glstat,matsum,nodout'); leave empty to extract all available file types found in the simulation directory.
   * - Components Filter
     - components_filter
     - text
     - —
     - 
     - Optional per-file component filter using the format 'file_type:comp1,comp2/file_type:comp1,comp2' (e.g., 'glstat:kinetic_energy,internal_energy/matsum:kinetic_energy'); leave empty to include all components for every requested file.
   * - IDs Filter
     - ids_filter
     - text
     - —
     - 
     - Optional per-file entity-ID filter using the format 'file_type:id1,id2/file_type:id1,id2' (e.g., 'matsum:1,2,3/nodout:81500001'); not applicable to files without IDs such as glstat; leave empty to include all IDs.
   * - Time Alignment
     - time_alignment
     - select
     - fill_blanks
     - 
     - Strategy for reconciling different time grids across binout files: 'fill_blanks' (union, blanks where missing), 'intersection' (common timesteps only), or 'interpolation' (linear interpolation to a shared grid); defaults to 'fill_blanks'.
   * - Target Rows
     - target_rows
     - number
     - 0
     - 
     - Desired number of rows in the output dataset; set to 0 (default) to keep all rows as-is, provide a lower value to downsample via bin-averaging, or a higher value to upsample via linear interpolation.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Binout Timehistory Dataset
     - dataset
     - dataset
     - Tabular dataset with a 'time' column and one column per component+ID combination; column names follow the pattern '{file}_{abbrev}' for ID-less files (e.g., 'glstat_ke') or '{file}_{abbrev}_{id}_{legend}' for files with IDs (e.g., 'matsum_ke_2_Chassis').
   * - Status
     - status
     - text
     - Human-readable status message; on success reports row count, column count, files processed, and time-alignment mode; on failure provides a descriptive error message including available options where applicable.

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

- cae.postprocessing.extraction
- data.dataset.ingest
- data.dataset.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_timehistory_dataset</code>. Schema hash: <code>aebcefa189fe</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>