Harrison 3029/#54 - PMCL - CoDICE Lo DE: pass through esa_step from L1a lo-sw-priority

This is needed as the DEPEND_1 of half_spin_per_esa_step, and our `energy_bin` is in the opposite order.

Author: pleasant-menlo

imap_l3_processing/cdf/config/imap_codice_l3a_lo-direct-events_variable_attrs.yaml

@@ -505,4 +505,19 @@ nso_esa_step:
   VAR_NOTES: Indicates the energy step when No Scan Operation (NSO) was activated. In NSO, the ESA voltage is set to the first step in the scan and remains fixed until the next cycle boundary.
   VAR_TYPE: data
   VARIABLE_PURPOSE: ""
-  RECORD_VARYING: RV
+  RECORD_VARYING: RV
+
+esa_step:
+  NAME: esa_step
+  DATA_TYPE: CDF_UINT1
+  CATDESC: Energy per charge (E/q) sweeping step
+  FIELDNAM: Energy Index
+  FILLVAL: 255
+  FORMAT: I3
+  LABLAXIS: Energy Index
+  SCALETYP: linear
+  UNITS: " "
+  VALIDMIN: 0
+  VALIDMAX: 127
+  VAR_TYPE: support_data
+  RECORD_VARYING: NRV

imap_l3_processing/codice/l3/lo/codice_lo_processor.py

@@ -171,9 +171,6 @@ def process_l3a_direct_event_data_product(self, dependencies: CodiceLoL3aDirectE
         codice_direct_events = dependencies.codice_l2_direct_events
         esa_energy_per_charge_lookup = dependencies.energy_lookup
 
-        event_buffer = codice_direct_events.tof[0].shape[-1]
-        num_energies = codice_sw_priority_counts_l1a_data.p0_tcrs.shape[1]
-        num_spin_sectors = 2*codice_sw_priority_counts_l1a_data.p0_tcrs.shape[2]
         mass_coefficient_lookup = dependencies.mass_coefficient_lookup
         priority_counts = [
             codice_sw_priority_counts_l1a_data.p0_tcrs,
@@ -184,7 +181,6 @@ def process_l3a_direct_event_data_product(self, dependencies: CodiceLoL3aDirectE
             codice_nsw_priority_counts_l1a_data.p5_heavies,
             codice_nsw_priority_counts_l1a_data.p6_hplus_heplusplus
         ]
-        num_priorities = len(priority_counts)
 
         spin_angle_lut = SpinAngleLookup()
 
@@ -232,6 +228,7 @@ def process_l3a_direct_event_data_product(self, dependencies: CodiceLoL3aDirectE
             nso_esa_step=codice_sw_priority_counts_l1a_data.nso_esa_step,
             normalization_per_event=normalization_per_event,
             spin_sector=codice_direct_events.spin_sector,
+            esa_step=codice_sw_priority_counts_l1a_data.esa_step,
         )
 
     def process_l3a_3d_distribution_product(self, dependencies: CodiceLoL3a3dDistributionsDependencies):

imap_l3_processing/codice/l3/lo/models.py

@@ -159,6 +159,7 @@ class CodiceLoL1aSWPriorityRates:
     rgfo_esa_step: np.ndarray
     nso_spin_sector: np.ndarray
     nso_esa_step: np.ndarray
+    esa_step: np.ndarray
 
     @classmethod
     def read_from_cdf(cls, cdf_path: Path):
@@ -185,6 +186,7 @@ def read_from_cdf(cls, cdf_path: Path):
                 rgfo_esa_step=read_variable_and_mask_fill_values(cdf["rgfo_esa_step"]),
                 nso_spin_sector=read_variable_and_mask_fill_values(cdf["nso_spin_sector"]),
                 nso_esa_step=read_variable_and_mask_fill_values(cdf["nso_esa_step"]),
+                esa_step=read_variable_and_mask_fill_values(cdf["esa_step"]),
             )
 
 
@@ -323,6 +325,7 @@ def to_data_product_variables(self) -> list[DataProductVariable]:
 RGFO_ESA_STEP_VAR_NAME = "rgfo_esa_step"
 NSO_SPIN_SECTOR_VAR_NAME = "nso_spin_sector"
 NSO_ESA_STEP_VAR_NAME = "nso_esa_step"
+ESA_STEP_VAR_NAME = "esa_step"
 
 
 @dataclass
@@ -386,8 +389,7 @@ class CodiceLoL3aDirectEventDataProduct(CodiceLoDirectEventData, DataProduct):
     nso_esa_step: np.ndarray
     spin_sector: np.ndarray
     normalization_per_event: np.ndarray
-
-
+    esa_step: np.ndarray
 
     def __post_init__(self):
         self.priority_index = np.arange(CODICE_LO_L2_NUM_PRIORITIES)
@@ -438,6 +440,7 @@ def to_data_product_variables(self) -> list[DataProductVariable]:
             DataProductVariable(RGFO_ESA_STEP_VAR_NAME, self.rgfo_esa_step),
             DataProductVariable(NSO_SPIN_SECTOR_VAR_NAME, self.nso_spin_sector),
             DataProductVariable(NSO_ESA_STEP_VAR_NAME, self.nso_esa_step),
+            DataProductVariable(ESA_STEP_VAR_NAME, self.esa_step),
         ]
 
 

