Decouple spline staging from class declaration

requirements-all.txt

@@ -10,7 +10,7 @@ astropy==5.2.2
     #   icecube-skyreader
 cachetools==5.3.0
     # via wipac-rest-tools
-certifi==2022.12.7
+certifi==2023.5.7
     # via
     #   pulsar-client
     #   requests
@@ -28,9 +28,9 @@ cycler==0.11.0
     # via matplotlib
 ed25519==1.5
     # via nkeys
-ewms-pilot==0.10.0
+ewms-pilot==0.10.2
     # via skymap-scanner (setup.py)
-fonttools==4.39.3
+fonttools==4.39.4
     # via matplotlib
 healpy==1.16.2
     # via
@@ -80,7 +80,7 @@ packaging==23.1
     #   matplotlib
 pandas==2.0.1
     # via icecube-skyreader
-pika==1.3.1
+pika==1.3.2
     # via oms-mqclient
 pillow==9.5.0
     # via matplotlib
@@ -117,7 +117,7 @@ scipy==1.10.1
     # via healpy
 six==1.16.0
     # via python-dateutil
-tornado==6.3.1
+tornado==6.3.2
     # via wipac-rest-tools
 types-cryptography==3.3.23.2
     # via pyjwt

requirements-client-starter.txt

@@ -10,7 +10,7 @@ astropy==5.2.2
     #   icecube-skyreader
 cachetools==5.3.0
     # via wipac-rest-tools
-certifi==2022.12.7
+certifi==2023.5.7
     # via requests
 cffi==1.15.1
     # via cryptography
@@ -24,9 +24,9 @@ cryptography==40.0.2
     # via pyjwt
 cycler==0.11.0
     # via matplotlib
-ewms-pilot==0.10.0
+ewms-pilot==0.10.2
     # via skymap-scanner (setup.py)
-fonttools==4.39.3
+fonttools==4.39.4
     # via matplotlib
 healpy==1.16.2
     # via
@@ -107,7 +107,7 @@ scipy==1.10.1
     # via healpy
 six==1.16.0
     # via python-dateutil
-tornado==6.3.1
+tornado==6.3.2
     # via wipac-rest-tools
 types-cryptography==3.3.23.2
     # via pyjwt

requirements-nats.txt

@@ -10,7 +10,7 @@ astropy==5.2.2
     #   icecube-skyreader
 cachetools==5.3.0
     # via wipac-rest-tools
-certifi==2022.12.7
+certifi==2023.5.7
     # via requests
 cffi==1.15.1
     # via cryptography
@@ -26,9 +26,9 @@ cycler==0.11.0
     # via matplotlib
 ed25519==1.5
     # via nkeys
-ewms-pilot==0.10.0
+ewms-pilot==0.10.2
     # via skymap-scanner (setup.py)
-fonttools==4.39.3
+fonttools==4.39.4
     # via matplotlib
 healpy==1.16.2
     # via
@@ -111,7 +111,7 @@ scipy==1.10.1
     # via healpy
 six==1.16.0
     # via python-dateutil
-tornado==6.3.1
+tornado==6.3.2
     # via wipac-rest-tools
 types-cryptography==3.3.23.2
     # via pyjwt

requirements-pulsar.txt

@@ -10,7 +10,7 @@ astropy==5.2.2
     #   icecube-skyreader
 cachetools==5.3.0
     # via wipac-rest-tools
-certifi==2022.12.7
+certifi==2023.5.7
     # via
     #   pulsar-client
     #   requests
@@ -26,9 +26,9 @@ cryptography==40.0.2
     # via pyjwt
 cycler==0.11.0
     # via matplotlib
-ewms-pilot==0.10.0
+ewms-pilot==0.10.2
     # via skymap-scanner (setup.py)
-fonttools==4.39.3
+fonttools==4.39.4
     # via matplotlib
 healpy==1.16.2
     # via
@@ -109,7 +109,7 @@ scipy==1.10.1
     # via healpy
 six==1.16.0
     # via python-dateutil
-tornado==6.3.1
+tornado==6.3.2
     # via wipac-rest-tools
 types-cryptography==3.3.23.2
     # via pyjwt

requirements-rabbitmq.txt

@@ -10,7 +10,7 @@ astropy==5.2.2
     #   icecube-skyreader
 cachetools==5.3.0
     # via wipac-rest-tools
-certifi==2022.12.7
+certifi==2023.5.7
     # via requests
 cffi==1.15.1
     # via cryptography
@@ -24,9 +24,9 @@ cryptography==40.0.2
     # via pyjwt
 cycler==0.11.0
     # via matplotlib
-ewms-pilot==0.10.0
+ewms-pilot==0.10.2
     # via skymap-scanner (setup.py)
-fonttools==4.39.3
+fonttools==4.39.4
     # via matplotlib
 healpy==1.16.2
     # via
@@ -72,7 +72,7 @@ packaging==23.1
     #   matplotlib
 pandas==2.0.1
     # via icecube-skyreader
-pika==1.3.1
+pika==1.3.2
     # via oms-mqclient
 pillow==9.5.0
     # via matplotlib
