:py:mod:`km3pipe.io.online`
===========================

.. py:module:: km3pipe.io.online

.. autoapi-nested-parse::

   Pump for the online file format 
   (the file format formerly known as formerly as JPP)

   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   km3pipe.io.online.EventPump
   km3pipe.io.online.TimeslicePump




Attributes
~~~~~~~~~~

.. autoapisummary::

   km3pipe.io.online.log


.. py:data:: log

   

.. py:class:: EventPump(name=None, **parameters)




   
   A pump for DAQ (triggered) events in online files.


   :Parameters:

       **filename: str**
           Name of the file to open.














   ..
       !! processed by numpydoc !!
   .. py:method:: configure()

      
      Configure module, like instance variables etc.
















      ..
          !! processed by numpydoc !!

   .. py:method:: blob_generator()


   .. py:method:: extract_event(event_number)


   .. py:method:: process(blob)

      
      Knead the blob and return it
















      ..
          !! processed by numpydoc !!


.. py:class:: TimeslicePump(name=None, **parameters)




   
   A pump to read and extract timeslices. Currently only hits are read.


   :Parameters:

       **filename: str**
           ..

       **stream: str ('L0', 'L1', 'L2', 'SN') default: 'L1'**
           ..














   ..
       !! processed by numpydoc !!
   .. py:method:: configure()

      
      Configure module, like instance variables etc.
















      ..
          !! processed by numpydoc !!

   .. py:method:: create_timeslice_info()


   .. py:method:: process(blob)

      
      Knead the blob and return it
















      ..
          !! processed by numpydoc !!

   .. py:method:: timeslice_generator()

      
      Uses slice ID as iterator
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_blob(index)

      
      Index is slice ID
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_by_frame_index(frame_index)