adding shade utility

Author: jposada202020

circuitpython_uplot/shade.py

@@ -0,0 +1,108 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+"""
+
+`shade`
+================================================================================
+
+CircuitPython shade utility for uPlot.
+
+* Author(s): Jose D. Montoya
+
+
+"""
+try:
+    from typing import Optional, Union
+    from circuitpython_uplot.uplot import Uplot
+except ImportError:
+    pass
+from ulab import numpy as np
+from bitmaptools import fill_region
+
+
+__version__ = "0.0.0+auto.0"
+__repo__ = "https://github.com/adafruit/CircuitPython_uplot.git"
+
+
+class shade:
+    """
+    Class to draw shade between two lines
+    """
+
+    def __init__(
+        self,
+        plot: Uplot,
+        x: Union[list, np.linspace, np.ndarray],
+        y1: list,
+        y2: list,
+        rangex: Optional[list] = None,
+        rangey: Optional[list] = None,
+        fill_color: int = 0xF6FF41,
+        nudge: bool = True,
+    ) -> None:
+        """
+        :param Uplot plot: Plot object for the scatter to be drawn
+        :param list|ulab.numpy.linspace|ulab.numpy.ndarray x: x points coordinates
+        :param list y1: y1 points coordinates
+        :param list y2: y2 points coordinates
+        :param list|None rangex: x range limits
+        :param list|None rangey: y range limits
+        :param int fill_color: filling color. Defaults to 0xF6FF41
+        :param bool nudge: moves the graph a little for better displaying
+
+        """
+
+        if nudge:
+            nudge_factor = 1
+        else:
+            nudge_factor = 0
+
+        plot._plot_palette[plot._index_colorused] = fill_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)
+        else:
+            xmin = min(rangex)
+            xmax = max(rangex)
+
+        if rangey is None:
+            ymin = min(np.min(y1), np.min(y2)) - nudge_factor * (
+                abs(np.max(y1) - np.min(y1)) / 10
+            )
+            ymax = max(np.max(y1), np.max(y2)) + nudge_factor * (
+                abs(np.max(y1) - np.min(y1)) / 10
+            )
+        else:
+            ymin = min(rangey)
+            ymax = max(rangey)
+
+        x = np.array(x)
+        y1 = np.array(y1)
+        y2 = np.array(y2)
+
+        xnorm = np.array(
+            plot.transform(xmin, xmax, plot._newxmin, plot._newxmax, x),
+            dtype=np.int16,
+        )
+        y1norm = np.array(
+            plot.transform(ymin, ymax, plot._newymin, plot._newymax, y1),
+            dtype=np.int16,
+        )
+        y2norm = np.array(
+            plot.transform(ymin, ymax, plot._newymin, plot._newymax, y2),
+            dtype=np.int16,
+        )
+
+        fill_region(
+            plot._plotbitmap,
+            min(xnorm),
+            min(y1norm),
+            max(xnorm),
+            max(y2norm),
+            plot._index_colorused,
+        )
+
+        plot._index_colorused += 1

circuitpython_uplot/ucartesian.py

@@ -121,6 +121,8 @@ def __init__(
             for index, _ in enumerate(xnorm):
                 if index + 1 >= len(xnorm):
                     break
+                if y[index] >= ymax:
+                    continue
                 draw_line(
                     plot._plotbitmap,
                     xnorm[index],

docs/api.rst

@@ -27,3 +27,6 @@ Uplot Library
 
 .. automodule:: circuitpython_uplot.usvg
     :members:
+
+.. automodule:: circuitpython_uplot.shade
+    :members:

docs/examples.rst

@@ -260,3 +260,13 @@ SVG Images example
     :caption: examples/uplot_usvg_example.py
     :lines: 5-
 .. image:: ../docs/uplot_ex23.jpg
+
+Shade examples
+---------------------------
+
+Shade example
+
+.. literalinclude:: ../examples/uplot_shade_example.py
+    :caption: examples/uplot_shade_example.py
+    :lines: 5-
+.. image:: ../docs/uplot_shade.jpg

docs/uplot_shade.jpg

@@ -0,0 +1,104 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+import time
+import board
+from ulab import numpy as np
+from circuitpython_uplot.uplot import Uplot
+from circuitpython_uplot.ucartesian import ucartesian
+from circuitpython_uplot.shade import shade
+
+# This example is based in the following Library
+# https://github.com/CedarGroveStudios/CircuitPython_TemperatureTools
+# And this Wikipedia Article
+# https://en.wikipedia.org/wiki/Heat_index
+
+
+# Setting up the display
+display = board.DISPLAY
+
+# Adding the plot area
+plot = Uplot(0, 0, display.width, display.height, padding=5)
+
+
+def heat_index(temp, humidity):
+    """
+    Inspired by
+    https://github.com/CedarGroveStudios/CircuitPython_TemperatureTools
+
+    """
+
+    heat_index_value = (
+        -8.78469475556
+        + 1.61139411 * temp
+        + 2.33854883889 * humidity
+        - 0.14611605 * temp * humidity
+        - 0.012308094 * temp**2
+        - 0.0164248277778 * humidity**2
+        + 0.002211732 * temp**2 * humidity
+        + 0.00072546 * temp * humidity**2
+        - 0.000003582 * temp**2 * humidity**2
+    )
+    return heat_index_value
+
+
+x = np.linspace(25, 50, num=2)
+
+# Drawing the Shades
+shade(
+    plot,
+    x,
+    [25, 25],
+    [26.3, 26.3],
+    rangex=[25, 50],
+    rangey=[25, 60],
+    fill_color=0x59FF33,
+)
+shade(
+    plot,
+    x,
+    [26.3, 26.3],
+    [30.5, 30.5],
+    rangex=[25, 50],
+    rangey=[25, 60],
+    fill_color=0xFFFDD0,
+)
+shade(
+    plot,
+    x,
+    [30.5, 30.5],
+    [40.5, 40.5],
+    rangex=[25, 50],
+    rangey=[25, 60],
+    fill_color=0xFFEB99,
+)
+shade(
+    plot,
+    x,
+    [40.5, 40.5],
+    [53.5, 53.5],
+    rangex=[25, 50],
+    rangey=[25, 60],
+    fill_color=0xFFDB58,
+)
+shade(
+    plot,
+    x,
+    [53.5, 53.5],
+    [60, 60],
+    rangex=[25, 50],
+    rangey=[25, 60],
+    fill_color=0xFF9D5C,
+)
+
+# Creating some points to graph
+x = np.linspace(25, 50, num=25)
+
+# Drawing the graphs
+for i in range(40, 110, 10):
+    ucartesian(plot, x, heat_index(x, i), rangex=[25, 50], rangey=[25, 60])
+
+display.show(plot)
+while True:
+    time.sleep(1)