Add sizemode property for Sensor, pixel and Dipole (magpylib#658)

* fix zoom on extra backend traces

* fix str text labels

* refactor default style description

* implement sizemodes

* fix multi trimesh line merges

* move tight layout to figure kwarg to avoid warning

---------

Co-authored-by: Boisselet Alexandre (IFAT DC ATV SC D TE2) <[email protected]>
Co-authored-by: mortner <[email protected]>

Author: 3 people

magpylib/_src/defaults/defaults_values.py

@@ -89,18 +89,32 @@
             },
             "sensor": {
                 "size": 1,
-                "pixel": {"size": 1, "color": None, "symbol": "o"},
+                "sizemode": "scaled",
+                "pixel": {
+                    "size": 1,
+                    "sizemode": "scaled",
+                    "color": None,
+                    "symbol": "o",
+                },
                 "arrows": {
                     "x": {"color": "red"},
                     "y": {"color": "green"},
                     "z": {"color": "blue"},
                 },
             },
-            "dipole": {"size": 1, "pivot": "middle"},
+            "dipole": {"size": 1, "sizemode": "scaled", "pivot": "middle"},
             "triangle": {
                 "magnetization": {
                     "show": True,
-                    "size": 1,
+                    "arrow": {
+                        "show": True,
+                        "size": 1,
+                        "sizemode": "scaled",
+                        "offset": 1,
+                        "width": 2,
+                        "style": "solid",
+                        "color": None,
+                    },
                     "color": {
                         "north": "#E71111",
                         "middle": "#DDDDDD",

magpylib/_src/display/backend_matplotlib.py

@@ -228,7 +228,7 @@ def display_matplotlib(
             if legend_maxitems != 0:
                 ratio *= 1.5  # extend horizontal ratio if legend is present
             fig_kwargs["figsize"] = (figsize[0] * ratio, figsize[1])
-        fig = plt.figure(**fig_kwargs)
+        fig = plt.figure(**{"tight_layout": True, **fig_kwargs})
     elif isinstance(canvas, matplotlib.axes.Axes):
         fig = canvas.get_figure()
         if max_rows is not None or max_cols is not None:
@@ -339,7 +339,7 @@ def animate(ind):  # pragma: no cover
             blit=False,
             repeat=repeat,
         )
-    plt.tight_layout()
+
     out = ()
     if return_fig:
         show_canvas = False

magpylib/_src/display/traces_core.py

@@ -153,7 +153,7 @@ def make_Dipole(obj, autosize=None, **kwargs) -> Dict[str, Any]:
     moment = np.array([0.0, 0.0, 0.0]) if obj.moment is None else obj.moment
     moment_mag = np.linalg.norm(moment)
     size = style.size
-    if autosize is not None:
+    if autosize is not None and style.sizemode == "scaled":
         size *= autosize
     if moment_mag == 0:
         trace = create_null_dim_trace(color=style.color)
@@ -557,7 +557,7 @@ def make_Sensor(obj, autosize=None, **kwargs) -> Dict[str, Any]:
     )
     no_pix = pixel.shape[0] == 1 and (pixel == 0).all()
     one_pix = pixel.shape[0] == 1 and not (pixel == 0).all()
-    if autosize is not None:
+    if autosize is not None and style.sizemode == "scaled":
         dim *= autosize
     if no_pix:
         dim_ext = dim
@@ -576,11 +576,13 @@ def make_Sensor(obj, autosize=None, **kwargs) -> Dict[str, Any]:
     if not no_pix:
         pixel_color = style.pixel.color
         pixel_size = style.pixel.size
-        combs = np.array(list(combinations(pixel, 2)))
-        vecs = np.diff(combs, axis=1)
-        dists = np.linalg.norm(vecs, axis=2)
-        min_dist = np.min(dists)
-        pixel_dim = dim_ext / 5 if min_dist == 0 else min_dist / 2
+        pixel_dim = 1
+        if style.pixel.sizemode == "scaled":
+            combs = np.array(list(combinations(pixel, 2)))
+            vecs = np.diff(combs, axis=1)
+            dists = np.linalg.norm(vecs, axis=2)
+            min_dist = np.min(dists)
+            pixel_dim = dim_ext / 5 if min_dist == 0 else min_dist / 2
         if pixel_size > 0:
             pixel_dim *= pixel_size
             poss = pixel[1:] if one_pix else pixel

magpylib/_src/style.py

@@ -13,6 +13,8 @@
 from magpylib._src.defaults.defaults_utility import validate_property_class
 from magpylib._src.defaults.defaults_utility import validate_style_keys
 
+ALLOWED_SIZEMODES = ("scaled", "absolute")
+
 
 def get_families(obj):
     """get obj families"""
@@ -1493,6 +1495,10 @@ class SensorProperties:
     size: float, default=None
         Positive float for ratio of sensor to canvas size.
 
+    sizemode: {'scaled', 'absolute'}, default='scaled'
+        Defines the scale reference for the sensor size. If 'absolute', the `size` parameters
+        becomes the sensor size in millimeters.
+
     pixel: dict, Pixel, default=None
         `Pixel` object or dict with equivalent key/value pairs (e.g. `color`, `size`).
 
@@ -1513,6 +1519,19 @@ def size(self, val):
         )
         self._size = val
 
+    @property
+    def sizemode(self):
+        """Sizemode of the sensor."""
+        return self._sizemode
+
+    @sizemode.setter
+    def sizemode(self, val):
+        assert val is None or val in ALLOWED_SIZEMODES, (
+            f"The `sizemode` property of {type(self).__name__} must be a one of "
+            f"{ALLOWED_SIZEMODES},\nbut received {repr(val)} instead."
+        )
+        self._sizemode = val
+
     @property
     def pixel(self):
         """`Pixel` object or dict with equivalent key/value pairs (e.g. `color`, `size`)."""
@@ -1540,15 +1559,32 @@ class DefaultSensor(MagicProperties, SensorProperties):
     size: float, default=None
         Positive float for ratio of sensor to canvas size.
 
+    sizemode: {'scaled', 'absolute'}, default='scaled'
+        Defines the scale reference for the sensor size. If 'absolute', the `size` parameters
+        becomes the sensor size in millimeters.
+
     pixel: dict, Pixel, default=None
         `Pixel` object or dict with equivalent key/value pairs (e.g. `color`, `size`).
 
     arrows: dict, ArrowCS, default=None
         `ArrowCS` object or dict with equivalent key/value pairs (e.g. `color`, `size`).
     """
 
-    def __init__(self, size=None, pixel=None, arrows=None, **kwargs):
-        super().__init__(size=size, pixel=pixel, arrows=arrows, **kwargs)
+    def __init__(
+        self,
+        size=None,
+        sizemode=None,
+        pixel=None,
+        arrows=None,
+        **kwargs,
+    ):
+        super().__init__(
+            size=size,
+            sizemode=sizemode,
+            pixel=pixel,
+            arrows=arrows,
+            **kwargs,
+        )
 
 
 class SensorStyle(BaseStyle, SensorProperties):
@@ -1602,6 +1638,10 @@ class Pixel(MagicProperties):
         - matplotlib backend: Pixel size is the marker size.
         - plotly backend: Relative distance to nearest neighbor pixel.
 
+    sizemode: {'scaled', 'absolute'}, default='scaled'
+        Defines the scale reference for the pixel size. If 'absolute', the `size` parameters
+        becomes the pixel size in millimeters.
+
     color: str, default=None
         Defines the pixel color@property.
 
@@ -1610,8 +1650,14 @@ class Pixel(MagicProperties):
         Only applies for matplotlib plotting backend.
     """
 
-    def __init__(self, size=1, color=None, symbol=None, **kwargs):
-        super().__init__(size=size, color=color, symbol=symbol, **kwargs)
+    def __init__(self, size=1, sizemode=None, color=None, symbol=None, **kwargs):
+        super().__init__(
+            size=size,
+            sizemode=sizemode,
+            color=color,
+            symbol=symbol,
+            **kwargs,
+        )
 
     @property
     def size(self):
@@ -1628,6 +1674,19 @@ def size(self, val):
         )
         self._size = val
 
