From 248708c9f30a86946d921d6d2928f4cf7246fe42 Mon Sep 17 00:00:00 2001 From: ahmedk <karim.ahmed@xfel.eu> Date: Tue, 2 Apr 2024 14:52:34 +0200 Subject: [PATCH] improve documentation based on MR comments --- docs/operation/calibration_database.md | 2 +- docs/operation/detector_specific_troubleshooting.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/operation/calibration_database.md b/docs/operation/calibration_database.md index e1372e1bb..320b44f72 100644 --- a/docs/operation/calibration_database.md +++ b/docs/operation/calibration_database.md @@ -103,7 +103,7 @@ constants files) PDUs can be transferred between detectors and instruments or replaced. To correct raw data, the calibration pipeline produces calibration constants, which are specific to the module they were generated from. As a result, it's crucial to map the hardware to the corresponding software modules. -It's possible to updated a detector mapping through the CALCAT, in case the PDUs are already available. i.e. Moving a PDU from one detector to another. Otherwise if you need to add new PDUs or detectors. Only users with admin access can add and modify such values. +It's possible to update a detector mapping through CalCat in case the PDUs are already available. i.e. moving a PDU from one detector to another. Otherwise, only users with admin access can add entirely new PDUs.  diff --git a/docs/operation/detector_specific_troubleshooting.md b/docs/operation/detector_specific_troubleshooting.md index cbabce639..84e22e343 100644 --- a/docs/operation/detector_specific_troubleshooting.md +++ b/docs/operation/detector_specific_troubleshooting.md @@ -64,9 +64,9 @@ h5glance /gpfs/exfel/exp/SPB/202401/p005476/raw/r0020/RAW-R0020-GH200-S00000.h5 ### No constants retrieved for burst mode data -To streamline the operation in burst mode, we have decided to exclusively inject fixed gain constants into the database, regardless of the operational mode. Burst mode operates solely at high gain, and the high gain constant remains consistent between fixed and adaptive gain settings. Consequently, we have opted to only incorporate fixed gain constants. The middlelayer responsible for executing dark runs has been adjusted to accommodate this change. +Burst mode operates solely at fixed gain. This is realized either by fixed medium gain, or adaptive gain under the assumption of low illumination, thus being equivalent to fixed high gain with an additional safety margin. Therefore, we decided to only incorporate only fixed gain constants for burst mode. -There have been instances where instruments acquired dark runs manually, posing a risk of mistakenly acquiring these runs in adaptive gain mode. Although not anticipated from an offline calibration perspective, such occurrences will be managed by issuing a warning and employing the adaptive gain constant. If dark runs were not performed, an error will be reported due to either the absence of dark runs or the retrieval of burst mode adaptive dark runs that are more than 3 days old. +The middleware tasked with executing dark runs has been updated to reflect this operational adjustment. Nonetheless, there have been occurrences where dark runs were manually acquired in instruments, creating a potential for error by injecting burst mode constants in adaptive mode. This misstep could result in either the failure to retrieve constants, as the anticipated fixed gain constants were not injected, or the retrieval of outdated constants, leading to incorrect corrections. <!-- ## LPD -- GitLab