.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/plot_e11_data_record.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_plot_e11_data_record.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_plot_e11_data_record.py:


Data Records
============

Data records are a tool for managing time series data collected
over the course of a measurement. They store aligned time series data
and meta data about the file in multiple csv files.

An ActiveRecord is a context manager that will automatically dump
any data in the memory to the target directory in the event of
an exception or error.

.. GENERATED FROM PYTHON SOURCE LINES 13-43

.. code-block:: Python


    from rminstr.data_structures import ActiveRecord, ExistingRecord
    import time

    with ActiveRecord(
        ['column_1', 'column_2'], output_dir='outputs', maxlen=100, minlen=10
    ) as rec:
        # add a single sample. Time stamps can be applied automatically
        # or through the timestamp keyword.
        rec.update('column_1', 0.1)

        # add multiple samples all at once, time stamps need to be
        # provided in this case
        samples = []
        timestamps = []
        for i in range(50):
            samples.append(i)
            timestamps.append(time.time())
        rec.array_update('column_2', samples, timestamps)

        # The most recent sample in a column can be accessed via indexing

        last_sample = rec['column_2']

        # Columns can be indexed into by their timestamps

        time_series = rec.get_time_series(
            'column_2', t_min=timestamps[5], t_max=timestamps[7]
        )


.. GENERATED FROM PYTHON SOURCE LINES 44-46

To read the data back in, point the ``ExistingRecord`` class to
the metadata file produced by the ``ActiveRecord``.

.. GENERATED FROM PYTHON SOURCE LINES 46-58

.. code-block:: Python

    opened = ExistingRecord(f'outputs/{rec.metadata_file_name}')

    # Read each line in the record one at a time
    # and index into it like you would an active record
    while opened.read_next_line():
        pass
    last_sample = opened['column_1']


    # Read the entire record at once into a
    # dictionary of ``TimeSeries`` objects.
    columns = opened.batch_read()


.. _sphx_glr_download_auto_examples_plot_e11_data_record.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_e11_data_record.ipynb <plot_e11_data_record.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_e11_data_record.py <plot_e11_data_record.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_e11_data_record.zip <plot_e11_data_record.zip>`


.. include:: plot_e11_data_record.recommendations


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_