CoDICE l1b lo and hi priority rates (#2451)

* validated priority rates l1b for lo and hi

* raised tolerance

* l1b constant

* fix test data path

Author: lacoak21

imap_processing/codice/constants.py

@@ -758,6 +758,13 @@
 # TODO: in the future, read from sci-lut
 LO_SW_ANGULAR_VARIABLE_NAMES = ["hplus", "heplusplus", "oplus6", "fe_loq"]
 LO_NSW_ANGULAR_VARIABLE_NAMES = ["heplusplus"]
+LO_SW_PRIORITY_VARIABLE_NAMES = [
+    "p0_tcrs",
+    "p1_hplus",
+    "p2_heplusplus",
+    "p3_heavies",
+    "p4_dcrs",
+]
 LO_NSW_PRIORITY_VARIABLE_NAMES = ["p5_heavies", "p6_hplus_heplusplus"]
 LO_SW_SPECIES_VARIABLE_NAMES = [
     "hplus",
@@ -868,6 +875,14 @@
 ]
 HI_OMNI_VARIABLE_NAMES = ["h", "he3", "he4", "c", "o", "ne_mg_si", "fe", "uh", "junk"]
 HI_SECTORED_VARIABLE_NAMES = ["h", "he3he4", "cno", "fe"]
+HI_PRIORITY_VARIABLE_NAMES = [
+    "priority0",
+    "priority1",
+    "priority2",
+    "priority3",
+    "priority4",
+    "priority5",
+]
 # Lookup table for CoDICE-Lo despinning pixel orientations
 # See section 9.3.4 of the algorithm document for further information
 PIXEL_ORIENTATIONS = {

imap_processing/tests/codice/test_codice_l1b.py

@@ -300,3 +300,95 @@ def test_l1b_hi_sectored(mock_get_file_paths, codice_lut_path):
     assert (
         cdf_file.name == f"imap_codice_l1b_hi-sectored_{VALIDATION_FILE_DATE}_v999.cdf"
     )
+
+
+@patch("imap_data_access.processing_input.ProcessingInputCollection.get_file_paths")
+def test_l1b_hi_priorities(mock_get_file_paths, codice_lut_path):
+    mock_get_file_paths.side_effect = [
+        codice_lut_path(descriptor="hi-priorities", data_type="l0"),
+        codice_lut_path(descriptor="l1a-sci-lut"),
+    ]
+    val_path = (
+        imap_module_directory
+        / "tests/codice/data/l1b_validation/"
+        / f"imap_codice_l1b_hi-priority_{VALIDATION_FILE_DATE}"
+        f"_{VALIDATION_FILE_VERSION}.cdf"
+    )
+    l1a_ds = process_l1a(ProcessingInputCollection())[0]
+    l1a_file_path = write_cdf(l1a_ds)
+    val_data = load_cdf(val_path)
+    processed_data = process_codice_l1b(file_path=l1a_file_path)
+    for variable in val_data.data_vars:
+        np.testing.assert_allclose(
+            processed_data[variable].values,
+            val_data[variable].values,
+            rtol=1.2e-5,
+            err_msg=f"Mismatch in variable '{variable}'",
+        )
+
+    cdf_file = write_cdf(processed_data)
+    assert (
+        cdf_file.name == f"imap_codice_l1b_hi-priority_{VALIDATION_FILE_DATE}_v999.cdf"
+    )
+
+
+@patch("imap_data_access.processing_input.ProcessingInputCollection.get_file_paths")
+def test_l1b_nsw_lo_priorities(mock_get_file_paths, codice_lut_path):
+    mock_get_file_paths.side_effect = [
+        codice_lut_path(descriptor="lo-nsw-priority", data_type="l0"),
+        codice_lut_path(descriptor="l1a-sci-lut"),
+    ]
+    val_path = (
+        imap_module_directory
+        / "tests/codice/data/l1b_validation/"
+        / f"imap_codice_l1b_lo-nsw-priority_{VALIDATION_FILE_DATE}"
+        f"_{VALIDATION_FILE_VERSION}.cdf"
+    )
+    l1a_ds = process_l1a(ProcessingInputCollection())[0]
+    l1a_file_path = write_cdf(l1a_ds)
+    val_data = load_cdf(val_path)
+    processed_data = process_codice_l1b(file_path=l1a_file_path)
+    for variable in val_data.data_vars:
+        np.testing.assert_allclose(
+            processed_data[variable].values,
+            val_data[variable].values,
+            rtol=1e-5,
+            err_msg=f"Mismatch in variable '{variable}'",
+        )
+
+    cdf_file = write_cdf(processed_data)
+    assert (
+        cdf_file.name
+        == f"imap_codice_l1b_lo-nsw-priority_{VALIDATION_FILE_DATE}_v999.cdf"
+    )
+
+
+@patch("imap_data_access.processing_input.ProcessingInputCollection.get_file_paths")
+def test_l1b_sw_lo_priorities(mock_get_file_paths, codice_lut_path):
+    mock_get_file_paths.side_effect = [
+        codice_lut_path(descriptor="lo-sw-priority", data_type="l0"),
+        codice_lut_path(descriptor="l1a-sci-lut"),
+    ]
+    val_path = (
+        imap_module_directory
+        / "tests/codice/data/l1b_validation/"
+        / f"imap_codice_l1b_lo-sw-priority_{VALIDATION_FILE_DATE}"
+        f"_{VALIDATION_FILE_VERSION}.cdf"
+    )
+    l1a_ds = process_l1a(ProcessingInputCollection())[0]
+    l1a_file_path = write_cdf(l1a_ds)
+    val_data = load_cdf(val_path)
+    processed_data = process_codice_l1b(file_path=l1a_file_path)
+    for variable in val_data.data_vars:
+        np.testing.assert_allclose(
+            processed_data[variable].values,
+            val_data[variable].values,
+            rtol=1e-5,
+            err_msg=f"Mismatch in variable '{variable}'",
+        )
+
+    cdf_file = write_cdf(processed_data)
+    assert (
+        cdf_file.name
+        == f"imap_codice_l1b_lo-sw-priority_{VALIDATION_FILE_DATE}_v999.cdf"
+    )

imap_processing/tests/external_test_data_config.py

@@ -63,7 +63,7 @@
     (f"imap_codice_l1b_hi-counters-singles_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),
     (f"imap_codice_l1b_hi-ialirt_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),
     (f"imap_codice_l1b_hi-omni_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),
-    (f"imap_codice_l1b_hi-priorities_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),
+    (f"imap_codice_l1b_hi-priority_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),
     (f"imap_codice_l1b_hi-sectored_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),
     (f"imap_codice_l1b_lo-counters-aggregated_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),
     (f"imap_codice_l1b_lo-counters-singles_{VALIDATION_FILE_DATE}_{VALIDATION_FILE_VERSION}.cdf", "codice/data/l1b_validation"),