readligo.read_frame
===================

Back to :doc:`Module page <../modules/readligo>`

Summary
-------

Helper function to read frame files

Signature
---------

.. code-block:: python

   def read_frame(filename, ifo, readstrain = True, strain_chan = None, dq_chan = None, inj_chan = None)

.. list-table:: Input variables
   :header-rows: 1

   * - Name
     - Type
     - Default
     - Description
   * - ``filename``
     - -
     - -
     - -
   * - ``ifo``
     - -
     - -
     - -
   * - ``readstrain``
     - -
     - True
     - -
   * - ``strain_chan``
     - -
     - None
     - -
   * - ``dq_chan``
     - -
     - None
     - -
   * - ``inj_chan``
     - -
     - None
     - -

Output variables
----------------

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

   * - Return annotation
     - Docstring type
     - Description
   * - ``None``
     - -
     - -

Docstring
---------

.. code-block:: text

   Helper function to read frame files