+    @property
+    def sizemode(self):
+        """Sizemode of the pixel."""
+        return self._sizemode
+
+    @sizemode.setter
+    def sizemode(self, val):
+        assert val is None or val in ALLOWED_SIZEMODES, (
+            f"The `sizemode` property of {type(self).__name__} must be a one of "
+            f"{ALLOWED_SIZEMODES},\nbut received {repr(val)} instead."
+        )
+        self._sizemode = val
+
     @property
     def color(self):
         """Pixel color."""
@@ -1763,8 +1822,6 @@ class Arrow(Line):
         Positive number that defines the line width.
     """
 
-    _allowed_sizemodes = ("scaled", "absolute")
-
     def __init__(self, show=None, size=None, **kwargs):
         super().__init__(show=show, size=size, **kwargs)
 
@@ -1796,14 +1853,14 @@ def size(self, val):
 
     @property
     def sizemode(self):
-        """Positive number defining the sizemode of the arrows."""
+        """Sizemode of the arrows."""
         return self._sizemode
 
     @sizemode.setter
     def sizemode(self, val):
-        assert val is None or val in self._allowed_sizemodes, (
+        assert val is None or val in ALLOWED_SIZEMODES, (
             f"The `sizemode` property of {type(self).__name__} must be a one of "
-            f"{self._allowed_sizemodes},\nbut received {repr(val)} instead."
+            f"{ALLOWED_SIZEMODES},\nbut received {repr(val)} instead."
         )
         self._sizemode = val
 
@@ -1941,6 +1998,10 @@ class DipoleProperties:
     size: float
         Positive value for ratio of dipole size to canvas size.
 
+    sizemode: {'scaled', 'absolute'}, default='scaled'
+        Defines the scale reference for the dipole size. If 'absolute', the `size` parameters
+        becomes the dipole size in millimeters.
+
     pivot: str
         The part of the arrow that is anchored to the X, Y grid.
         The arrow rotates about this point. Can be one of `['tail', 'middle', 'tip']`.
@@ -1961,6 +2022,19 @@ def size(self, val):
         )
         self._size = val
 
+    @property
+    def sizemode(self):
+        """Sizemode of the dipole."""
+        return self._sizemode
+
+    @sizemode.setter
+    def sizemode(self, val):
+        assert val is None or val in ALLOWED_SIZEMODES, (
+            f"The `sizemode` property of {type(self).__name__} must be a one of "
+            f"{ALLOWED_SIZEMODES},\nbut received {repr(val)} instead."
+        )
+        self._sizemode = val
+
     @property
     def pivot(self):
         """The part of the arrow that is anchored to the X, Y grid.
