From 6928d485e6b3ea8ebfd12cdd8739f32dc5134162 Mon Sep 17 00:00:00 2001
From: Tamas Gal <tgal@km3net.de>
Date: Wed, 8 Jan 2020 10:14:04 +0100
Subject: [PATCH] Add information about PMT rates encoding

---
 km3io/daq.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/km3io/daq.py b/km3io/daq.py
index f7bb48b..3356e01 100644
--- a/km3io/daq.py
+++ b/km3io/daq.py
@@ -4,6 +4,11 @@ import numba as nb
 
 TIMESLICE_FRAME_BASKET_CACHE_SIZE = 23 * 1024**2  # [byte]
 SUMMARYSLICE_FRAME_BASKET_CACHE_SIZE = 523 * 1024**2  # [byte]
+
+# Parameters for PMT rate conversions, since the rates in summary slices are
+# stored as a single byte to save space. The values from 0-255 can be decoded
+# using the `get_rate(value)` function, which will yield the actual rate
+# in Hz.
 MINIMAL_RATE_HZ = 2.0e3
 MAXIMAL_RATE_HZ = 2.0e6
 RATE_FACTOR = np.log(MAXIMAL_RATE_HZ / MINIMAL_RATE_HZ) / 255
-- 
GitLab