move calc_gridshape, docstrings, make plotarea name a property (#220)

kushalkolar · web-flow · commit 45357bc0df18 · 2023-06-11T08:18:32.000-04:00
diff --git a/fastplotlib/layouts/_base.py b/fastplotlib/layouts/_base.py
@@ -87,7 +87,7 @@ def __init__(
         # managed similar to GRAPHICS for garbage collection etc.
         self._selectors: List[str] = list()
 
-        self.name = name
+        self._name = name
 
         # need to think about how to deal with children better
         self.children = list()
@@ -155,6 +155,14 @@ def selectors(self) -> Tuple[BaseSelector, ...]:
 
         return tuple(proxies)
 
+    @property
+    def name(self) -> Any:
+        return self._name
+
+    @name.setter
+    def name(self, name: Any):
+        self._name = name
+
     def get_rect(self) -> Tuple[float, float, float, float]:
         """allows setting the region occupied by the viewport w.r.t. the parent"""
         raise NotImplementedError("Must be implemented in subclass")
diff --git a/fastplotlib/layouts/_gridplot.py b/fastplotlib/layouts/_gridplot.py
@@ -291,11 +291,17 @@ def show(self, toolbar: bool = True):
         return VBox([self.canvas, self.toolbar.widget])
 
     def close(self):
+        """Close the GridPlot"""
         self.canvas.close()
 
         if self.toolbar is not None:
             self.toolbar.widget.close()
 
+    def clear(self):
+        """Clear all Subplots"""
+        for subplot in self:
+            subplot.clear()
+
     def _get_iterator(self):
         return product(range(self.shape[0]), range(self.shape[1]))
 
diff --git a/fastplotlib/layouts/_subplot.py b/fastplotlib/layouts/_subplot.py
@@ -129,6 +129,15 @@ def _create_graphic(self, graphic_class, *args, **kwargs) -> weakref.proxy:
         # only return a proxy to the real graphic
         return weakref.proxy(graphic)
 
+    @property
+    def name(self) -> Any:
+        return self._name
+
+    @name.setter
+    def name(self, name: Any):
+        self._name = name
+        self.set_title(name)
+
     def set_title(self, text: Any):
         """Sets the name of a subplot to 'top' viewport if defined."""
         if text is None:
diff --git a/fastplotlib/plot.py b/fastplotlib/plot.py
@@ -129,6 +129,7 @@ def show(self, autoscale: bool = True, toolbar: bool = True):
         return VBox([self.canvas, self.toolbar.widget])
 
     def close(self):
+        """Close Plot"""
         self.canvas.close()
 
         if self.toolbar is not None:
diff --git a/fastplotlib/utils/functions.py b/fastplotlib/utils/functions.py
@@ -154,3 +154,15 @@ def make_pygfx_colors(colors, n_colors):
     c = Color(colors)
     colors_array = np.repeat(np.array([c]), n_colors, axis=0)
     return colors_array
+
+
+def calculate_gridshape(n_subplots: int) -> Tuple[int, int]:
+    """
+    Returns ``(n_rows, n_cols)`` from given number of subplots ``n_subplots``
+    """
+    sr = np.sqrt(n_subplots)
+
+    return (
+        int(np.round(sr)),
+        int(np.ceil(sr))
+    )
diff --git a/fastplotlib/widgets/image.py b/fastplotlib/widgets/image.py
@@ -11,7 +11,7 @@
 from ..plot import Plot
 from ..layouts import GridPlot
 from ..graphics import ImageGraphic
-from ..utils import quick_min_max
+from ..utils import quick_min_max, calculate_gridshape
 
 
 DEFAULT_DIMS_ORDER = \
@@ -23,14 +23,6 @@
     }
 
 
-def _calc_gridshape(n):
-    sr = np.sqrt(n)
-    return (
-        int(np.round(sr)),
-        int(np.ceil(sr))
-    )
-
-
 def _is_arraylike(obj) -> bool:
     """
     Checks if the object is array-like.
@@ -248,11 +240,11 @@ def __init__(
             # verify that it's a list of np.ndarray
             if all([_is_arraylike(d) for d in data]):
                 if grid_shape is None:
-                    grid_shape = _calc_gridshape(len(data))
+                    grid_shape = calculate_gridshape(len(data))
 
                 # verify that user-specified grid shape is large enough for the number of image arrays passed
                 elif grid_shape[0] * grid_shape[1] < len(data):
-                    grid_shape = _calc_gridshape(len(data))
+                    grid_shape = calculate_gridshape(len(data))
                     warn(f"Invalid `grid_shape` passed, setting grid shape to: {grid_shape}")
 
                 _ndim = [d.ndim for d in data]
@@ -821,11 +813,22 @@ def _set_slider_layout(self, *args):
         for mm in self.vmin_vmax_sliders:
             mm.layout = Layout(width=f"{w}px")
 
-    def _get_vmin_vmax_range(self, data: np.ndarray) -> Tuple[int, int]:
+    def _get_vmin_vmax_range(self, data: np.ndarray) -> tuple:
+        """
+        Parameters
+        ----------
+        data
+
+        Returns
+        -------
+        Tuple[Tuple[float, float], float, float, float]
+            (min, max), data_range, min - (data_range * 0.4), max + (data_range * 0.4)
+        """
+
         minmax = quick_min_max(data)
 
         data_range = np.ptp(minmax)
-        data_range_40p = np.ptp(minmax) * 0.4
+        data_range_40p = data_range * 0.4
 
         _range = (
             minmax,
