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

.. py:module:: km3pipe.io.i3

.. autoapi-nested-parse::

   I3Pump for ANTARES DATA.

   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   km3pipe.io.i3.I3Pump




Attributes
~~~~~~~~~~

.. autoapisummary::

   km3pipe.io.i3.log


.. py:data:: log

   

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




   
   Gets information of an ANTARES I3 file and converts it to HDF5.














   :Attributes:

       **filename** : str
           Path to the input I3 file.


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

      
      Configure module, like instance variables etc.
















      ..
          !! processed by numpydoc !!

   .. py:method:: process(blob)

      



      :Parameters:

          **blob** : dict
              Empty dictionary.

      :Returns:

          **blob** : dict
              Dictionary which contains information of the I3 file.













      ..
          !! processed by numpydoc !!

   .. py:method:: increase_hits_buffer_size()

      
      Increases the size of the hit buffer.
















      ..
          !! processed by numpydoc !!

   .. py:method:: increase_mchits_buffer_size()

      
      Increases the size of the mchit buffer.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_mc_highest_energy_muon(frame)
      :staticmethod:


   .. py:method:: get_mc_primary(frame)
      :staticmethod:


   .. py:method:: get_antares_w3(frame)
      :staticmethod:

      
      Gets weight w3 for event.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_antares_w2(frame)
      :staticmethod:

      
      Gets weight w2 for event.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_nb_generated_events(frame)
      :staticmethod:


   .. py:method:: get_rate(frame, omkey)
      :staticmethod:


   .. py:method:: blob_generator()

      
      Loop over frames in I3 file.
      Reads out geometry information of geometry frames and stores it.
      Yields physics frames.
















      ..
          !! processed by numpydoc !!

   .. py:method:: finish()

      
      Clean everything up.
















      ..
          !! processed by numpydoc !!