[AGIPD] [Correct] Add parameter for gain_mode in AGIPD correction

Description

Older data does not have the AGIPD1MCTRL files containing this information. This adds a parameter so it can be manually specified.

How Has This Been Tested?

Running from CLI, at Oleksandr's request (https://in.xfel.eu/redmine/issues/116660)

xfel-calibrate agipd CORRECT --slurm-name correct_SPB_agipd_201801_p002120_r97 --cal-db-timeout 300000 --cal-db-interface tcp://max-exfl016:8015#8044 \
--karabo-da AGIPD00 AGIPD01 AGIPD02 AGIPD03 AGIPD04 AGIPD05 AGIPD06 AGIPD07 AGIPD08 AGIPD09 AGIPD10 AGIPD11 AGIPD12 AGIPD13 AGIPD14 AGIPD15 \
--receiver-id {}CH0 --karabo-id-control SPB_IRU_AGIPD1M1 --karabo-da-control AGIPD1MCTRL00 --h5path-ctrl /CONTROL/{}/MDL/FPGA_COMP --overwrite \
--sequences-per-node 1 --bias-voltage 300 --force-hg-if-below --hg-hard-threshold 1000 --force-mg-if-below --mg-hard-threshold 1000 --blc-stripes --cm-dark-range -30 30 \
--cm-dark-fraction 0.15 --cm-n-itr 4 --rel-gain --adjust-mg-baseline --blc-set-min --low-medium-gap --xray-gain --slopes-ff-from-files '' --ff-gain 7.3 \
--in-folder /gpfs/exfel/exp/SPB/201801/p002120/raw --out-folder /gpfs/exfel/data/scratch/kluyvert/agiprd-calib-p2120-r97 \
--karabo-id SPB_DET_AGIPD1M-1 --run 97 --integration-time 12 --gain-mode 0

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist:

• My code follows the code style of this project.

Reviewers

@schmidtp @hammerd

notebooks/AGIPD/AGIPD_Correct_and_Verify.ipynb

@@ -51,6 +51,7 @@
     "bias_voltage = 300 # Bias voltage\n",
     "acq_rate = 0. # the detector acquisition rate, use 0 to try to auto-determine\n",
     "gain_setting = 0.1 # the gain setting, use 0.1 to try to auto-determine\n",
+    "gain_mode = -1  # gain mode (0: adaptive, 1-3 fixed high/med/low, -1: read from CONTROL data)\n",
     "photon_energy = 9.2 # photon energy in keV\n",
     "overwrite = True # set to True if existing data should be overwritten\n",
     "max_pulses = [0, 352, 1] # range list [st, end, step] of memory cell indices to be processed within a train. 3 allowed maximum list input elements.\n",
@@ -158,7 +159,7 @@
     "    get_num_cells,\n",
     ")\n",
     "from cal_tools.ana_tools import get_range\n",
-    "from cal_tools.enums import BadPixels\n",
+    "from cal_tools.enums import AgipdGainMode, BadPixels\n",
     "from cal_tools.step_timing import StepTimer\n",
     "\n",
     "sns.set()\n",
@@ -443,7 +444,10 @@
     "            gain_setting = 0\n",
     "\n",
     "# Evaluate gain mode (operation mode)\n",
-    "gain_mode = get_gain_mode(control_fn, h5path_ctrl)\n",
+    "if gain_mode < 0:\n",
+    "    gain_mode = get_gain_mode(control_fn, h5path_ctrl)\n",
+    "else:\n",
+    "    gain_mode = AgipdGainMode(gain_mode)\n",
     "\n",
     "# Evaluate integration time\n",
     "if integration_time < 0:\n",
@@ -1247,7 +1251,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.11"
+   "version": "3.8.12"
   }
  },
  "nbformat": 4,