Drop support for image parameters in CameraFrame

Co-Authored-By: Stefan Fröse <[email protected]>

docs/changes/2396.api.rst

@@ -0,0 +1,7 @@
+Drop support for computing image parameters in ``CameraFrame`` (meters on the camera plane).
+Going forward, ctapipe only implements computing image parameters in telescope frame (degrees on the sky).
+
+* ``ctapipe-process`` and ``ImageProcessor`` no longer have options to chose between ``CameraFrame`` and ``TelescopeFrame```
+* All image parameter functions do not support inputs in length units anymore
+* If using these low-level functions directly in your code, you will need to transform your camera geometries into ``TelescopeFrame``
+  using ``geometry.transform_to(TelescopeFrame)``. This requires a correctly set ``frame`` attribute with a ``focal_length`` on the ``CameraGeometry``. If reading files using the ``SimTelEventSource`` or ``HDF5EventSource``, this is already the case, io plugins might need to adapt.

examples/algorithms/dilate_image.py

@@ -13,20 +13,21 @@
 # %matplotlib inline
 from matplotlib import pyplot as plt
 
+from ctapipe.coordinates import TelescopeFrame
 from ctapipe.image import dilate, tailcuts_clean, toymodel
 from ctapipe.instrument import SubarrayDescription
 from ctapipe.visualization import CameraDisplay
 
 # Load a camera from an example file
 subarray = SubarrayDescription.read("dataset://gamma_prod5.simtel.zst")
-geom = subarray.tel[100].camera.geometry
+geom = subarray.tel[100].camera.geometry.transform_to(TelescopeFrame())
 
 # Create a fake camera image to display:
 model = toymodel.Gaussian(
-    x=0.2 * u.m,
-    y=0.0 * u.m,
-    width=0.05 * u.m,
-    length=0.15 * u.m,
+    x=0.2 * u.deg,
+    y=0.0 * u.deg,
+    width=0.05 * u.deg,
+    length=0.15 * u.deg,
     psi="35d",
 )
 

examples/tutorials/calibrated_data_exploration.py

@@ -10,6 +10,7 @@
 
 import ctapipe
 from ctapipe.calib import CameraCalibrator
+from ctapipe.coordinates import TelescopeFrame
 from ctapipe.image import hillas_parameters, tailcuts_clean
 from ctapipe.io import EventSource
 from ctapipe.utils.datasets import get_dataset_path
@@ -98,7 +99,7 @@
 
 tel_id = sorted(event.r1.tel.keys())[1]
 sub = source.subarray
-geometry = sub.tel[tel_id].camera.geometry
+geometry = sub.tel[tel_id].camera.geometry.transform_to(TelescopeFrame())
 image = event.dl1.tel[tel_id].image
 
 ######################################################################
@@ -130,9 +131,8 @@
 disp.overlay_moments(params, color="red", lw=3)
 disp.highlight_pixels(mask, color="white", alpha=0.3, linewidth=2)
 
-plt.xlim(params.x.to_value(u.m) - 0.5, params.x.to_value(u.m) + 0.5)
-plt.ylim(params.y.to_value(u.m) - 0.5, params.y.to_value(u.m) + 0.5)
-
+plt.xlim(params.fov_lon.to_value(u.deg) - 2, params.fov_lon.to_value(u.deg) + 2)
+plt.ylim(params.fov_lat.to_value(u.deg) - 2, params.fov_lat.to_value(u.deg) + 2)
 ######################################################################
 source.metadata
 
@@ -166,6 +166,7 @@
 cams_in_event = tels_in_event.intersection(cam_ids)
 first_tel_id = list(cams_in_event)[0]
 tel = sub.tel[first_tel_id]
+tel_geom = tel.camera.geometry.transform_to(TelescopeFrame())
 print("{}s in event: {}".format(tel, cams_in_event))
 
 
@@ -174,7 +175,7 @@
 #
 
 image_sum = np.zeros_like(
-    tel.camera.geometry.pix_x.value
+    tel_geom.pix_x.value
 )  # just make an array of 0's in the same shape as the camera
 
 for tel_id in cams_in_event:
@@ -187,7 +188,7 @@
 
 plt.figure(figsize=(8, 8))
 
-disp = CameraDisplay(tel.camera.geometry, image=image_sum)
+disp = CameraDisplay(tel_geom, image=image_sum)
 disp.overlay_moments(params, with_label=False)
 plt.title("Sum of {}x {}".format(len(cams_in_event), tel))
 

examples/tutorials/ctapipe_handson.py

@@ -22,6 +22,7 @@
 
 from ctapipe import utils
 from ctapipe.calib import CameraCalibrator
+from ctapipe.coordinates import TelescopeFrame
 from ctapipe.image import hillas_parameters, tailcuts_clean
 from ctapipe.io import EventSource, HDF5TableWriter
 from ctapipe.visualization import CameraDisplay
@@ -129,20 +130,21 @@ def view_waveform(chan=0, pix_id=brightest_pixel):
 tel.optics
 
 ######################################################################
-tel.camera.geometry.pix_x
+geom = tel.camera.geometry.transform_to(TelescopeFrame())
+geom.pix_x
 
 ######################################################################
-tel.camera.geometry.to_table()
+geom.to_table()
 
 ######################################################################
 tel.optics.mirror_area
 
 
 ######################################################################
-disp = CameraDisplay(tel.camera.geometry)
+disp = CameraDisplay(geom)
 
 ######################################################################
-disp = CameraDisplay(tel.camera.geometry)
+disp = CameraDisplay(geom)
 disp.image = r0tel.waveform[
     0, :, 10
 ]  # display channel 0, sample 0 (try others like 10)
@@ -180,10 +182,10 @@ def view_waveform(chan=0, pix_id=brightest_pixel):
 dl1tel.peak_time
 
 ######################################################################
-CameraDisplay(tel.camera.geometry, image=dl1tel.image)
+CameraDisplay(geom, image=dl1tel.image)
 
 ######################################################################
-CameraDisplay(tel.camera.geometry, image=dl1tel.peak_time)
+CameraDisplay(geom, image=dl1tel.peak_time)
 
 
 ######################################################################
@@ -192,33 +194,33 @@ def view_waveform(chan=0, pix_id=brightest_pixel):
 
 
 image = dl1tel.image
-mask = tailcuts_clean(tel.camera.geometry, image, picture_thresh=10, boundary_thresh=5)
+mask = tailcuts_clean(geom, image, picture_thresh=10, boundary_thresh=5)
 mask
 
 ######################################################################
-CameraDisplay(tel.camera.geometry, image=mask)
+CameraDisplay(geom, image=mask)
 
 ######################################################################
 cleaned = image.copy()
 cleaned[~mask] = 0
 
 ######################################################################
-disp = CameraDisplay(tel.camera.geometry, image=cleaned)
+disp = CameraDisplay(geom, image=cleaned)
 disp.cmap = plt.cm.coolwarm
 disp.add_colorbar()
-plt.xlim(0.5, 1.0)
-plt.ylim(-1.0, 0.0)
+plt.xlim(1.0, 2.0)
+plt.ylim(-2.0, -1.0)
 
 ######################################################################
-params = hillas_parameters(tel.camera.geometry, cleaned)
+params = hillas_parameters(geom, cleaned)
 print(params)
 
 ######################################################################
-disp = CameraDisplay(tel.camera.geometry, image=cleaned)
+disp = CameraDisplay(geom, image=cleaned)
 disp.cmap = plt.cm.coolwarm
 disp.add_colorbar()
-plt.xlim(0.5, 1.0)
-plt.ylim(-1.0, 0.0)
+plt.xlim(1.0, 2.0)
+plt.ylim(-2.0, 1.0)
 disp.overlay_moments(params, color="white", lw=2)
 
 
@@ -258,9 +260,10 @@ def view_waveform(chan=0, pix_id=brightest_pixel):
 
     for tel_id, tel_data in event.dl1.tel.items():
         tel = source.subarray.tel[tel_id]
-        mask = tailcuts_clean(tel.camera.geometry, tel_data.image)
+        geom = tel.camera.geometry.transform_to(TelescopeFrame())
+        mask = tailcuts_clean(geom, tel_data.image)
         if np.count_nonzero(mask) > 0:
-            params = hillas_parameters(tel.camera.geometry[mask], tel_data.image[mask])
+            params = hillas_parameters(geom[mask], tel_data.image[mask])
 
 
 ######################################################################
@@ -271,8 +274,9 @@ def view_waveform(chan=0, pix_id=brightest_pixel):
 
         for tel_id, tel_data in event.dl1.tel.items():
             tel = source.subarray.tel[tel_id]
-            mask = tailcuts_clean(tel.camera.geometry, tel_data.image)
-            params = hillas_parameters(tel.camera.geometry[mask], tel_data.image[mask])
+            geom = tel.camera.geometry.transform_to(TelescopeFrame())
+            mask = tailcuts_clean(geom, tel_data.image)
+            params = hillas_parameters(geom[mask], tel_data.image[mask])
             writer.write("hillas", params)
 
 

examples/tutorials/ctapipe_overview.py

@@ -24,6 +24,7 @@
 from traitlets.config import Config
 
 from ctapipe.calib import CameraCalibrator
+from ctapipe.coordinates import TelescopeFrame
 from ctapipe.image import (
     ImageProcessor,
     camera_to_shower_coordinates,
@@ -202,7 +203,7 @@
 tel_id = 130
 
 ######################################################################
-geometry = source.subarray.tel[tel_id].camera.geometry
+geometry = source.subarray.tel[tel_id].camera.geometry.transform_to(TelescopeFrame())
 dl1 = event.dl1.tel[tel_id]
 
 geometry, dl1
@@ -293,7 +294,7 @@
 
 ######################################################################
 long, trans = camera_to_shower_coordinates(
-    geometry.pix_x, geometry.pix_y, hillas.x, hillas.y, hillas.psi
+    geometry.pix_x, geometry.pix_y, hillas.fov_lon, hillas.fov_lat, hillas.psi
 )
 
 plt.plot(long[clean], dl1.peak_time[clean], "o")
@@ -539,6 +540,7 @@
     )
     image += new_image
 
+geometry = geometry.transform_to(TelescopeFrame())
 ######################################################################
 clean = tailcuts_clean(
     geometry,

examples/visualization/camera_display.py

@@ -11,7 +11,7 @@
 from matplotlib.animation import FuncAnimation
 from matplotlib.colors import PowerNorm
 
-from ctapipe.coordinates import CameraFrame, EngineeringCameraFrame, TelescopeFrame
+from ctapipe.coordinates import EngineeringCameraFrame, TelescopeFrame
 from ctapipe.image import hillas_parameters, tailcuts_clean, toymodel
 from ctapipe.instrument import SubarrayDescription
 from ctapipe.io import EventSource
@@ -101,7 +101,7 @@
 #
 
 geom_camframe = geom
-geom = geom_camframe.transform_to(EngineeringCameraFrame())
+geom = geom_camframe.transform_to(TelescopeFrame())
 
 
 ######################################################################
@@ -198,9 +198,8 @@
 )
 disp.highlight_pixels(mask, alpha=1, linewidth=3, color="green")
 
-ax[1].set_ylim(-0.5, 0.5)
-ax[1].set_xlim(-0.5, 0.5)
-
+ax[1].set_ylim(-2, 2)
+ax[1].set_xlim(-2, 2)
 
 ######################################################################
 # Drawing a Hillas-parameter ellipse
@@ -228,7 +227,7 @@
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 # This depends on the coordinate frame of the ``CameraGeometry``. Here we
-# will specify the coordinate the ``EngineerngCameraFrame``, but if you
+# will specify the coordinate in the ``CameraFrame``, but if you
 # have enough information to do the coordinate transform, you could use
 # ``ICRS`` coordinates and overlay star positions. ``CameraDisplay`` will
 # convert the coordinate you pass in to the ``Frame`` of the display
@@ -243,12 +242,8 @@
 plt.figure(figsize=(6, 6))
 disp = CameraDisplay(geom, image=image, cmap="gray_r")
 
-coord = c.SkyCoord(x=0.5 * u.m, y=0.7 * u.m, frame=geom.frame)
-coord_in_another_frame = c.SkyCoord(x=0.5 * u.m, y=0.7 * u.m, frame=CameraFrame())
+coord = c.SkyCoord(x=0.5 * u.m, y=0.7 * u.m, frame=geom_camframe.frame)
 disp.overlay_coordinate(coord, markersize=20, marker="*")
-disp.overlay_coordinate(
-    coord_in_another_frame, markersize=20, marker="*", keep_old=True
-)
 
 
 ######################################################################
@@ -261,11 +256,11 @@
 
 
 subarray = SubarrayDescription.read("dataset://gamma_prod5.simtel.zst")
-geom = subarray.tel[1].camera.geometry
+geom = subarray.tel[1].camera.geometry.transform_to(TelescopeFrame())
 
-fov = 1.0
-maxwid = 0.05
-maxlen = 0.1
+fov = 2.0
+maxwid = 0.1
+maxlen = 0.5
 
 fig, ax = plt.subplots(1, 1, figsize=(8, 6))
 disp = CameraDisplay(geom, ax=ax)  # we only need one display (it can be re-used)
@@ -282,10 +277,10 @@ def update(frame):
     intens = width * length * (5e4 + 1e5 * np.random.exponential(2))
 
     model = toymodel.Gaussian(
-        x=x * u.m,
-        y=y * u.m,
-        width=width * u.m,
-        length=length * u.m,
+        x=x * u.deg,
+        y=y * u.deg,
+        width=width * u.deg,
+        length=length * u.deg,
         psi=angle * u.deg,
     )
     image, _, _ = model.generate_image(
@@ -344,7 +339,7 @@ def update(frame):
     event = next(iter(source))
 
 tel_id = list(event.r0.tel.keys())[0]
-geom = source.subarray.tel[tel_id].camera.geometry
+geom = source.subarray.tel[tel_id].camera.geometry.transform_to(TelescopeFrame())
 waveform = event.r0.tel[tel_id].waveform
 n_chan, n_pix, n_samp = waveform.shape
 

src/ctapipe/conftest.py

@@ -351,30 +351,6 @@ def dl1_divergent_file(dl1_tmp_path):
         return output
 
 
-@pytest.fixture(scope="session")
-def dl1_camera_frame_file(dl1_tmp_path, prod5_gamma_simtel_path):
-    """
-    DL1 file containing both images and parameters from a gamma simulation set.
-    """
-    from ctapipe.tools.process import ProcessorTool
-
-    output = dl1_tmp_path / "gamma_camera_frame.dl1.h5"
-
-    # prevent running process multiple times in case of parallel tests
-    with FileLock(output.with_suffix(output.suffix + ".lock")):
-        if output.is_file():
-            return output
-
-        argv = [
-            f"--input={prod5_gamma_simtel_path}",
-            f"--output={output}",
-            "--camera-frame",
-            "--write-images",
-        ]
-        assert run_tool(ProcessorTool(), argv=argv, cwd=dl1_tmp_path) == 0
-        return output
-
-
 @pytest.fixture(scope="session")
 def dl2_only_file(dl2_tmp_path, prod5_gamma_simtel_path):
     """