dcnum.read.hdf5_concat
======================

.. py:module:: dcnum.read.hdf5_concat


Functions
---------

.. autoapisummary::

   dcnum.read.hdf5_concat.concatenated_hdf5_data


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

.. py:function:: concatenated_hdf5_data(paths: list[pathlib.Path], path_out: bool | pathlib.Path | None = True, compute_frame: bool = True, features: list[str] | None = None)

   Return a virtual dataset concatenating all the input paths

   :param paths: Path of the input HDF5 files that will be concatenated along
                 the feature axis. The metadata will be taken from the first
                 file.
   :param path_out: If `None`, then the dataset is created in memory. If `True`
                    (default), create a file on disk. If a pathlib.Path is specified,
                    the dataset is written to that file. Note that datasets in memory
                    are likely not pickable (so don't use them for multiprocessing).
   :param compute_frame: Whether to compute the "events/frame" feature, taking the frame
                         data from the input files and properly incrementing them along
                         the file index.
   :param features: List of features to take from the input files.

   .. rubric:: Notes

   - If one of the input files does not contain a feature from the first
     input `paths`, then a `ValueError` is raised. Use the `features`
     argument to specify which features you need instead.
   - Basins are not considered.