Add i09-1 converter (#145)

* first

* add_i09_hu_lut_converter

* remove unnecessary i09_hu_lut.txt

* reply review

* units to lowercase

---------

Co-authored-by: eir17846 <[email protected]>

Author: Villtord

src/daq_config_server/models/converters/_file_converter_map.py

@@ -13,6 +13,7 @@
     beamline_pitch_lut,
     beamline_roll_lut,
     detector_xy_lut,
+    i09_hu_undulator_energy_gap_lut,
     undulator_energy_gap_lut,
 )
 
@@ -40,4 +41,5 @@
     "/dls_sw/i03/software/daq_configuration/lookup/BeamLineEnergy_DCM_Pitch_converter.txt": beamline_pitch_lut,  # noqa
     "/dls_sw/i03/software/daq_configuration/lookup/BeamLineEnergy_DCM_Roll_converter.txt": beamline_roll_lut,  # noqa
     "/dls_sw/i03/software/daq_configuration/lookup/BeamLine_Undulator_toGap.txt": undulator_energy_gap_lut,  # noqa
+    "/dls_sw/i09-1/software/gda/workspace_git/gda-diamond.git/configurations/i09-1-shared/lookupTables/IIDCalibrationTable.txt": i09_hu_undulator_energy_gap_lut,  # noqa: E501
 }

src/daq_config_server/models/converters/lookup_tables/__init__.py

@@ -2,6 +2,7 @@
     beamline_pitch_lut,
     beamline_roll_lut,
     detector_xy_lut,
+    i09_hu_undulator_energy_gap_lut,
     undulator_energy_gap_lut,
 )
 from ._models import GenericLookupTable
@@ -12,4 +13,5 @@
     "beamline_pitch_lut",
     "beamline_roll_lut",
     "undulator_energy_gap_lut",
+    "i09_hu_undulator_energy_gap_lut",
 ]

src/daq_config_server/models/converters/lookup_tables/_converters.py

@@ -4,6 +4,8 @@
 
 from ._models import GenericLookupTable
 
+IGNORE_LINES_STARTING_WITH = ("Units", "ScannableUnits", "ScannableNames")
+
 
 def parse_lut(contents: str, *params: tuple[str, type | None]) -> GenericLookupTable:
     """Converts a lookup table to a pydantic model, containing the names of each column
@@ -18,7 +20,7 @@ def parse_lut(contents: str, *params: tuple[str, type | None]) -> GenericLookupT
     column_names = [param[0] for param in params]
     types = [param[1] for param in params]
     for line in remove_comments(contents.splitlines()):
-        if line.startswith("Units"):
+        if line.startswith(IGNORE_LINES_STARTING_WITH):
             continue
         rows.append(
             [parse_value(value, types[i]) for i, value in enumerate(line.split())]
@@ -45,3 +47,17 @@ def beamline_roll_lut(contents: str) -> GenericLookupTable:
 
 def undulator_energy_gap_lut(contents: str) -> GenericLookupTable:
     return parse_lut(contents, ("energy_eV", int), ("gap_mm", float))
+
+
+def i09_hu_undulator_energy_gap_lut(contents: str) -> GenericLookupTable:
+    return parse_lut(
+        contents,
+        ("order", int),
+        ("ring_energy_gev", float),
+        ("magnetic_field_t", float),
+        ("energy_min_ev", float),
+        ("energy_max_ev", float),
+        ("gap_min_mm", float),
+        ("gap_max_mm", float),
+        ("gap_offset_mm", float),
+    )

tests/unit_tests/converters/test_lookup_tables_converters.py

@@ -8,6 +8,7 @@
     beamline_pitch_lut,
     beamline_roll_lut,
     detector_xy_lut,
+    i09_hu_undulator_energy_gap_lut,
     undulator_energy_gap_lut,
 )
 from daq_config_server.models.converters.lookup_tables._converters import parse_lut
@@ -117,6 +118,34 @@ def test_undulator_gap_lut_gives_expected_result():
     assert result == expected
 
 
+def test_i09_hu_undulator_gap_lut_gives_expected_result():
+    input = (
+        "#I09 Hard X-ray ID calibration parameters, created 18 July 2012\n"
+        "ScannableNames	n	Ee	Br	Epmin	Epmax	Gmin	Gmax	Goffset\n"
+        "ScannableUnits	ONE	GeV	T	KeV	Kev	mm	mm\n"
+        "1	3.00089	0.98928	2.12	3.05	14.2650	23.7200	0.0\n"
+        "2	3.04129	1.02504	2.50	2.80	5.05165	8.88007	0.0\n"
+    )
+    expected = GenericLookupTable(
+        column_names=[
+            "order",
+            "ring_energy_gev",
+            "magnetic_field_t",
+            "energy_min_ev",
+            "energy_max_ev",
+            "gap_min_mm",
+            "gap_max_mm",
+            "gap_offset_mm",
+        ],
+        rows=[
+            [1, 3.00089, 0.98928, 2.12, 3.05, 14.2650, 23.7200, 0.0],
+            [2, 3.04129, 1.02504, 2.50, 2.80, 5.05165, 8.88007, 0.0],
+        ],
+    )
+    result = i09_hu_undulator_energy_gap_lut(input)
+    assert result == expected
+
+
 @pytest.mark.parametrize(
     "args, expected_value",
     [