Merge pull request #2854 from cta-observatory/sonar-fixes

Fix sonar complaints about float comparisons

Author: kosack

docs/conf.py

@@ -104,65 +104,82 @@ def setup(app):
         getattr(traits, alias).__module__ = "ctapipe.core.traits"
 
 
+def add_reference_type(prefix, objs):
+    return [(prefix, o) for o in objs]
+
+
 # These links are ignored in the checks, necessary due to broken intersphinx for
 # these
-nitpick_ignore = [
-    # needed for building the docs with python 3.11 locally.
-    # we use the lowest supported version on readthedocs,
-    # so that is what we use in the intersphinx link above
-    ("py:class", "enum.StrEnum"),
-    # these are coming from traitlets:
-    ("py:class", "t.Union"),
-    ("py:class", "t.Any"),
-    ("py:class", "t.Dict"),
-    ("py:class", "t.Optional"),
-    ("py:class", "t.Type"),
-    ("py:class", "t.List"),
-    ("py:class", "t.Tuple"),
-    ("py:class", "t.Sequence"),
-    ("py:class", "Config"),
-    ("py:class", "traitlets.config.configurable.Configurable"),
-    ("py:class", "traitlets.traitlets.HasTraits"),
-    ("py:class", "traitlets.traitlets.HasDescriptors"),
-    ("py:class", "traitlets.traitlets.TraitType"),
-    ("py:class", "traitlets.traitlets.BaseDescriptor"),
-    ("py:class", "traitlets.traitlets.List"),
-    ("py:class", "traitlets.traitlets.Container"),
-    ("py:class", "traitlets.traitlets.Instance"),
-    ("py:class", "traitlets.traitlets.ClassBasedTraitType"),
-    ("py:class", "traitlets.traitlets.Int"),
-    ("py:class", "traitlets.config.application.Application"),
-    ("py:class", "traitlets.utils.sentinel.Sentinel"),
-    ("py:class", "traitlets.traitlets.ObserveHandler"),
-    ("py:class", "traitlets.traitlets.T"),
-    ("py:class", "traitlets.traitlets.G"),
-    ("py:class", "Sentinel"),
-    ("py:class", "ObserveHandler"),
-    ("py:class", "dict[K, V]"),
-    ("py:class", "G"),
-    ("py:class", "K"),
-    ("py:class", "V"),
-    ("py:class", "StrDict"),
-    ("py:class", "ClassesType"),
-    ("py:class", "re.Pattern"),
-    ("py:class", "re.Pattern[t.Any]"),
-    ("py:class", "astropy.coordinates.baseframe.BaseCoordinateFrame"),
-    ("py:class", "astropy.table.table.Table"),
-    ("py:class", "eventio.simtel.simtelfile.SimTelFile"),
-    ("py:class", "ctapipe.compat.StrEnum"),
-    ("py:class", "ctapipe.compat.StrEnum"),
-    ("py:obj", "traitlets.traitlets.T"),
-    ("py:obj", "traitlets.traitlets.G"),
-    ("py:obj", "traitlets.traitlets.S"),
-    ("py:obj", "traitlets.config.boolean_flag"),
-    ("py:obj", "traitlets.TraitError"),
-    ("py:obj", "-v"),  # fix for wrong syntax in a traitlets docstring
-    ("py:obj", "cls"),
-    ("py:obj", "name"),
-    ("py:meth", "MetaHasDescriptors.__init__"),
-    ("py:meth", "HasTraits.__new__"),
-    ("py:meth", "BaseDescriptor.instance_init"),
-]
+nitpick_ignore = add_reference_type(
+    "py:class",
+    [
+        "enum.StrEnum",
+        "t.Union",
+        "t.Any",
+        "t.Dict",
+        "t.Optional",
+        "t.Type",
+        "t.List",
+        "t.Tuple",
+        "t.Sequence",
+        "Config",
+        "traitlets.config.configurable.Configurable",
+        "traitlets.traitlets.HasTraits",
+        "traitlets.traitlets.HasDescriptors",
+        "traitlets.traitlets.TraitType",
+        "traitlets.traitlets.BaseDescriptor",
+        "traitlets.traitlets.List",
+        "traitlets.traitlets.Container",
+        "traitlets.traitlets.Instance",
+        "traitlets.traitlets.ClassBasedTraitType",
+        "traitlets.traitlets.Int",
+        "traitlets.config.application.Application",
+        "traitlets.utils.sentinel.Sentinel",
+        "traitlets.traitlets.ObserveHandler",
+        "traitlets.traitlets.T",
+        "traitlets.traitlets.G",
+        "Sentinel",
+        "ObserveHandler",
+        "dict[K, V]",
+        "G",
+        "K",
+        "V",
+        "StrDict",
+        "ClassesType",
+        "re.Pattern",
+        "re.Pattern[t.Any]",
+        "astropy.coordinates.baseframe.BaseCoordinateFrame",
+        "astropy.table.table.Table",
+        "eventio.simtel.simtelfile.SimTelFile",
+        "ctapipe.compat.StrEnum",
+        "ctapipe.compat.StrEnum",
+    ],
+)
+nitpick_ignore += add_reference_type(
+    "py:obj",
+    [
+        # needed for building the docs with python 3.11 locally.
+        # we use the lowest supported version on readthedocs,
+        # so that is what we use in the intersphinx link above
+        # these are coming from traitlets:
+        "traitlets.traitlets.T",
+        "traitlets.traitlets.G",
+        "traitlets.traitlets.S",
+        "traitlets.config.boolean_flag",
+        "traitlets.TraitError",
+        "-v",  # fix for wrong syntax in a traitlets docstring
+        "cls",
+        "name",
+    ],
+)
+nitpick_ignore += add_reference_type(
+    "py:meth",
+    [
+        "MetaHasDescriptors.__init__",
+        "HasTraits.__new__",
+        "BaseDescriptor.instance_init",
+    ],
+)
 
 # Sphinx gallery config
 
