:py:mod:`km3modules.mc`
=======================

.. py:module:: km3modules.mc

.. autoapi-nested-parse::

   MC Helpers.

   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   km3modules.mc.GlobalRandomState
   km3modules.mc.McTruth
   km3modules.mc.MCTimeCorrector




Attributes
~~~~~~~~~~

.. autoapisummary::

   km3modules.mc.NEUTRINOS


.. py:data:: NEUTRINOS

   

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




   
   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 !!
   .. py:property:: random_state


   .. py:method:: configure()

      
      Configure module, like instance variables etc.
















      ..
          !! processed by numpydoc !!


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




   
   Extract MC info of 1st MC track.


   :Parameters:

       **most_energetic_primary: bool, default=True**
           ..














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

      
      Configure module, like instance variables etc.
















      ..
          !! processed by numpydoc !!

   .. py:method:: t2f(row)
      :classmethod:


   .. py:method:: is_nu(flavor)
      :classmethod:


   .. py:method:: process(blob)

      
      Knead the blob and return it
















      ..
          !! processed by numpydoc !!


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




   
   Module that converts MC hit times to JTE times.
   Thus, the following tables need to be converted:
   - mc_tracks
   - mc_hits


   :Parameters:

       **mc_hits_key** : str, optional
           Name of the mc_hits to convert (default: 'McHits').

       **mc_tracks_key** : str, optional
           Name of the mc_tracks to convert (default: 'McTracks').

       **event_info_key** : str, optional
           Name of the event_info to store this in (default: 'EventInfo').














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

      
      Configure module, like instance variables etc.
















      ..
          !! processed by numpydoc !!

   .. py:method:: process(blob)

      
      Knead the blob and return it
















      ..
          !! processed by numpydoc !!