vispy 0.14.2__cp312-cp312-macosx_11_0_arm64.whl → 0.15.0__cp312-cp312-macosx_11_0_arm64.whl

vispy/visuals/gridlines.py

@@ -4,27 +4,31 @@
 
 from __future__ import division
 
+import numpy as np
+
 from .image import ImageVisual
 from ..color import Color
 from .shaders import Function
 
 
 _GRID_COLOR = """
+uniform vec4 u_gridlines_bounds;
+uniform float u_border_width;
+
 vec4 grid_color(vec2 pos) {
     vec4 px_pos = $map_to_doc(vec4(pos, 0, 1));
     px_pos /= px_pos.w;
 
     // Compute vectors representing width, height of pixel in local coords
-    float s = 1.;
     vec4 local_pos = $map_doc_to_local(px_pos);
-    vec4 dx = $map_doc_to_local(px_pos + vec4(1.0 / s, 0, 0, 0));
-    vec4 dy = $map_doc_to_local(px_pos + vec4(0, 1.0 / s, 0, 0));
+    vec4 dx = $map_doc_to_local(px_pos + vec4(1.0, 0, 0, 0));
+    vec4 dy = $map_doc_to_local(px_pos + vec4(0, 1.0, 0, 0));
     local_pos /= local_pos.w;
     dx = dx / dx.w - local_pos;
     dy = dy / dy.w - local_pos;
 
     // Pixel length along each axis, rounded to the nearest power of 10
-    vec2 px = s * vec2(abs(dx.x) + abs(dy.x), abs(dx.y) + abs(dy.y));
+    vec2 px = vec2(abs(dx.x) + abs(dy.x), abs(dx.y) + abs(dy.y));
     float log10 = log(10.0);
     float sx = pow(10.0, floor(log(px.x) / log10) + 1.) * $scale.x;
     float sy = pow(10.0, floor(log(px.y) / log10) + 1.) * $scale.y;
@@ -57,6 +61,17 @@ vec4 grid_color(vec2 pos) {
     if (alpha == 0.) {
         discard;
     }
+
+    if (any(lessThan(local_pos.xy + u_border_width / 2, u_gridlines_bounds.xz)) ||
+        any(greaterThan(local_pos.xy - u_border_width / 2, u_gridlines_bounds.yw))) {
+        discard;
+    }
+
+    if (any(lessThan(local_pos.xy - u_gridlines_bounds.xz, vec2(u_border_width / 2))) ||
+        any(lessThan(u_gridlines_bounds.yw - local_pos.xy, vec2(u_border_width / 2)))) {
+        alpha = 1;
+    }
+
     return vec4($color.rgb, $color.a * alpha);
 }
 """
@@ -73,9 +88,16 @@ class GridLinesVisual(ImageVisual):
     color : Color
         The base color for grid lines. The final color may have its alpha
         channel modified.
+    grid_bounds : tuple or None
+        The lower and upper bound for each axis beyond which no grid is rendered.
+        In the form of (minx, maxx, miny, maxy).
+    border_width : float
+        Tickness of the border rendered at the bounds of the grid.
     """
 
-    def __init__(self, scale=(1, 1), color='w'):
+    def __init__(self, scale=(1, 1), color='w',
+                 grid_bounds=None,
+                 border_width=2):
         # todo: PlaneVisual should support subdivide/impostor methods from
         # image and gridlines should inherit from plane instead.
         self._grid_color_fn = Function(_GRID_COLOR)
@@ -86,6 +108,40 @@ class GridLinesVisual(ImageVisual):
         self.shared_program.frag['get_data'] = self._grid_color_fn
         cfun = Function('vec4 null(vec4 x) { return x; }')
         self.shared_program.frag['color_transform'] = cfun
+        self.unfreeze()
+        self.grid_bounds = grid_bounds
+        self.border_width = border_width
+        self.freeze()
+
+    @property
+    def grid_bounds(self):
+        return self._grid_bounds
+
+    @grid_bounds.setter
+    def grid_bounds(self, value):
+        if value is None:
+            value = (None,) * 4
+        grid_bounds = []
+        for i, v in enumerate(value):
+            if v is None:
+                if i % 2:
+                    v = -np.inf
+                else:
+                    v = np.inf
+            grid_bounds.append(v)
+        self.shared_program['u_gridlines_bounds'] = value
+        self._grid_bounds = grid_bounds
+        self.update()
+
+    @property
+    def border_width(self):
+        return self._border_width
+
+    @border_width.setter
+    def border_width(self, value):
+        self.shared_program['u_border_width'] = value
+        self._border_width = value
+        self.update()
 
     @property
     def size(self):

vispy/visuals/image.py

@@ -16,6 +16,7 @@ from .transforms import NullTransform
 from .visual import Visual
 from ..io import load_spatial_filters
 from ._scalable_textures import CPUScaledTexture2D, GPUScaledTexture2D
+from ..util import np_copy_if_needed
 
 
 _VERTEX_SHADER = """
