Replace "infos" with "info" across the codebase for proper English usage

Author: PierreRaybaut

CHANGELOG.md

@@ -82,7 +82,7 @@ Other dependencies have been updated:
   * Added `info_callback` argument to all annotation class constructors
   * Added `set_info_callback` method to all annotation classes
   * The `info_callback` is a function that takes the annotation object and returns a string with the information to display
-  * Default `info_callback` is redirected to the `get_infos` method of the annotation object (this makes the feature backward compatible)
+  * Default `info_callback` is redirected to the `get_info` method of the annotation object (this makes the feature backward compatible)
 
 🛠️ Bug fixes:
 

plotpy/io.py

@@ -435,11 +435,11 @@ def _imwrite_dcm(filename, arr, template=None):
         "The `template` keyword argument is required to save DICOM files\n"
         "(that is the template DICOM structure object)"
     )
-    infos = np.iinfo(arr.dtype)
-    template.BitsAllocated = infos.bits
-    template.BitsStored = infos.bits
-    template.HighBit = infos.bits - 1
-    template.PixelRepresentation = ("u", "i").index(infos.kind)
+    info = np.iinfo(arr.dtype)
+    template.BitsAllocated = info.bits
+    template.BitsStored = info.bits
+    template.HighBit = info.bits - 1
+    template.PixelRepresentation = ("u", "i").index(info.kind)
     data_vr = ("US", "SS")[template.PixelRepresentation]
     template.Rows = arr.shape[0]
     template.Columns = arr.shape[1]

plotpy/items/annotation.py

