:mod:`km3modules.common`
========================

.. py:module:: km3modules.common

.. autoapi-nested-parse::

   A collection of commonly used modules.

   ..
       !! processed by numpydoc !!










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



Classes
~~~~~~~

.. autoapisummary::

   km3modules.common.Dump
   km3modules.common.Delete
   km3modules.common.Keep
   km3modules.common.HitCounter
   km3modules.common.HitCalibrator
   km3modules.common.BlobIndexer
   km3modules.common.StatusBar
   km3modules.common.TickTock
   km3modules.common.MemoryObserver
   km3modules.common.Siphon










.. data:: log
   

   









.. 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:: 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:: 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:: HitCounter

   Bases::class:`km3pipe.Module`

   

   Prints the number of hits















   ..
       !! processed by numpydoc !!


   

   

   .. method:: process(self, blob)

      











.. py:class:: HitCalibrator

   Bases::class:`km3pipe.Module`

   

   A very basic hit calibrator, which requires a `Calibration` module.















   ..
       !! processed by numpydoc !!


   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob)

      











.. py:class:: BlobIndexer

   Bases::class:`km3pipe.Module`

   

   Puts an incremented index in each blob for the key 'blob_index'















   ..
       !! 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:: TickTock

   Bases::class:`km3pipe.Module`

   

   Display the elapsed time.


   :Parameters:

       **every: int, optional [default=1]**
           Number of iterations between printout.













   ..
       !! processed by numpydoc !!


   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob)

      











.. py:class:: MemoryObserver

   Bases::class:`km3pipe.Module`

   

   Shows the maximum memory usage


   :Parameters:

       **every: int, optional [default=1]**
           Number of iterations between printout.













   ..
       !! processed by numpydoc !!


   

   

   .. method:: process(self, blob)

      











.. py:class:: Siphon

   Bases::class:`km3pipe.Module`

   

   A siphon to accumulate a given volume of blobs.


   :Parameters:

       **volume: int**
           number of blobs to hold

       **flush: bool**
           discard blobs after accumulation













   ..
       !! processed by numpydoc !!


   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob)