sda.io.read_wfm
===============

.. py:module:: sda.io.read_wfm


Attributes
----------

.. autoapisummary::

   sda.io.read_wfm.data_folder


Exceptions
----------

.. autoapisummary::

   sda.io.read_wfm.ReadWfmError


Classes
-------

.. autoapisummary::

   sda.io.read_wfm.ReadWfm


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

.. py:exception:: ReadWfmError

   Bases: :py:obj:`Exception`


   Error for unexpected things when reading wfm files.


.. py:class:: ReadWfm(wfm_file)

   .. py:attribute:: wfm_file


   .. py:method:: decode_header(header_bytes)

      Return a dict of wfm metadata.



   .. py:method:: get_time_vector(tstart, tfrac, tscale, samples)

      Return time vector from tstart, tfrac, tscale and samples.

      :param tstart: Start time in s.
      :type tstart: :py:class:`float`
      :param tfrac: Trigger fraction (?).
      :type tfrac: :py:class:`np.ndarray`
      :param tscale: Time scale in s.
      :type tscale: :py:class:`float`
      :param samples: Number of samples.
      :type samples: :py:class:`int`

      :returns: Time vector in s.
      :rtype: :py:class:`np.ndarray`



   .. py:method:: get_voltage_time()

      Return voltage and time arrays.

      :returns: Voltage and time arrays.
      :rtype: :py:class:`tuple[np.ndarray`, :py:class:`np.ndarray]`



.. py:data:: data_folder