plaid.storage.common.bridge
===========================

.. py:module:: plaid.storage.common.bridge

.. autoapi-nested-parse::

   Common bridge utilities.

   This module provides bridge functions for converting between PLAID samples and
   storage formats, including flattening/unflattening and sample reconstruction.



Functions
---------

.. autoapisummary::

   plaid.storage.common.bridge.to_sample_dict
   plaid.storage.common.bridge.to_plaid_sample
   plaid.storage.common.bridge.plaid_to_sample_dict


Module Contents
---------------

.. py:function:: to_sample_dict(var_sample_dict: dict[str, Any], flat_cst: dict[str, Any], cgns_types: dict[str, str], features: Optional[list[str]] = None) -> dict[float, dict[str, Any]]

   Convert variable sample dict to time-based sample dict.

   :param var_sample_dict: Variable features dictionary.
   :param flat_cst: Constant features dictionary.
   :param cgns_types: CGNS types dictionary.
   :param features: Optional list of features to include.

   :returns: Time-based sample dictionary.
   :rtype: dict


.. py:function:: to_plaid_sample(sample_dict: dict[float, dict[str, Any]], cgns_types: dict[str, str]) -> plaid.Sample

   Convert sample dict to PLAID Sample.

   :param sample_dict: Time-based sample dictionary.
   :param cgns_types: CGNS types dictionary.

   :returns: The reconstructed PLAID Sample.
   :rtype: Sample


.. py:function:: plaid_to_sample_dict(sample: plaid.Sample, variable_schema: dict[str, Any], constant_schema: dict[str, Any]) -> dict[str, Any]

   Convert PLAID Sample to sample dict.

   :param sample: The PLAID Sample.
   :param variable_schema: Variable schema dictionary.
   :param constant_schema: Constant schema dictionary.

   :returns: sample_dict
   :rtype: dict[str, Any]