[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

notebooks/AGIPD/Characterize_AGIPD_Gain_Darks_NBC.ipynb

 cal_db_timeout = 3000000 # timeout on caldb requests"
 local_output = True # output constants locally
 db_output = False # output constants to database
+sort_runs = True  # Sort the selected dark runs. This flag is added for old data (e.g. 900174 r0011).
 
 mem_cells = 0 # number of memory cells used, set to 0 to automatically infer
 bias_voltage = 0 # bias voltage, set to 0 to use stored value in slow data.
     image_src=instrument_src_mod,
     ctrl_src=ctrl_src,
 )
-agipd_ctrl_dark.sort_dark_runs()
+if sort_runs:
+    agipd_ctrl_dark.sort_dark_runs()
 
 if mem_cells == 0:
     mem_cells = agipd_ctrl_dark.get_memory_cells()