@@ -1987,13 +2061,17 @@ class DefaultDipole(MagicProperties, DipoleProperties):
     size: float, default=None
         Positive float for ratio of dipole size to canvas size.
 
+    sizemode: {'scaled', 'absolute'}, default='scaled'
+        Defines the scale reference for the dipole size. If 'absolute', the `size` parameters
+        becomes the dipole size in millimeters.
+
     pivot: str, default=None
         The part of the arrow that is anchored to the X, Y grid.
         The arrow rotates about this point. Can be one of `['tail', 'middle', 'tip']`.
     """
 
-    def __init__(self, size=None, pivot=None, **kwargs):
-        super().__init__(size=size, pivot=pivot, **kwargs)
+    def __init__(self, size=None, sizemode=None, pivot=None, **kwargs):
+        super().__init__(size=size, sizemode=sizemode, pivot=pivot, **kwargs)
 
 
 class DipoleStyle(BaseStyle, DipoleProperties):

tests/test_obj_BaseGeo.py

@@ -481,7 +481,7 @@ def test_describe():
         + "model3d=Model3d(data=[], showdefault=True), opacity=None, path=Path(frames=None,"
         + " line=Line(color=None, style=None, width=None), marker=Marker(color=None,"
         + " size=None, symbol=None), numbering=None, show=None), pixel=Pixel(color=None,"
-        + " size=1, symbol=None), size=None) "
+        + " size=1, sizemode=None, symbol=None), size=None, sizemode=None) "
     )
     desc = re.sub("id=*[0-9]*[0-9]", "id=REGEX", desc)
     assert desc == test