:mod:`km3modules`
=================

.. py:module:: km3modules

.. autoapi-nested-parse::

   A collection of commonly used modules.















   ..
       !! processed by numpydoc !!







Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   ahrs/index.rst
   
   common/index.rst
   
   dummy/index.rst
   
   fit/index.rst
   
   hardware/index.rst
   
   hits/index.rst
   
   k40/index.rst
   
   mc/index.rst
   
   parser/index.rst
   
   plot/index.rst
   
   topology/index.rst
   




Package Contents
----------------



Classes
~~~~~~~

.. autoapisummary::

   km3modules.Dump
   km3modules.Keep
   km3modules.Delete
   km3modules.StatusBar
   km3modules.GlobalRandomState










.. py:class:: Dump

   Bases::class:`km3pipe.Module`

   

   Print the content of the blob.


   :Parameters:

       **keys: collection(string), optional [default=None]**
           Keys to print. If None, print all keys.

       **full: bool, default=False**
           Print blob values too, not just the keys?













   ..
       !! processed by numpydoc !!


   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob)

      











.. py:class:: Keep

   Bases::class:`km3pipe.Module`

   

   Keep only specified keys in the blob.


   :Parameters:

       **keys: collection(string), optional**
           Keys to keep. Everything else is removed.













   ..
       !! processed by numpydoc !!


   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob)

      











.. py:class:: Delete

   Bases::class:`km3pipe.Module`

   

   Remove specific keys from the blob.


   :Parameters:

       **keys: collection(string), optional**
           Keys to remove.













   ..
       !! processed by numpydoc !!


   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob)

      











.. py:class:: StatusBar

   Bases::class:`km3pipe.Module`

   

   Displays the current blob number.















   ..
       !! processed by numpydoc !!


   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob)

      



   

   .. method:: finish(self)

      











.. py:class:: GlobalRandomState

   Bases::class:`km3pipe.Module`

   

   Sets the global random seed of the numpy random generator

   KM3Pipe uses numpy routines exclusively to generate randomness. Setting a
   seed to a specific value will create a fully reproducible pipeline as long
   as your own modules also utilise numpy for random numbers.

   :Parameters:

       **seed: int, default=42**
           ..













   ..
       !! processed by numpydoc !!


   

   

   .. attribute:: random_state
      

      



   

   

   .. method:: configure(self)