@@ -90,11 +91,9 @@ _TEXTURE_LOOKUP = """
 
 _APPLY_CLIM_FLOAT = """
     float apply_clim(float data) {
-        // If data is NaN, don't draw it at all
-        // http://stackoverflow.com/questions/11810158/how-to-deal-with-nan-or-inf-in-opengl-es-2-0-shaders
-        if (!(data <= 0.0 || 0.0 <= data)) {
-            discard;
-        }
+        // pass through NaN values to get handled by the colormap
+        if (!(data <= 0.0 || 0.0 <= data)) return data;
+
         data = clamp(data, min($clim.x, $clim.y), max($clim.x, $clim.y));
         data = (data - $clim.x) / ($clim.y - $clim.x);
         return data;
@@ -102,7 +101,7 @@ _APPLY_CLIM_FLOAT = """
 
 _APPLY_CLIM = """
     vec4 apply_clim(vec4 color) {
-        // Handle NaN values
+        // Handle NaN values (clamp them to the minimum value)
         // http://stackoverflow.com/questions/11810158/how-to-deal-with-nan-or-inf-in-opengl-es-2-0-shaders
         color.r = !(color.r <= 0.0 || 0.0 <= color.r) ? min($clim.x, $clim.y) : color.r;
         color.g = !(color.g <= 0.0 || 0.0 <= color.g) ? min($clim.x, $clim.y) : color.g;
@@ -116,6 +115,9 @@ _APPLY_CLIM = """
 
 _APPLY_GAMMA_FLOAT = """
     float apply_gamma(float data) {
+        // pass through NaN values to get handled by the colormap
+        if (!(data <= 0.0 || 0.0 <= data)) return data;
+
         return pow(data, $gamma);
     }"""
 
@@ -128,7 +130,7 @@ _APPLY_GAMMA = """
 
 _NULL_COLOR_TRANSFORM = 'vec4 pass(vec4 color) { return color; }'
 
-_C2L_RED = 'float cmap(vec4 color) { return color.r; }'
+_C2L_RED = 'float color_to_luminance(vec4 color) { return color.r; }'
 
 _CUSTOM_FILTER = """
 vec4 texture_lookup(vec2 texcoord) {
@@ -380,7 +382,7 @@ class ImageVisual(Visual):
         texture_format : str or None
 
         """
-        data = np.array(image, copy=copy)
+        data = np.array(image, copy=copy or np_copy_if_needed)
         if np.iscomplexobj(data):
             raise TypeError(
                 "Complex data types not supported. Please use 'ComplexImage' instead"
@@ -455,6 +457,17 @@ class ImageVisual(Visual):
             self.shared_program.frag['color_transform'][2]['gamma'] = self._gamma
         self.update()
 
+    @property
+    def bad_color(self):
+        """Color used to render NaN values."""
+        return self._cmap.get_bad_color()
+
+    @bad_color.setter
+    def bad_color(self, color):
+        self._cmap.set_bad_color(color)
+        self._need_colortransform_update = True
+        self.update()
+
     @property
     def method(self):
         """Get rendering method name."""

vispy/visuals/surface_plot.py

@@ -126,7 +126,7 @@ class SurfacePlotVisual(MeshVisual):
             # convert (width, height, 4) to (num_verts, 4)
             vert_shape = self.__vertices.shape
             num_vertices = vert_shape[0] * vert_shape[1]
-            colors = colors.reshape(num_vertices, 3)
+            colors = colors.reshape(num_vertices, colors.shape[-1])
         return colors
 
     def set_data(self, x=None, y=None, z=None, colors=None):

vispy/visuals/tests/test_gridlines.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Vispy Development Team. All Rights Reserved.
+# Distributed under the (new) BSD License. See LICENSE.txt for more info.
+
+"""
+Tests for GridLines
+"""
+
+import numpy as np
+
+from vispy.scene import GridLines, STTransform
+from vispy.testing import (requires_application, TestingCanvas,
+                           run_tests_if_main)
+
+
+@requires_application()
+def test_gridlines():
+    with TestingCanvas(size=(80, 80)) as c:
+        grid = GridLines(parent=c.scene)
+        grid.transform = STTransform(translate=(40, 40))
+        render = c.render()
+        np.testing.assert_array_equal(render[40, 40], (151, 151, 151, 255))
+        np.testing.assert_array_equal(render[50, 50], (0, 0, 0, 255))
+
+        grid.grid_bounds = (-10, 10, -10, 10)
+        render = c.render()
+        np.testing.assert_array_equal(render[50, 50], (255, 255, 255, 255))
+
+
+run_tests_if_main()

vispy/visuals/tests/test_image.py

@@ -128,28 +128,30 @@ def test_image_clims_and_gamma(input_dtype, texture_format, num_channels,
 @pytest.mark.xfail(IS_CI, reason="CI environments sometimes treat NaN as 0")
 @requires_application()
 @pytest.mark.parametrize('texture_format', [None, 'auto'])
-def test_image_nan_single_band(texture_format):
-    size = (40, 40)
-    data = np.ones((40, 40))
-    data[:5, :5] = np.nan
-    data[:5, -5:] = 0
+@pytest.mark.parametrize('bad_color', [None, (1, 0, 0, 1)])
+def test_image_nan(texture_format, bad_color):
+    size = (80, 80)
+    data = np.ones(size)
+    data[:20, :20] = np.nan
+    data[-20: -20:] = 0
 
-    expected = (np.ones((40, 40, 4)) * 255).astype(np.uint8)
-    # black square
-    expected[:5, -5:, :3] = 0
+    expected = (np.ones(size + (4,)) * 255).astype(np.uint8)
+    expected[-20: -20:] = (0, 0, 0, 225)
     if texture_format is None:
         # CPU scaling's NaNs get converted to 0s
-        expected[:5, :5, :3] = 0
+        expected[:20, :20] = (0, 0, 0, 255)
     else:
         # GPU receives NaNs
-        # nan - transparent square
-        expected[:5, :5, 0] = 0
-        expected[:5, :5, 1] = 255  # match the 'green' background
-        expected[:5, :5, 2] = 0
+        # nan - mapped to bad color
+        if bad_color is None:
+            # no bad color means transparent, so we should see the green canvas
+            bad_color = (0, 1, 0, 1)
+        expected[:20, :20] = np.array(bad_color) * 255
 
     with TestingCanvas(size=size[::-1], bgcolor=(0, 1, 0)) as c:
-        Image(data, cmap='grays',
+        image = Image(data, cmap='grays', clim=(0, 1),
               texture_format=texture_format, parent=c.scene)
+        image.bad_color = bad_color
         rendered = c.render()
         np.testing.assert_allclose(rendered, expected)
 
@@ -327,7 +329,7 @@ def test_image_interpolation():
         assert np.allclose(render[center_left], black)
         assert np.allclose(render[center_right], white)
 
-        image.interpolation = 'bilinear'
+        image.interpolation = 'linear'
         render = c.render()
         assert np.allclose(render[left], black)
         assert np.allclose(render[right], white)

vispy/visuals/tests/test_scalable_textures.py

@@ -133,6 +133,22 @@ def test_clim_handling_cpu():
     assert st.clim == (5, 25)
     assert st.clim_normalized == (0, 1)
 
+    # u8 auto -> f32 auto
+    st = CPUScaledStub()
+    st.set_clim("auto")
+    assert st.clim == "auto"
+    st.scale_and_set_data(ref_data.astype(np.uint8))
+    assert st.clim == (5, 25)
+    assert st.clim_normalized == (0, 1)
+    # set new data with an out-of-range value
+    # it should clip at the limits of the original data type
+    st.set_clim("auto")
+    assert st.clim == "auto"
+    new_data = np.array([[10, 10, 5], [15, 2048, 15]], dtype=np.float32)
+    st.scale_and_set_data(new_data)
+    assert st.clim == (5, 255)
+    assert st.clim_normalized == (0, 1)
+
 
 def test_clim_handling_gpu():
     ref_data = np.array([[10, 10, 5], [15, 25, 15]])

vispy/visuals/tests/test_surface_plot.py

@@ -12,7 +12,8 @@ import pytest
 @requires_application()
 @pytest.mark.parametrize('x1dim', [True, False])
 @pytest.mark.parametrize('y1dim', [True, False])
-def test_surface_plot(x1dim:bool, y1dim:bool):
+@pytest.mark.parametrize('use_vertex_colors', [True, False])
+def test_surface_plot(x1dim:bool, y1dim:bool, use_vertex_colors:bool):
     """Test SurfacePlot visual"""
     with TestingCanvas(bgcolor='w') as c:
         
@@ -29,7 +30,8 @@ def test_surface_plot(x1dim:bool, y1dim:bool):
         # color vertices
         cnorm = z / abs(np.amax(z))
         colormap = get_colormap("viridis").map(cnorm)
-        colormap.reshape(z.shape + (-1,))
+        if not use_vertex_colors:
+            colormap = colormap.reshape(z.shape + (-1,))
 
         # 1 or 2 dimensional x and y data
         x_input = x if x1dim else xv
@@ -41,7 +43,10 @@ def test_surface_plot(x1dim:bool, y1dim:bool):
                               y=y_input,
                               shading=None)
         
-        surface.mesh_data.set_vertex_colors(colormap)
+        if use_vertex_colors:
+            surface.mesh_data.set_vertex_colors(colormap)
+        else:
+            surface.set_data(colors=colormap)
 
         # c.draw_visual(surface) 
         view.add(surface)

vispy/visuals/text/_sdf_cpu.pyx

@@ -7,6 +7,8 @@ cimport numpy as np
 from libc.math cimport sqrt
 cimport cython
 
+np.import_array()
+
 __all__ = ['_get_distance_field']
 
 dtype = np.float32

vispy/visuals/volume.py

@@ -417,8 +417,8 @@ _ATTENUATED_MIP_SNIPPETS = dict(
         // Scale and clamp accumulation in `sumval` by contrast limits so that:
         // * attenuation value does not depend on data values
         // * negative values do not amplify instead of attenuate
-        sumval = sumval + clamp((val - clim.x) / (clim.y - clim.x), 0.0, 1.0);
-        scale = exp(-u_attenuation * (sumval - 1) / u_relative_step_size);
+        sumval = sumval + u_relative_step_size * clamp((val - clim.x) / (clim.y - clim.x), 0.0, 1.0);
+        scale = exp(-u_attenuation * (sumval - 1));
         if( maxval > scale * clim.y ) {
             // stop if no chance of finding a higher maxval
             iter = nsteps;
@@ -1165,9 +1165,40 @@ class VolumeVisual(Visual):
 
     @relative_step_size.setter
     def relative_step_size(self, value):
+        """Set the relative step size used during raycasting.
+
+        Very small values give increased detail when rendering volumes with
+        few voxels, but values that are too small give worse performance
+        (framerate), in extreme cases causing a GPU hang and for the process
+        to be killed by the OS. See discussion at:
+
+        https://github.com/vispy/vispy/pull/2587
+
+        For this reason, this setter issues a warning when the value is
+        smaller than ``side_len / (2 * MAX_CANVAS_SIZE)``, where ``side_len``
+        is the smallest side of the volume and ``MAX_CANVAS_SIZE`` is what
+        we consider to be the largest likely monitor resolution along its
+        longest side: 7680 pixels, equivalent to an 8K monitor.
+
+        This setter also raises a ValueError when the value is 0 or negative.
+        """
         value = float(value)
-        if value < 0.1:
-            raise ValueError('relative_step_size cannot be smaller than 0.1')
+        side_len = np.min(self._vol_shape)
+        MAX_CANVAS_SIZE = 7680
+        minimum_val = side_len / (2 * MAX_CANVAS_SIZE)
+        if value <= 0:
+            raise ValueError('relative_step_size cannot be 0 or negative.')
+        elif value < minimum_val:
+            warnings.warn(
+                f'To display a volume of shape {self._vol_shape} without '
+                f'artifacts, you need a step size no smaller than {side_len} /'
+                f'(2 * {MAX_CANVAS_SIZE}) = {minimum_val:,.3g}. To prevent '
+                'extreme degradation in rendering performance, the provided '
+                f'value of {value} is being clipped to {minimum_val:,.3g}. If '
+                'you believe you need a smaller step size, please raise an '
+                'issue at https://github.com/vispy/vispy/issues.'
+            )
+            value = minimum_val
         self._relative_step_size = value
         self.shared_program['u_relative_step_size'] = value
 

{vispy-0.14.2.dist-info → vispy-0.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: vispy
-Version: 0.14.2
+Version: 0.15.0
 Summary: Interactive visualization in Python
 Home-page: http://vispy.org
 Download-URL: https://pypi.python.org/pypi/vispy
@@ -19,13 +19,13 @@ Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Framework :: IPython
 Provides: vispy
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: numpy
@@ -33,38 +33,63 @@ Requires-Dist: freetype-py
 Requires-Dist: hsluv
 Requires-Dist: kiwisolver
 Requires-Dist: packaging
-Provides-Extra: doc
-Requires-Dist: pydata-sphinx-theme ; extra == 'doc'
-Requires-Dist: numpydoc ; extra == 'doc'
-Requires-Dist: sphinxcontrib-apidoc ; extra == 'doc'
-Requires-Dist: sphinx-gallery ; extra == 'doc'
-Requires-Dist: myst-parser ; extra == 'doc'
-Requires-Dist: pillow ; extra == 'doc'
-Requires-Dist: pytest ; extra == 'doc'
-Requires-Dist: pyopengl ; extra == 'doc'
-Provides-Extra: io
-Requires-Dist: meshio ; extra == 'io'
-Requires-Dist: Pillow ; extra == 'io'
 Provides-Extra: ipython-static
-Requires-Dist: ipython ; extra == 'ipython-static'
+Requires-Dist: ipython; extra == "ipython-static"
 Provides-Extra: pyglet
-Requires-Dist: pyglet >=1.2 ; extra == 'pyglet'
+Requires-Dist: pyglet>=1.2; extra == "pyglet"
 Provides-Extra: pyqt5
-Requires-Dist: pyqt5 ; extra == 'pyqt5'
+Requires-Dist: pyqt5; extra == "pyqt5"
 Provides-Extra: pyqt6
-Requires-Dist: pyqt6 ; extra == 'pyqt6'
+Requires-Dist: pyqt6; extra == "pyqt6"
 Provides-Extra: pyside
-Requires-Dist: PySide ; extra == 'pyside'
+Requires-Dist: PySide; extra == "pyside"
 Provides-Extra: pyside2
-Requires-Dist: PySide2 ; extra == 'pyside2'
+Requires-Dist: PySide2; extra == "pyside2"
 Provides-Extra: pyside6
-Requires-Dist: PySide6 ; extra == 'pyside6'
+Requires-Dist: PySide6; extra == "pyside6"
+Provides-Extra: glfw
+Requires-Dist: glfw; extra == "glfw"
 Provides-Extra: sdl2
-Requires-Dist: PySDL2 ; extra == 'sdl2'
-Provides-Extra: tk
-Requires-Dist: pyopengltk ; extra == 'tk'
+Requires-Dist: PySDL2; extra == "sdl2"
 Provides-Extra: wx
-Requires-Dist: wxPython ; extra == 'wx'
+Requires-Dist: wxPython; extra == "wx"
+Provides-Extra: tk
+Requires-Dist: pyopengltk; extra == "tk"
+Provides-Extra: doc
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: numpydoc; extra == "doc"
+Requires-Dist: sphinxcontrib-apidoc; extra == "doc"
+Requires-Dist: sphinx-gallery; extra == "doc"
+Requires-Dist: myst-parser; extra == "doc"
+Requires-Dist: pillow; extra == "doc"
+Requires-Dist: pytest; extra == "doc"
+Requires-Dist: pyopengl; extra == "doc"
+Provides-Extra: io
+Requires-Dist: meshio; extra == "io"
+Requires-Dist: Pillow; extra == "io"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-sugar; extra == "test"
+Requires-Dist: meshio; extra == "test"
+Requires-Dist: pillow; extra == "test"
+Requires-Dist: sphinx_gallery; extra == "test"
+Requires-Dist: imageio; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: provides
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 VisPy: interactive scientific visualization in Python
 -----------------------------------------------------
@@ -205,7 +230,7 @@ External links
 -  `Chat room <https://gitter.im/vispy/vispy>`__
 -  `Developer chat room <https://gitter.im/vispy/vispy-dev>`__
 -  `Wiki <http://github.com/vispy/vispy/wiki>`__
--  `Gallery <http://vispy.org/gallery.html>`__
+-  `Gallery <http://vispy.org/gallery/index.html>`__
 -  `Documentation <http://vispy.readthedocs.org>`__
 
 .. |Build Status| image:: https://github.com/vispy/vispy/workflows/CI/badge.svg