[AGIPD][DARK] Sort dark runs

Description

This is the second and last piece for sorting AGIPD dark runs

• Remove validate_gain_runs() function and moving needed error to new function.
• Create new function to sort dark runs.
• Add tests for the new function and remove tests for removed function
• Sort dark runs in Dark notebook before reading conditions.

Sorting dark runs

Expected patterns to use for sorting dark runs are:

• XRay: 0, DarkHG: 1, DarkMG: 2, DarkLG: 3, PC: 4, and CS: 5.

For Adaptive gain mode: All 3 runs have XRay patterns. On the other hand for fixed gain mode we expected DarkHG, DarkMG, and DarkLG patterns

Adaptive mode

For AGIPD1M patterns can be checked from ctrl_src/patternTypeIndex for the integer value or ctrl_src/patternType for the string value. However, AGIPD500K patterns can be checked from ctrl_src/expTypeIndex with integer value or expType for the string value.

Fixed Mode

Run order for fixed gain can only be decided using the gain modes.

How Has This Been Tested?

• TBD

Relevant Documents (optional)

Types of changes

• New feature (non-breaking change which adds functionality)
• Test (additional or refactored tests)

Checklist:

• A calibration_configuration updated for the know old proposals for AGIPD500K with sort_runs = False : An MR has the changes. To be merged with the next release

Reviewers

@kluyvert @schmidtp

tests/test_reference_runs/callab_tests.py

@@ -25,9 +25,10 @@ automated_test_config = {
             "out-folder": "{}/{}/{}",
             # "/gpfs/exfel/exp/SPB/202131/p900215/raw"
             "in-folder": "/gpfs/exfel/exp/CALLAB/202130/p900203/raw",
-            "run-high": "9011",  # Original run: "91"
+            # Unsorted dark runs
+            "run-high": "9013",  # Original run "93"
             "run-med": "9012",  # Original run: "92"
-            "run-low": "9013",  # Original run "93"
+            "run-low": "9011",  # Original run: "91"
             "karabo-id-control": "SPB_IRU_AGIPD1M1",
             "karabo-id": "SPB_DET_AGIPD1M-1",
             "ctrl-source-template": "{}/MDL/FPGA_COMP",
@@ -173,9 +174,10 @@ automated_test_config = {
             "out-folder": "{}/{}/{}",
             # "/gpfs/exfel/exp/HED/202131/p900228/raw"
             "in-folder": "/gpfs/exfel/exp/CALLAB/202130/p900203/raw",
+            # Unsorted dark runs
             "run-high": "9023", # Original run: "25",
-            "run-med": "9024",  # Original run: "26",
-            "run-low": "9025",  # Original run: "27",
+            "run-med": "9025",  # Original run: "27",
+            "run-low": "9024",  # Original run: "26",
             "karabo-id-control": "HED_EXP_AGIPD500K2G",
             "karabo-id": "HED_DET_AGIPD500K2G",
             "ctrl-source-template": "{}/MDL/FPGA_COMP",