Harrison #56 - PMCL - GLOWS L3e: Track Lo L1b NHK files as parents of Lo survival probability

We use these files to determine the Lo pivot angle for each repointing

Author: pleasant-menlo

imap_l3_processing/glows/glows_processor.py

@@ -445,9 +445,11 @@ def process_l3e(initializer_data: GlowsL3EInitializerOutput):
 
             with SwallowExceptionAndLog(f"Exception encountered when processing L3e lo for repointing {repointing}"):
                 lo_parent_file_names = initializer_data.dependencies.get_lo_parents()
-                lo_elongation = lo_pivot_angles[repointing]
+                pivot_info = lo_pivot_angles[repointing]
+                if pivot_info.parent_filename is not None:
+                    lo_parent_file_names = lo_parent_file_names + [pivot_info.parent_filename]
                 lo_version = initializer_data.repointings.lo_repointings[repointing]
-                products_list.extend(process_l3e_lo(lo_parent_file_names, repointing, start_repointing, epoch_delta, lo_elongation, lo_version))
+                products_list.extend(process_l3e_lo(lo_parent_file_names, repointing, start_repointing, epoch_delta, pivot_info.pivot_angle, lo_version))
 
             with SwallowExceptionAndLog(f"Exception encountered when processing L3e hi-90 for repointing {repointing}"):
                 hi_parent_file_names = initializer_data.dependencies.get_hi_parents()

imap_l3_processing/glows/l3e/glows_l3e_utils.py

@@ -142,7 +142,12 @@ def get_lo_pivot_angle_from_l1b_file(path: Path) -> float:
         return 90
     return np.round(np.median(angles_to_consider))
 
-def get_lo_pivot_angles(repointings: list[int]) -> dict[int, float]:
+@dataclass
+class LoPivotAngle:
+    parent_filename: Optional[str]
+    pivot_angle: float
+
+def get_lo_pivot_angles(repointings: list[int]) -> dict[int, LoPivotAngle]:
     l1b_results = imap_data_access.query(
         instrument="lo",
         data_level="l1b",
@@ -154,7 +159,7 @@ def get_lo_pivot_angles(repointings: list[int]) -> dict[int, float]:
     for repointing in repointings:
         if path := paths_by_repointing.get(repointing):
             downloaded_path = imap_data_access.download(path)
-            result[repointing] = get_lo_pivot_angle_from_l1b_file(downloaded_path)
+            result[repointing] = LoPivotAngle(parent_filename=Path(path).name, pivot_angle=get_lo_pivot_angle_from_l1b_file(downloaded_path))
         else:
-            result[repointing] = 90
+            result[repointing] = LoPivotAngle(parent_filename=None, pivot_angle=90)
     return result

tests/glows/l3e/test_glows_l3e_utils.py

@@ -10,7 +10,7 @@
 from imap_l3_processing.glows.l3e.glows_l3e_call_arguments import GlowsL3eCallArguments
 from imap_l3_processing.glows.l3e.glows_l3e_utils import determine_call_args_for_l3e_executable, \
     determine_l3e_files_to_produce, find_first_updated_cr, get_lo_pivot_angles, \
-    get_lo_pivot_angle_from_l1b_file
+    get_lo_pivot_angle_from_l1b_file, LoPivotAngle
 from tests.test_helpers import get_test_data_path, create_mock_query_results
 
 
@@ -285,4 +285,9 @@ def mock_read_from_cdf(path: Path):
             call("file4.cdf"),
             call("file6.cdf"),
         ])
-        self.assertEqual({3: 105, 4: 90, 6: 84, 10: 90}, result)
+        self.assertEqual({
+            3: LoPivotAngle(parent_filename="file3.cdf", pivot_angle=105),
+            4: LoPivotAngle(parent_filename="file4.cdf", pivot_angle=90),
+            6: LoPivotAngle(parent_filename="file6.cdf", pivot_angle=84),
+            10: LoPivotAngle(parent_filename=None, pivot_angle=90),
+        }, result)

tests/glows/test_glows_processor.py