@@ -379,15 +396,18 @@ def setup(app):
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
+description = (
+    "Experimental Data Analysis for the"
+    " Cherenkov Telescope Array Observatory (CTAO)."
+)
 texinfo_documents = [
     (
         master_doc,
         "ctapipe",
         "ctapipe Documentation",
         author,
         "ctapipe",
-        "Experimental Data Analysis for the"
-        "Cherenkov Telescope Array Observatory (CTAO).",
+        description,
         "Science",
     )
 ]

src/ctapipe/calib/camera/__init__.py

@@ -6,7 +6,7 @@
 from .calibrator import CameraCalibrator  # noqa: F401
 from .gainselection import GainSelector  # noqa: F401
 
-__all__ = [
-    # "CameraCalibrator",
-    # "GainSelector",
-]
+# CameraCalibrator and GainSelector not added to __all__ here to avoid
+# docs build error as it would result in the class being exposed at 3 levels
+# which is not supported by sphinx
+__all__ = []

src/ctapipe/calib/camera/tests/test_calibrator.py

@@ -6,6 +6,7 @@
 
 import astropy.units as u
 import numpy as np
+import pytest
 from scipy.stats import norm
 from traitlets.config import Config
 
@@ -367,8 +368,9 @@ def test_invalid_pixels(example_event, example_subarray):
         config=config,
     )
     calibrator(event)
-    assert np.all(event.dl1.tel[tel_id].image == 1.0)
-    assert np.all(event.dl1.tel[tel_id].peak_time == 20.0 / sampling_rate)
+    dl1 = event.dl1.tel[tel_id]
+    np.testing.assert_array_equal(dl1.image, 1.0)
+    np.testing.assert_array_equal(dl1.peak_time, 20.0 / sampling_rate)
 
     # test we can set the invalid pixel handler to None
     config.CameraCalibrator.invalid_pixel_handler_type = None
@@ -378,7 +380,7 @@ def test_invalid_pixels(example_event, example_subarray):
     )
     calibrator(event)
     assert event.dl1.tel[tel_id].image[0] == 9999
-    assert event.dl1.tel[tel_id].peak_time[0] == 10.0 / sampling_rate
+    assert event.dl1.tel[tel_id].peak_time[0] == pytest.approx(10.0 / sampling_rate)
 
 
 def test_no_gain_selection(prod5_gamma_simtel_path):

src/ctapipe/coordinates/tests/test_nominal_frame.py

@@ -1,6 +1,5 @@
 import astropy.units as u
 from astropy.coordinates import AltAz, SkyCoord
-from pytest import approx
 
 
 def test_nominal_to_horizontal_alt0_az0():
