adding scatter_pointers

Author: jposada202020

circuitpython_uplot/scatter.py

@@ -23,12 +23,17 @@
 
 from ulab import numpy as np
 import displayio
-from vectorio import Circle
+from vectorio import Circle, Polygon
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/CircuitPython_uplot.git"
 
 
+_TRIANGLE = [(0, 0), (8, 0), (4, -7)]
+_SQUARE = [(0, 0), (6, 0), (6, -6), (0, -6)]
+_DIAMOND = [(0, 0), (3, -4), (6, 0), (3, 4)]
+
+
 class Scatter:
     """
     Main class to display different graphics
@@ -42,7 +47,8 @@ def __init__(
         rangex: Optional[list] = None,
         rangey: Optional[list] = None,
         radius: Optional[Union[list, int]] = 3,
-        circle_color: int = 0xFF905D,
+        pointer_color: int = 0xFF905D,
+        pointer: Optional[str] = None,
         nudge: bool = True,
     ) -> None:
         """
@@ -53,6 +59,8 @@ def __init__(
         :param list|None rangex: x range limits
         :param list|None rangey: y range limits
         :param int|list radius: circle radius
+        :param int pointer_color: pointer color. Default is 0xFF905D
+        :param str|None pointer: pointer shape.
         :param bool nudge: moves the graph a little for better displaying
 
         """
@@ -61,6 +69,14 @@ def __init__(
         else:
             nudge_factor = 0
 
+        if pointer is None:
+            self._pointer = "circle"
+        else:
+            self._pointer = pointer
+
+        self._radius = radius
+        self._pointer_color = pointer_color
+
         if rangex is None:
             xmin = np.min(x) - nudge_factor * (abs(np.max(x) - np.min(x)) / 10)
             xmax = np.max(x) + nudge_factor * (abs(np.max(x) - np.min(x)) / 10)
@@ -78,30 +94,73 @@ def __init__(
         x = np.array(x)
         y = np.array(y)
 
-        xnorm = np.array(
+        self._xnorm = np.array(
             plot.transform(xmin, xmax, plot._newxmin, plot._newxmax, x),
             dtype=np.int16,
         )
-        ynorm = np.array(
+        self._ynorm = np.array(
             plot.transform(ymin, ymax, plot._newymin, plot._newymax, y),
             dtype=np.int16,
         )
 
-        palette = displayio.Palette(1)
-        palette[0] = circle_color
+        self._draw_pointer(plot)
+
+        if plot._showticks:
+            plot._draw_ticks(x, y)
+
+    def _draw_pointer(self, plot: Plot) -> None:
+        """
+
+        :param plot: Plot object for the scatter to be drawn
 
-        if isinstance(radius, list):
-            for i, _ in enumerate(x):
+        """
+        palette = displayio.Palette(1)
+        palette[0] = self._pointer_color
+        if isinstance(self._radius, list):
+            for i, _ in enumerate(self._xnorm):
                 plot.append(
                     Circle(
-                        pixel_shader=palette, radius=radius[i], x=xnorm[i], y=ynorm[i]
+                        pixel_shader=palette,
+                        radius=self._radius[i],
+                        x=self._xnorm[i],
+                        y=self._ynorm[i],
                     )
                 )
         else:
-            for i, _ in enumerate(x):
-                plot.append(
-                    Circle(pixel_shader=palette, radius=radius, x=xnorm[i], y=ynorm[i])
-                )
-
-        if plot._showticks:
-            plot._draw_ticks(x, y)
+            for i, _ in enumerate(self._xnorm):
+                if self._pointer == "circle":
+                    plot.append(
+                        Circle(
+                            pixel_shader=palette,
+                            radius=self._radius,
+                            x=self._xnorm[i],
+                            y=self._ynorm[i],
+                        )
+                    )
+                elif self._pointer == "triangle":
+                    plot.append(
+                        Polygon(
+                            points=_TRIANGLE,
+                            pixel_shader=palette,
+                            x=self._xnorm[i],
+                            y=self._ynorm[i],
+                        )
+                    )
+                elif self._pointer == "square":
+                    plot.append(
+                        Polygon(
+                            points=_SQUARE,
+                            pixel_shader=palette,
+                            x=self._xnorm[i],
+                            y=self._ynorm[i],
+                        )
+                    )
+                elif self._pointer == "diamond":
+                    plot.append(
+                        Polygon(
+                            points=_DIAMOND,
+                            pixel_shader=palette,
+                            x=self._xnorm[i],
+                            y=self._ynorm[i],
+                        )
+                    )

docs/examples.rst

@@ -61,6 +61,26 @@ Scatter plot Example
     :lines: 5-
 .. image:: ../docs/scatter.jpg
 
+Scatter Circle Pointers with diferent Radius
+---------------------------------------------
+
+Example showing how to use different radius in the circle pointers
+
+.. literalinclude:: ../examples/scatter_circle_radius.py
+    :caption: examples/scatter_circle_radius.py
+    :lines: 5-
+.. image:: ../docs/scatter_circle_radius.jpg
+
+Scatter Pointers Example
+----------------------------
+
+Example showing how to use different pointers
+
+.. literalinclude:: ../examples/scatter.py
+    :caption: examples/scatter.py
+    :lines: 5-
+.. image:: ../docs/scatter_pointers.jpg
+
 Display_shapes Example
 -----------------------
 

docs/quick_start.rst

@@ -65,6 +65,9 @@ At the moment the following objects can be added to the plot area:
     * Bar graph
     * Pie Chart
     * Colormap
+    * Polar graph
+    * SVG Rudimentary support
+    * Logging graph
 * Display_shapes library objects
 * Histograms from the uhistogram library
 * Boxplots from the uboxplot library
@@ -264,8 +267,8 @@ Creates a scatter plot with x,y data. You can customize the circle diameter if y
 
 There are some parameters that you can customize:
     * rangex and rangey: you can specify the ranges of your graph. This allows you to move your graph according to your needs. This parameters only accept lists
-    * radius: circles radius/radii
-    * circle_color: you can specify the color in HEX
+    * radius: circles radius/radii. If a different value is given for each point, the radius should be a list of values. If selected pointer is not a circle, this parameter will be ignored
+    * pointer_color: you can specify the color in HEX
     * nudge: this parameter allows you to move the graph slighty. This is useful when the data start/end in the limits of your range
 
 
@@ -275,7 +278,7 @@ There are some parameters that you can customize:
     z = [4, 5, 6, 7, 8]
     radi = [choice(z) for _ in a]
     b = [choice(a) for _ in a]
-    Scatter(plot, a, b, rangex=[0,210], rangey=[0, 210], radius=radi, circle_color=0xF456F3)
+    Scatter(plot, a, b, rangex=[0,210], rangey=[0, 210], radius=radi, pointer_color=0xF456F3)
 
 ===============
 Bar Plot

docs/scatter_circle_radius.jpg

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+from random import choice
+import board
+from ulab import numpy as np
+from circuitpython_uplot.plot import Plot
+from circuitpython_uplot.scatter import Scatter
+
+
+# Setting up the display
+display = board.DISPLAY
+
+# Adding the plot area
+plot = Plot(0, 0, display.width, display.height, padding=1)
+plot.tick_params(tickx_height=12, ticky_height=12, tickcolor=0x939597, tickgrid=True)
+
+display.show(plot)
+
+a = np.linspace(1, 200, 150)
+z = [4, 5, 6, 7, 8]
+radi = [choice(z) for _ in a]
+b = [choice(a) for _ in a]
+Scatter(
+    plot, a, b, rangex=[0, 210], rangey=[0, 210], radius=radi, pointer_color=0xF456F3
+)

docs/scatter_pointers.jpg

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+import displayio
+from random import choice
+import board
+from ulab import numpy as np
+from circuitpython_uplot.plot import Plot
+from circuitpython_uplot.scatter import Scatter
+
+
+# Setting up the display
+display = board.DISPLAY
+
+# Adding the plot area
+plot = Plot(0, 0, display.width // 2, display.height // 2, padding=1)
+plot.tick_params(tickx_height=12, ticky_height=12, tickcolor=0xFF0008, tickgrid=True)
+plot2 = Plot(240, 0, display.width // 2, display.height // 2, padding=1)
+plot2.tick_params(tickx_height=6, ticky_height=6, tickcolor=0x939597, tickgrid=True)
+plot3 = Plot(0, 160, display.width // 2, display.height // 2, padding=1)
+plot3.tick_params(tickx_height=6, ticky_height=6, tickcolor=0x939597, tickgrid=False)
+plot4 = Plot(240, 160, display.width // 2, display.height // 2, padding=1)
+g = displayio.Group()
+g.append(plot)
+g.append(plot2)
+g.append(plot3)
+g.append(plot4)
+display.show(g)
+# Setting up tick parameters
+
+
+a = np.linspace(1, 100)
+b = [choice(a) for _ in a]
+Scatter(plot, a, b)
+Scatter(plot2, a, b, pointer="triangle", pointer_color=0x00FF00)
+Scatter(plot3, a, b, pointer="square", pointer_color=0xFFFFFF)
+Scatter(plot4, a, b, pointer="diamond", pointer_color=0xFF32FF)