From 9cd74c7f762b1d416c27879ddbd001f5f784f37d Mon Sep 17 00:00:00 2001
From: Karim Ahmed <karim.ahmed@xfel.eu>
Date: Tue, 18 Apr 2023 12:43:14 +0200
Subject: [PATCH] gh2 notebook description

---
 docs/operation/available_notebooks.md | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/docs/operation/available_notebooks.md b/docs/operation/available_notebooks.md
index 09b42de23..1d3ae1a4f 100644
--- a/docs/operation/available_notebooks.md
+++ b/docs/operation/available_notebooks.md
@@ -155,12 +155,31 @@ Values shown in plots are saved in h5 files.
 
 ### Gotthard2 Offline Correction
 
-Offline Correction for Gothard2 Detector
+Offline Correction for Gotthard2 Detector.
+
+This notebook is able to correct 25um and 50um GH2 detectors using the same correction steps:
+- Convert 12bit raw data into 10bit, offset subtraction, then multiply with gain constant.
+
+| Correction | constants   | boolean to enable/disable   |
+|------------|-------------|-----------------------------|
+|   12bit to 10bit  | `LUTGotthard2` |  |
+|   Offset  | `OffsetGotthard2`|`offset_correction`|
+|   Relative gain  | `RelativeGainGotthard2` + `BadPixelsFFGotthard2` |`gain_correction`|
+
+Beside the corrected data, a mask is stored using the badpixels constant of the same parameter conditions and time.
+- `BadPixelsDarkGotthard2`
+- `BadPixelsFFGotthard2`, if relative gain correction is requested.
+
+The correction is done per sequence file. If all selected sequence files have no images to correct the notebook will fail.
+The same result would be reached in case the needed dark calibration constants were not retrieved for all modules and `offset_correction` is True.
+In case one of the gain constants were not retrieved `gain_correction` is switched to False and gain correction is disabled.
+
 ### Gotthard2 Dark Image Characterization
 
-The following is a processing for offset, noise, and Badpixels maps using dark images taken with Gotthard2 detector. All constants are evaluated per strip, per pulse, and per memory cell. The maps are calculated for each gain stage that is acquired in 3 separate runs.
+The following is a processing for the dark constants (`Offset`, `Noise`, and `BadPixelsDark`) maps using dark images taken with Gotthard2 detector (GH2 50um or 25um).
+All constants are evaluated per strip, per pulse, and per memory cell. The maps are calculated for each gain stage that is acquired in 3 separate runs.
 
-The three maps (calibration constants) can be injected to the database and stored locally.
+The three maps can be injected to the database and/or stored locally.
 
 ## JUNGFRAU
 
-- 
GitLab