Move interpolator from io to monitoring

docs/api-reference/monitoring/index.rst

@@ -18,9 +18,9 @@ Submodules
 
 .. toctree::
   :maxdepth: 1
-  :glob:
 
   aggregator
+  interpolation
   outlier
 
 

docs/api-reference/monitoring/interpolation.rst

@@ -0,0 +1,11 @@
+.. _monitoring_interpolation:
+
+*************
+Interpolation
+*************
+
+
+Reference/API
+=============
+
+.. automodapi:: ctapipe.monitoring.interpolation

docs/changes/2615.api.rst

@@ -0,0 +1 @@
+The ``PointingInterpolator`` was moved from ``ctapipe.io`` to ``ctapipe.monitoring``.

src/ctapipe/io/__init__.py

@@ -18,11 +18,6 @@
 
 from .datawriter import DATA_MODEL_VERSION, DataWriter
 
-from .interpolation import (
-    Interpolator,
-    PointingInterpolator,
-)
-
 __all__ = [
     "HDF5TableWriter",
     "HDF5TableReader",
@@ -40,6 +35,4 @@
     "DataWriter",
     "DATA_MODEL_VERSION",
     "get_hdf5_datalevels",
-    "Interpolator",
-    "PointingInterpolator",
 ]

src/ctapipe/io/hdf5eventsource.py

@@ -7,9 +7,7 @@
 from astropy.table import QTable
 from astropy.utils.decorators import lazyproperty
 
-from ctapipe.atmosphere import AtmosphereDensityProfile
-from ctapipe.instrument.optics import FocalLengthKind
-
+from ..atmosphere import AtmosphereDensityProfile
 from ..containers import (
     ArrayEventContainer,
     CameraHillasParametersContainer,
@@ -48,11 +46,12 @@
 from ..core import Container, Field
 from ..core.traits import UseEnum
 from ..instrument import SubarrayDescription
+from ..instrument.optics import FocalLengthKind
+from ..monitoring.interpolation import PointingInterpolator
 from .astropy_helpers import read_table
 from .datalevels import DataLevel
 from .eventsource import EventSource
 from .hdf5tableio import HDF5TableReader
-from .interpolation import PointingInterpolator
 from .tableloader import DL2_SUBARRAY_GROUP, DL2_TELESCOPE_GROUP, POINTING_GROUP
 
 __all__ = ["HDF5EventSource"]

src/ctapipe/io/tableloader.py

@@ -13,8 +13,8 @@
 
 from ..core import Component, Provenance, traits
 from ..instrument import FocalLengthKind, SubarrayDescription
+from ..monitoring.interpolation import PointingInterpolator
 from .astropy_helpers import join_allow_empty, read_table
-from .interpolation import PointingInterpolator
 
 __all__ = ["TableLoader"]
 

src/ctapipe/monitoring/__init__.py

@@ -0,0 +1,23 @@
+"""
+Module for handling monitoring data.
+"""
+from .aggregator import PlainAggregator, SigmaClippingAggregator, StatisticsAggregator
+from .interpolation import Interpolator, PointingInterpolator
+from .outlier import (
+    MedianOutlierDetector,
+    OutlierDetector,
+    RangeOutlierDetector,
+    StdOutlierDetector,
+)
+
+__all__ = [
+    "PlainAggregator",
+    "SigmaClippingAggregator",
+    "StatisticsAggregator",
+    "OutlierDetector",
+    "RangeOutlierDetector",
+    "MedianOutlierDetector",
+    "StdOutlierDetector",
+    "Interpolator",
+    "PointingInterpolator",
+]

src/ctapipe/monitoring/aggregator.py

@@ -25,6 +25,12 @@
 from ctapipe.core import TelescopeComponent
 from ctapipe.core.traits import Int
 
+__all__ = [
+    "StatisticsAggregator",
+    "PlainAggregator",
+    "SigmaClippingAggregator",
+]
+
 
 class StatisticsAggregator(TelescopeComponent):
     """

src/ctapipe/io/interpolation.py → src/ctapipe/monitoring/interpolation.py

@@ -9,7 +9,10 @@
 
 from ctapipe.core import Component, traits
 
-from .astropy_helpers import read_table
+__all__ = [
+    "Interpolator",
+    "PointingInterpolator",
+]
 
 
 class Interpolator(Component, metaclass=ABCMeta):
@@ -103,6 +106,9 @@ def _check_interpolators(self, tel_id):
                 raise KeyError(f"No table available for tel_id {tel_id}")
 
     def _read_parameter_table(self, tel_id):
+        # prevent circular import between io and monitoring
+        from ..io import read_table
+
         input_table = read_table(
             self.h5file,
             f"{self.telescope_data_group}/tel_{tel_id:03d}",

src/ctapipe/monitoring/outlier.py

@@ -1,6 +1,12 @@
 """
 Outlier detection algorithms to identify faulty pixels
 """
+from abc import abstractmethod
+
+import numpy as np
+
+from ctapipe.core import TelescopeComponent
+from ctapipe.core.traits import Float, List
 
 __all__ = [
     "OutlierDetector",
@@ -9,13 +15,6 @@
     "StdOutlierDetector",
 ]
 
-from abc import abstractmethod
-
-import numpy as np
-
-from ctapipe.core import TelescopeComponent
-from ctapipe.core.traits import Float, List
-
 
 class OutlierDetector(TelescopeComponent):
     """

src/ctapipe/io/tests/test_interpolator.py → src/ctapipe/monitoring/tests/test_interpolator.py

@@ -5,9 +5,7 @@
 from astropy.table import Table
 from astropy.time import Time
 
-from ctapipe.io.interpolation import (
-    PointingInterpolator,
-)
+from ctapipe.monitoring.interpolation import PointingInterpolator
 
 t0 = Time("2022-01-01T00:00:00")