:py:mod:`km3io.online`
======================

.. py:module:: km3io.online


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

Classes
~~~~~~~

.. autoapisummary::

   km3io.online.SummarysliceReader
   km3io.online.OnlineReader
   km3io.online.Timeslices
   km3io.online.TimesliceStream
   km3io.online.Timeslice
   km3io.online.OnlineEvents
   km3io.online.OnlineEvent



Functions
~~~~~~~~~

.. autoapisummary::

   km3io.online.get_rate
   km3io.online.unpack_bits
   km3io.online.get_channel_flags
   km3io.online.get_number_udp_packets
   km3io.online.get_udp_max_sequence_number
   km3io.online.has_udp_trailer



Attributes
~~~~~~~~~~

.. autoapisummary::

   km3io.online.TIMESLICE_FRAME_BASKET_CACHE_SIZE
   km3io.online.SUMMARYSLICE_FRAME_BASKET_CACHE_SIZE
   km3io.online.BASKET_CACHE_SIZE
   km3io.online.BASKET_CACHE
   km3io.online.MINIMAL_RATE_HZ
   km3io.online.MAXIMAL_RATE_HZ
   km3io.online.RATE_FACTOR
   km3io.online.CHANNEL_BITS_TEMPLATE
   km3io.online.BranchConfiguration


.. py:data:: TIMESLICE_FRAME_BASKET_CACHE_SIZE

   

.. py:data:: SUMMARYSLICE_FRAME_BASKET_CACHE_SIZE

   

.. py:data:: BASKET_CACHE_SIZE

   

.. py:data:: BASKET_CACHE

   

.. py:data:: MINIMAL_RATE_HZ
   :value: 2000.0

   

.. py:data:: MAXIMAL_RATE_HZ
   :value: 2000000.0

   

.. py:data:: RATE_FACTOR

   

.. py:data:: CHANNEL_BITS_TEMPLATE

   

.. py:data:: BranchConfiguration

   

.. py:class:: SummarysliceReader(fobj, step_size=1000)


   
   A reader for summaryslices which are loaded as chunks given by step_size.

   To be used as an iterator (`for chunks in SummarysliceReader(...): ...`)















   ..
       !! processed by numpydoc !!
   .. py:attribute:: TREE_ADDR
      :value: 'KM3NET_SUMMARYSLICE/KM3NET_SUMMARYSLICE'

      


.. py:function:: get_rate(value)

   
   Return the rate in Hz from the short int value
















   ..
       !! processed by numpydoc !!

.. py:function:: unpack_bits(value, bits_template, out)

   
   Return a boolean array for a value's bit representation.

   This function also accepts arrays as input, the output shape will be
   NxM where N is the number of input values and M the length of the
   ``bits_template`` array, which is just a dummy array, due to the weird
   signature system of numba.

   :Parameters:

       **value: int or np.array(int) with shape (N,)**
           The binary value of containing the bit information

       **bits_template: np.array() with shape (M,)**
           The template for the output array, the only important is its shape

   :Returns:

       np.array(bool) either with shape (M,) or (N, M)
           ..













   ..
       !! processed by numpydoc !!

.. py:function:: get_channel_flags(value)

   
   Returns the hrv/fifo flags for the PMT channels (hrv/fifo)


   :Parameters:

       **value** : int32
           The integer value to be parsed.














   ..
       !! processed by numpydoc !!

.. py:function:: get_number_udp_packets(value)

   
   Returns the number of received UDP packets (dq_status)


   :Parameters:

       **value** : int32
           The integer value to be parsed.














   ..
       !! processed by numpydoc !!

.. py:function:: get_udp_max_sequence_number(value)

   
   Returns the maximum sequence number of the received UDP packets (dq_status)


   :Parameters:

       **value** : int32
           The integer value to be parsed.














   ..
       !! processed by numpydoc !!

.. py:function:: has_udp_trailer(value)

   
   Returns the UDP Trailer flag (fifo)


   :Parameters:

       **value** : int32
           The integer value to be parsed.














   ..
       !! processed by numpydoc !!

.. py:class:: OnlineReader(filename)


   
   Reader for online ROOT files
















   ..
       !! processed by numpydoc !!
   .. py:property:: uuid


   .. py:property:: events


   .. py:property:: timeslices


   .. py:property:: summaryslices


   .. py:method:: close()



.. py:class:: Timeslices(fobj)


   
   A simple wrapper for timeslices
















   ..
       !! processed by numpydoc !!
   .. py:method:: stream(stream, idx)



.. py:class:: TimesliceStream(headers, superframes, hits_buffer)



.. py:class:: Timeslice(header, superframe, hits_buffer, idx, stream)


   
   A wrapper for a timeslice
















   ..
       !! processed by numpydoc !!
   .. py:property:: frames



.. py:class:: OnlineEvents(headers, snapshot_hits, triggered_hits)


   
   A simple wrapper for online events
















   ..
       !! processed by numpydoc !!

.. py:class:: OnlineEvent(header, snapshot_hits, triggered_hits)


   
   A wrapper for a online event
















   ..
       !! processed by numpydoc !!