:mod:`km3pipe.calib`
====================

.. py:module:: km3pipe.calib

.. autoapi-nested-parse::

   Calibration.

   ..
       !! processed by numpydoc !!










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



Classes
~~~~~~~

.. autoapisummary::

   km3pipe.calib.Calibration
   km3pipe.calib.CalibrationService





Functions
~~~~~~~~~
.. autoapisummary::


   km3pipe.calib.apply_t0_nb
















































.. data:: HAVE_NUMBA
   :annotation: = False 

   









.. py:class:: Calibration

   Bases::class:`km3pipe.core.Module`

   

   A very simple, preliminary Module which gives access to the calibration.


   :Parameters:

       **apply: bool, optional [default=True]**
           Apply the calibration to the hits (add position/direction/t0)?

       **filename: str, optional [default=None]**
           DetX file with detector description.

       **det_id: int, optional**
           .detx ID of detector (when retrieving from database).

       **t0set: optional**
           t0set (when retrieving from database).

       **calibset: optional**
           calibset (when retrieving from database).













   ..
       !! processed by numpydoc !!


   

   

   

   

   .. attribute:: name
      :annotation: = Calibration 

      



   

   

   .. method:: configure(self)

      



   

   .. method:: process(self, blob, key='Hits', outkey='CalibHits')

      



   

   .. method:: get_detector(self)

      
      Return the detector















      ..
          !! processed by numpydoc !!

      



   

   .. method:: apply_t0(self, hits)

      
      Apply only t0s















      ..
          !! processed by numpydoc !!

      



   

   .. method:: apply(self, hits)

      
      Add x, y, z, t0 (and du, floor if DataFrame) columns to the hits.















      ..
          !! processed by numpydoc !!

      



   

   

   

   

   

   









.. function:: apply_t0_nb(times, dom_ids, channel_ids, lookup_tables)

   
   Apply t0s using a lookup table of tuples (dom_id, calib)















   ..
       !! processed by numpydoc !!

   









.. py:class:: CalibrationService

   Bases::class:`km3pipe.core.Module`

   

   A service which provides calibration routines for hits


   :Parameters:

       **filename: str, optional [default=None]**
           DetX file with detector description.

       **det_id: int, optional**
           .detx ID of detector (when retrieving from database).

       **t0set: optional**
           t0set (when retrieving from database).

       **calibset: optional**
           calibset (when retrieving from database).

       **detector: kp.hardware.Detector, optional**
           ..













   ..
       !! processed by numpydoc !!


   

   

   

   

   .. attribute:: name
      :annotation: = Calibration 

      



   

   

   .. method:: configure(self)

      



   

   .. method:: calibrate(self, hits)