@@ -13,23 +12,23 @@ def test_nominal_to_horizontal_alt0_az0():
 
     nominal_coord = SkyCoord(fov_lon=1 * u.deg, fov_lat=0 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 1.0
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az, 1.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     nominal_coord = SkyCoord(fov_lon=-1 * u.deg, fov_lat=0 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.wrap_at("180d").deg == -1.0
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az.wrap_at("180d"), -1.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     nominal_coord = SkyCoord(fov_lon=0 * u.deg, fov_lat=1 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 0.0
-    assert horizon_coord.alt.deg == 1.0
+    assert u.isclose(horizon_coord.az, 0.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 1.0 * u.deg)
 
     nominal_coord = SkyCoord(fov_lon=0 * u.deg, fov_lat=-1 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 0.0
-    assert horizon_coord.alt.deg == -1.0
+    assert u.isclose(horizon_coord.az, 0.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, -1.0 * u.deg)
 
 
 def test_nominal_to_horizontal_alt0_az180():
@@ -42,20 +41,20 @@ def test_nominal_to_horizontal_alt0_az180():
 
     nominal_coord = SkyCoord(fov_lon=1 * u.deg, fov_lat=0 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == approx(181.0)
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az, 181.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     nominal_coord = SkyCoord(fov_lon=-1 * u.deg, fov_lat=0 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == approx(179.0)
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az, 179.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     nominal_coord = SkyCoord(fov_lon=0 * u.deg, fov_lat=1 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 180.0
-    assert horizon_coord.alt.deg == 1.0
+    assert u.isclose(horizon_coord.az, 180.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 1.0 * u.deg)
 
     nominal_coord = SkyCoord(fov_lon=0 * u.deg, fov_lat=-1 * u.deg, frame=nominal_frame)
     horizon_coord = nominal_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 180.0
-    assert horizon_coord.alt.deg == -1.0
+    assert u.isclose(horizon_coord.az, 180.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, -1.0 * u.deg)

src/ctapipe/coordinates/tests/test_telescope_frame.py

@@ -1,6 +1,5 @@
 import astropy.units as u
 from astropy.coordinates import AltAz, SkyCoord
-from pytest import approx
 
 
 def test_telescope_to_horizontal_alt0_az0():
@@ -15,29 +14,29 @@ def test_telescope_to_horizontal_alt0_az0():
         fov_lon=1 * u.deg, fov_lat=0 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 1.0
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az, 1.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     telescope_coord = SkyCoord(
         fov_lon=-1 * u.deg, fov_lat=0 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.wrap_at("180d").deg == -1.0
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az.wrap_at("180d"), -1.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     telescope_coord = SkyCoord(
         fov_lon=0 * u.deg, fov_lat=1 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 0.0
-    assert horizon_coord.alt.deg == 1.0
+    assert u.isclose(horizon_coord.az, 0.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 1.0 * u.deg)
 
     telescope_coord = SkyCoord(
         fov_lon=0 * u.deg, fov_lat=-1 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 0.0
-    assert horizon_coord.alt.deg == -1.0
+    assert u.isclose(horizon_coord.az, 0.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, -1.0 * u.deg)
 
 
 def test_telescope_to_horizontal_alt0_az180():
@@ -52,26 +51,26 @@ def test_telescope_to_horizontal_alt0_az180():
         fov_lon=1 * u.deg, fov_lat=0 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == approx(181.0)
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az, 181.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     telescope_coord = SkyCoord(
         fov_lon=-1 * u.deg, fov_lat=0 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == approx(179.0)
-    assert horizon_coord.alt.deg == 0.0
+    assert u.isclose(horizon_coord.az, 179.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 0.0 * u.deg)
 
     telescope_coord = SkyCoord(
         fov_lon=0 * u.deg, fov_lat=1 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 180.0
-    assert horizon_coord.alt.deg == 1.0
+    assert u.isclose(horizon_coord.az, 180.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, 1.0 * u.deg)
 
     telescope_coord = SkyCoord(
         fov_lon=0 * u.deg, fov_lat=-1 * u.deg, frame=telescope_frame
     )
     horizon_coord = telescope_coord.transform_to(horizon_frame)
-    assert horizon_coord.az.deg == 180.0
-    assert horizon_coord.alt.deg == -1.0
+    assert u.isclose(horizon_coord.az, 180.0 * u.deg)
+    assert u.isclose(horizon_coord.alt, -1.0 * u.deg)

src/ctapipe/reco/impact.py

@@ -758,7 +758,7 @@ class before minimisation can take place. This simply copies a
             self.spe[i][:] = 0.5
 
         # Set the image mask
-        mask = self.image == 0.0
+        mask = self.image <= 0.0
         self.pixel_x[mask], self.pixel_y[mask] = ma.masked, ma.masked
         self.image[mask] = ma.masked
         self.time[mask] = ma.masked

src/ctapipe/reco/tests/test_stereo_combination.py

@@ -239,4 +239,4 @@ def test_mean_prediction_single_event(weights):
         assert u.isclose(event.dl2.stereo.energy["dummy"].energy, 30 * u.GeV)
         assert u.isclose(event.dl2.stereo.geometry["dummy"].alt, 60.9748605 * u.deg)
         assert u.isclose(event.dl2.stereo.geometry["dummy"].az, 316.0365515 * u.deg)
-    assert event.dl2.stereo.classification["dummy"].prediction == 0.6
+    assert event.dl2.stereo.classification["dummy"].prediction == pytest.approx(0.6)