@@ -37,7 +37,7 @@
 from imap_l3_processing.glows.l3e.glows_l3e_initializer import GlowsL3EInitializerOutput
 from imap_l3_processing.glows.l3e.glows_l3e_lo_model import GlowsL3ELoData
 from imap_l3_processing.glows.l3e.glows_l3e_ultra_model import GlowsL3EUltraData
-from imap_l3_processing.glows.l3e.glows_l3e_utils import GlowsL3eRepointings
+from imap_l3_processing.glows.l3e.glows_l3e_utils import GlowsL3eRepointings, LoPivotAngle
 from imap_l3_processing.models import InputMetadata
 from imap_l3_processing.utils import save_data
 from tests.test_helpers import get_test_instrument_team_data_path, get_test_data_path, get_test_data_folder, \
@@ -1045,7 +1045,7 @@ def test_process_l3e(self, mock_process_ultra, mock_process_ultra_hf, mock_proce
         mock_process_lo.return_value = [Path('path/to/lo_l3e')]
         mock_process_ultra.return_value = [Path('path/to/ultra_l3e')]
         mock_process_ultra_hf.return_value = [Path('path/to/ultra_l3e_hf')]
-        mock_get_lo_pivot_angles.return_value = {25: 75}
+        mock_get_lo_pivot_angles.return_value = {25: LoPivotAngle("l1b_nhk.cdf",75)}
 
         expected_l3e_products = [
             Path('path/to/lo_l3e'),
@@ -1083,7 +1083,7 @@ def test_process_l3e(self, mock_process_ultra, mock_process_ultra_hf, mock_proce
             call(["hi_ancillary.dat"], 25, start_epoch, epoch_delta, 90, 1),
             call(["hi_ancillary.dat"], 25, start_epoch, epoch_delta, 135, 2)
         ])
-        mock_process_lo.assert_called_once_with(["lo_ancillary.dat"], 25, start_epoch, epoch_delta, 75,
+        mock_process_lo.assert_called_once_with(["lo_ancillary.dat", "l1b_nhk.cdf"], 25, start_epoch, epoch_delta, 75,
                                                 3)
         mock_process_ultra.assert_called_once_with(["ul_ancillary.dat"], 25, start_epoch, epoch_delta, 4)
         mock_process_ultra_hf.assert_called_once_with(["ul_ancillary.dat"], 25, start_epoch, epoch_delta, 4)
@@ -1433,10 +1433,10 @@ def test_process_l3e_skips_repointing_on_exception(self, mock_process_ultra, moc
             ValueError("Failed to generate ultra!")
         ]
         mock_get_lo_pivot_angles.return_value = {
-            24: 124,
-            25: 125,
-            26: 126,
-            27: 127,
+            24: LoPivotAngle(parent_filename="l1b_nhk_24", pivot_angle=124),
+            25: LoPivotAngle(parent_filename="l1b_nhk_25", pivot_angle=125),
+            26: LoPivotAngle(parent_filename="l1b_nhk_26", pivot_angle=126),
+            27: LoPivotAngle(parent_filename=None, pivot_angle=90),
         }
 
         expected_l3e_products = [
@@ -1516,10 +1516,10 @@ def test_process_l3e_skips_repointing_on_exception(self, mock_process_ultra, moc
             call(hi_parents, 27, start_epoch_4, epoch_delta_4, 135, 2)
         ])
         mock_process_lo.assert_has_calls([
-            call(lo_parents, 24, start_epoch_1, epoch_delta_1, 124, 3),
-            call(lo_parents, 25, start_epoch_2, epoch_delta_2, 125, 3),
-            call(lo_parents, 26, start_epoch_3, epoch_delta_3, 126, 3),
-            call(lo_parents, 27, start_epoch_4, epoch_delta_4, 127, 3),
+            call(lo_parents + ["l1b_nhk_24"], 24, start_epoch_1, epoch_delta_1, 124, 3),
+            call(lo_parents + ["l1b_nhk_25"], 25, start_epoch_2, epoch_delta_2, 125, 3),
+            call(lo_parents + ["l1b_nhk_26"], 26, start_epoch_3, epoch_delta_3, 126, 3),
+            call(lo_parents, 27, start_epoch_4, epoch_delta_4, 90, 3),
         ])
 
         mock_process_ultra.assert_has_calls([