@@ -107,7 +107,7 @@ scipy==1.10.1
     # via healpy
 six==1.16.0
     # via python-dateutil
-tornado==6.3.1
+tornado==6.3.2
     # via wipac-rest-tools
 types-cryptography==3.3.23.2
     # via pyjwt

requirements.txt

@@ -10,7 +10,7 @@ astropy==5.2.2
     #   icecube-skyreader
 cachetools==5.3.0
     # via wipac-rest-tools
-certifi==2022.12.7
+certifi==2023.5.7
     # via requests
 cffi==1.15.1
     # via cryptography
@@ -24,9 +24,9 @@ cryptography==40.0.2
     # via pyjwt
 cycler==0.11.0
     # via matplotlib
-ewms-pilot==0.10.0
+ewms-pilot==0.10.2
     # via skymap-scanner (setup.py)
-fonttools==4.39.3
+fonttools==4.39.4
     # via matplotlib
 healpy==1.16.2
     # via
@@ -105,7 +105,7 @@ scipy==1.10.1
     # via healpy
 six==1.16.0
     # via python-dateutil
-tornado==6.3.1
+tornado==6.3.2
     # via wipac-rest-tools
 types-cryptography==3.3.23.2
     # via pyjwt

skymap_scanner/client/reco_icetray.py

@@ -139,9 +139,14 @@ def notifyStart(frame):
             base_filename=baseline_GCD_file,
         )
 
+    # create instance of reco_algo object
+    RecoAlgo = recos.get_reco_interface_object(reco_algo)
+    reco = RecoAlgo()
+    reco.setup_reco()
+
     # perform fit
     tray.AddSegment(
-        recos.get_reco_interface_object(reco_algo).traysegment,
+        reco.traysegment,
         f"{reco_algo}_traysegment",
         logger=LOGGER,
         seed=pframe[f"{cfg.OUTPUT_PARTICLE_NAME}"],

skymap_scanner/recos/__init__.py

@@ -8,6 +8,9 @@
 if TYPE_CHECKING:  # https://stackoverflow.com/a/65265627
     from ..utils.pixel_classes import RecoPixelVariation
 
+from .. import config as cfg
+from ..utils.data_handling import DataStager
+
 try:  # these are only used for typehints, so mock imports are fine
     from icecube.dataclasses import I3Position  # type: ignore[import]
     from icecube.icetray import I3Frame  # type: ignore[import]
@@ -31,6 +34,21 @@ class RecoInterface:
     # The spline files will be looked up in pre-defined local paths or fetched from a remote data store.
     SPLINE_REQUIREMENTS: List[str] = list()
 
+    def init(self):
+        raise NotImplementedError()
+
+    def setup_reco(self):
+        """Performs the necessary operations to prepare the execution of the reconstruction traysegment."""
+        raise NotImplementedError()
+
+    def get_datastager(self):
+        datastager = DataStager(
+            local_paths=cfg.LOCAL_DATA_SOURCES,
+            local_subdir=cfg.LOCAL_SPLINE_SUBDIR,
+            remote_path=f"{cfg.REMOTE_DATA_SOURCE}/{cfg.REMOTE_SPLINE_SUBDIR}",
+        )
+        return datastager
+
     @staticmethod
     def traysegment(tray, name, logger, **kwargs: Any) -> None:
         raise NotImplementedError()
@@ -49,13 +67,12 @@ def get_all_reco_algos() -> List[str]:
     ]
 
 
-def get_reco_interface_object(name: str) -> RecoInterface:
+def get_reco_interface_object(name: str) -> type[RecoInterface]:
     """Dynamically import the reco sub-module's class."""
     try:
         # Fetch module
         module = importlib.import_module(f"{__name__}.{name.lower()}")
-        # Build the class name (i.e. reco_algo -> RecoAlgo).
-        return getattr(module, "".join(x.capitalize() for x in name.split("_")))
+        return module.RECO_CLASS
     except ModuleNotFoundError as e:
         if name not in get_all_reco_algos():
             # checking this in 'except' allows us to use 'from e'

skymap_scanner/recos/dummy.py

@@ -4,7 +4,7 @@
 import datetime
 import random
 import time
-from typing import List
+from typing import List, Final
 
 from I3Tray import I3Units  # type: ignore[import]
 from icecube import (  # type: ignore[import]  # noqa: F401
@@ -28,6 +28,12 @@
 class Dummy(RecoInterface):
     """Logic for a dummy reco."""
 
+    def __init__(self):
+        pass
+
+    def setup_reco(self):
+        pass
+
     @staticmethod
     @icetray.traysegment
     def traysegment(tray, name, logger, **kwargs):
@@ -69,3 +75,7 @@ def to_recopixelvariation(frame: I3Frame, geometry: I3Frame) -> RecoPixelVariati
             time=frame["Dummy_time"].value,
             energy=frame["Dummy_time"].value,
         )
+
+
+# Provide a standard alias for the reconstruction class provided by this module.
+RECO_CLASS: Final[type[RecoInterface]] = Dummy