:py:mod:`km3pipe.hardware`
==========================

.. py:module:: km3pipe.hardware

.. autoapi-nested-parse::

   Classes representing KM3NeT hardware.

   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   km3pipe.hardware.Detector
   km3pipe.hardware.UTMInfo
   km3pipe.hardware.PMT




Attributes
~~~~~~~~~~

.. autoapisummary::

   km3pipe.hardware.log
   km3pipe.hardware.ORDERED_PMT_IDS


.. py:data:: log

   

.. py:class:: Detector(filename=None, det_id=None, t0set=0, string=None)




   
   A KM3NeT detector.


   :Parameters:

       **filename: str, optional**
           Name of .detx file with detector definition.

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

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














   ..
       !! processed by numpydoc !!
   .. py:property:: comments


   .. py:property:: dom_ids


   .. py:property:: dom_positions

      
      The positions of the DOMs, calculated from PMT directions.
















      ..
          !! processed by numpydoc !!

   .. py:property:: dom_table

      
      A `Table` containing DOM attributes
















      ..
          !! processed by numpydoc !!

   .. py:property:: com

      
      Center of mass, calculated from the mean of the PMT positions
















      ..
          !! processed by numpydoc !!

   .. py:property:: xy_positions

      
      XY positions of the DUs, given by the DOMs on floor 1.
















      ..
          !! processed by numpydoc !!

   .. py:property:: pmt_angles

      
      A list of PMT directions sorted by PMT channel, on DU-1, floor-1
















      ..
          !! processed by numpydoc !!

   .. py:property:: ascii

      
      The ascii representation of the detector
















      ..
          !! processed by numpydoc !!

   .. py:property:: n_dus


   .. py:attribute:: max_supported_version
      :value: 5

      

   .. py:method:: reset_caches()


   .. py:method:: add_comment(comment)

      
      Add a comment which will be prefixed with a '#'
















      ..
          !! processed by numpydoc !!

   .. py:method:: translate_detector(vector)

      
      Translate the detector by a given vector
















      ..
          !! processed by numpydoc !!

   .. py:method:: rotate_dom_by_yaw(dom_id, heading, centre_point=None)

      
      Rotate a DOM by a given (yaw) heading.
















      ..
          !! processed by numpydoc !!

   .. py:method:: rotate_du_by_yaw(du, heading)

      
      Rotate all DOMs on DU by a given (yaw) heading.
















      ..
          !! processed by numpydoc !!

   .. py:method:: rescale(factor, origin=(0, 0, 0))

      
      Stretch or shrink detector (DOM positions) by a given factor.
















      ..
          !! processed by numpydoc !!

   .. py:method:: write(filename)

      
      Save detx file.
















      ..
          !! processed by numpydoc !!

   .. py:method:: pmt_with_id(pmt_id)

      
      Get PMT with global pmt_id
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_pmt(dom_id, channel_id)

      
      Return PMT with DOM ID and DAQ channel ID
















      ..
          !! processed by numpydoc !!

   .. py:method:: pmtid2omkey(pmt_id)


   .. py:method:: domid2floor(dom_id)



.. py:class:: UTMInfo(ellipsoid, grid, easting, northing, z)




   
   The UTM information
















   ..
       !! processed by numpydoc !!

.. py:class:: PMT(id, pos, dir, t0, channel_id, omkey)




   
   Represents a photomultiplier.


   :Parameters:

       **id: int**
           ..

       **pos: 3-float-tuple (x, y, z)**
           ..

       **dir: 3-float-tuple (x, y, z)**
           ..

       **t0: int**
           ..

       **channel_id: int**
           ..

       **omkey: int**
           ..














   ..
       !! processed by numpydoc !!

.. py:data:: ORDERED_PMT_IDS
   :value: [28, 23, 22, 21, 27, 29, 20, 30, 26, 25, 19, 24, 13, 7, 1, 14, 18, 12, 6, 2, 11, 8, 0, 15, 4, 3,...