@@ -74,7 +74,7 @@ def __init__(
 
             def info_callback(annotation: AnnotatedShape) -> str:
                 """Return information on annotation"""
-                return annotation.get_infos()
+                return annotation.get_info()
 
         self.info_callback = info_callback
         self.shape: AbstractShape = self.create_shape()
@@ -231,11 +231,11 @@ def get_text(self) -> str:
                 text += "<br>"
             text += f"<i>{subtitle}</i>"
         if self.area_computations_visible:
-            infos = self.info_callback(self)
-            if infos:
+            info = self.info_callback(self)
+            if info:
                 if text:
                     text += "<br>"
-                text += infos
+                text += info
         return text
 
     def x_to_str(self, x: float) -> str:
@@ -304,7 +304,7 @@ def get_tr_size_str(self):
         xs, ys = self.get_tr_size()
         return f"{self.x_to_str(xs)} x {self.y_to_str(ys)}"
 
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:
@@ -525,7 +525,7 @@ def get_tr_position(self):
         xt, yt = self.apply_transform_matrix(*self.shape.points[0])
         return xt, yt
 
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:
@@ -593,7 +593,7 @@ def set_label_position(self):
         self.label.set_pos(*compute_center(x1, y1, x2, y2))
 
     # ----AnnotatedShape API-----------------------------------------------------
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:
@@ -754,7 +754,7 @@ def get_tr_center(self) -> tuple[float, float]:
         """Return shape center coordinates after applying transform matrix"""
         return self.shape.get_center()
 
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:
@@ -820,7 +820,7 @@ def get_tr_size(self):
         """Return shape size after applying transform matrix"""
         return compute_rect_size(*self.get_transformed_coords(0, 2))
 
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:
@@ -912,7 +912,7 @@ def get_tr_size(self):
         return dx, dy
 
     # ----AnnotatedShape API-----------------------------------------------------
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:
@@ -1033,7 +1033,7 @@ def get_tr_size(self):
             dx, dy = dy, dx
         return dx, dy
 
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:
@@ -1064,7 +1064,7 @@ def get_tr_diameter(self):
         return compute_distance(*self.get_transformed_coords(0, 1))
 
     # ----AnnotatedShape API-------------------------------------------------
-    def get_infos(self) -> str:
+    def get_info(self) -> str:
         """Get informations on current shape
 
         Returns:

plotpy/items/label.py

@@ -1078,22 +1078,22 @@ class DataInfoLabel(LabelItem):
 
     Args:
         labelparam: Label parameters
-        infos: List of objects implementing the ``get_text`` method
+        info: List of objects implementing the ``get_text`` method
     """
 
     __implements__ = (IBasePlotItem,)
 
     def __init__(
-        self, labelparam: LabelParam | None = None, infos: list[Any] | None = None
+        self, labelparam: LabelParam | None = None, info: list[Any] | None = None
     ) -> None:
         super().__init__(None, labelparam)
-        if isinstance(infos, ObjectInfo):
-            infos = [infos]
-        self.infos = infos
+        if isinstance(info, ObjectInfo):
+            info = [info]
+        self.info = info
 
     def __reduce__(self) -> tuple[type, tuple]:
         """Return a tuple containing the constructor and its arguments"""
-        return (self.__class__, (self.labelparam, self.infos))
+        return (self.__class__, (self.labelparam, self.info))
 
     def types(self) -> tuple[type[IItemType], ...]:
         """Returns a group or category for this item.
@@ -1111,6 +1111,6 @@ def update_text(self):
             text = ["<b>%s</b>" % title]
         else:
             text = []
-        for info in self.infos:
+        for info in self.info:
             text.append(info.get_text())
         self.set_text("<br/>".join(text))

plotpy/tests/benchmarks/test_benchmarks.py

@@ -51,7 +51,7 @@ class BaseBM:
     @classmethod
     def print_header(cls):
         """Print header for benchmark results"""
-        execenv.print(f"PlotPy plot benchmark [{about.get_python_libs_infos()}]")
+        execenv.print(f"PlotPy plot benchmark [{about.get_python_libs_info()}]")
         execenv.print()
         table_header = (
             "N".rjust(10) + " | " + "∆t (ms)".rjust(7) + " | " + "Description"

plotpy/tests/features/test_computations.py

@@ -23,7 +23,7 @@ def test_computations():
         curve = make.curve(x, y, "ab", "b")
         range = make.xrange(-2, 2)
         disp0 = make.range_info_label(
-            range, "BR", "x = %.1f ± %.1f cm", title="Range infos"
+            range, "BR", "x = %.1f ± %.1f cm", title="Range info"
         )
 
         disp1 = make.computation(

plotpy/tests/features/test_image_log.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+#
+# Licensed under the terms of the BSD 3-Clause
+# (see plotpy/LICENSE for details)
+
+"""Logarithmic scale test for image plotting"""
+
+# guitest: show
+
+import numpy as np
+from guidata.qthelpers import qt_app_context
+
+from plotpy.builder import make
+from plotpy.tests import vistools as ptv
+
+LOG_MIN, LOG_MAX = 1, 10**8
+WAVELENGTHS = (371, 382, 393, 404, 415)
+
+
+def create_data() -> np.ndarray:
+    """Create a sample data set, representing a spectrum"""
+    num_bins = 1024
+    log_bins = np.logspace(np.log10(LOG_MIN), np.log10(LOG_MAX), num_bins)
+    sample_data = np.zeros((num_bins - 1, len(WAVELENGTHS)))
+    for i_lambda in range(len(WAVELENGTHS)):
+        num_samples = 100000
+        mean1, std1 = 10 ** (2 + i_lambda * 0.7), 10 ** (2 + i_lambda * 0.7) * 0.3
+        mean2, std2 = 10 ** (4 + i_lambda * 0.5), 10 ** (4 + i_lambda * 0.5) * 0.2
+        raw_data = np.abs(
+            np.concatenate(
+                [
+                    np.random.normal(mean1, std1, num_samples // 2),
+                    np.random.normal(mean2, std2, num_samples // 2),
+                ]
+            )
+        )
+        hist_values, _ = np.histogram(raw_data, bins=log_bins)
+        sample_data[:, i_lambda] = hist_values
+    return sample_data
+
+
+def test_image_log() -> None:
+    """Image with logarithmic scale"""
+    with qt_app_context(exec_loop=True):
+        data = create_data()
+        xdata = min(WAVELENGTHS), max(WAVELENGTHS)
+        ydata = LOG_MIN, LOG_MAX
+        x = np.linspace(xdata[0], xdata[1], data.shape[1] + 1)
+        y = np.linspace(ydata[0], ydata[1], data.shape[0] + 1)
+        y = np.log10(np.clip(y, LOG_MIN, LOG_MAX))
+        items = [make.xyimage(x, y, data, interpolation="nearest")]
+        _win = ptv.show_items(
+            items,
+            plot_type="curve",
+            wintitle=test_image_log.__doc__,
+            xlabel="Wavelength",
+            ylabel="log10(Intensity)",
+        )
+
+
+if __name__ == "__main__":
+    test_image_log()