tests/codice/l3/lo/test_codice_lo_processor.py

@@ -534,6 +534,7 @@ def test_process_l3a_direct_events(self, mock_calculate_mass, mock_calculate_mas
         sw_priority_rates.rgfo_esa_step = rng.random(num_epochs)
         sw_priority_rates.nso_spin_sector = rng.random(num_epochs)
         sw_priority_rates.nso_esa_step = rng.random(num_epochs)
+        sw_priority_rates.esa_step = np.arange(128)
 
         nsw_priority_rates = create_dataclass_mock(CodiceLoL1aNSWPriorityRates)
         nsw_priority_rates.epoch = epochs
@@ -659,6 +660,7 @@ def test_process_l3a_direct_events(self, mock_calculate_mass, mock_calculate_mas
         np.testing.assert_array_equal(sw_priority_rates.rgfo_esa_step, l3a_direct_event_data_product.rgfo_esa_step)
         np.testing.assert_array_equal(sw_priority_rates.nso_spin_sector, l3a_direct_event_data_product.nso_spin_sector)
         np.testing.assert_array_equal(sw_priority_rates.nso_esa_step, l3a_direct_event_data_product.nso_esa_step)
+        np.testing.assert_array_equal(sw_priority_rates.esa_step, l3a_direct_event_data_product.esa_step)
 
     @patch('imap_l3_processing.codice.l3.lo.codice_lo_processor.convert_count_rate_to_intensity')
     @patch('imap_l3_processing.codice.l3.lo.codice_lo_processor.rebin_3d_distribution_azimuth_to_elevation')

tests/codice/l3/lo/test_models.py

@@ -373,6 +373,7 @@ def test_codice_lo_l3a_direct_event_to_data_product(self):
         spin_angle = np.array([30, 60, 90])
         energy_step = np.array([5.5, 6.6, 7.7])
         priority = np.arange(CODICE_LO_L2_NUM_PRIORITIES)
+        esa_step = np.arange(128)
 
         direct_event = CodiceLoL3aDirectEventDataProduct(
             input_metadata=Mock(),
@@ -404,6 +405,7 @@ def test_codice_lo_l3a_direct_event_to_data_product(self):
             nso_spin_sector=rng.random(len(epoch)),
             nso_esa_step=rng.random(len(epoch)),
             normalization_per_event=rng.random((len(epoch), len(priority), len(energy_step), len(spin_angle))),
+            esa_step=esa_step,
         )
 
         np.testing.assert_array_equal(direct_event.event_index, np.arange(len(event_num)))
@@ -452,6 +454,7 @@ def test_codice_lo_l1a_sw_priority_read_from_instrument_team_cdf(self):
             np.testing.assert_array_equal(actual_l1a_sw_priority_rates.rgfo_esa_step, cdf["rgfo_esa_step"][...])
             np.testing.assert_array_equal(actual_l1a_sw_priority_rates.nso_spin_sector, cdf["nso_spin_sector"][...])
             np.testing.assert_array_equal(actual_l1a_sw_priority_rates.nso_esa_step, cdf["nso_esa_step"][...])
+            np.testing.assert_array_equal(actual_l1a_sw_priority_rates.esa_step, cdf["esa_step"][...])
 
     def test_codice_lo_l1a_nsw_priority_read_from_instrument_team_cdf(self):
         instrument_team_cdf_path = get_test_instrument_team_data_path(

tests/periodically_run_tests.json

@@ -1,8 +1,8 @@
 {
     "test_l3bcde_first_time_processing": "2026-03-19T13:31:57.152750",
-    "test_spectral_fit_against_validation_data": "2026-03-19T16:58:54.969370",
-    "test_calculate_pickup_ions_with_minimize": "2026-03-16T08:50:14.379057",
-    "test_ultra_all_sp_maps": "2026-03-19T17:01:07.391919",
+    "test_spectral_fit_against_validation_data": "2026-03-23T10:37:49.828951",
+    "test_calculate_pickup_ions_with_minimize": "2026-03-23T10:40:37.460017",
+    "test_ultra_all_sp_maps": "2026-03-23T10:39:56.176185",
     "test_ultra_combined_maps": null,
     "test_ultra_combined_nsp_maps": "2026-03-20T14:32:30.413629",
     "test_ultra_combined_sp_maps": "2026-03-20T14:33:10.459309",