Thanks to visit codestin.com
Credit goes to github.com

Skip to content

support numpy fancy indexing for colors and data features #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2023
Merged

support numpy fancy indexing for colors and data features #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 56 additions & 2 deletions fastplotlib/graphics/features/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,12 @@ def cleanup_slice(key: Union[int, slice], upper_bound) -> Union[slice, int]:
if isinstance(key, int):
return key

if isinstance(key, np.ndarray):
return cleanup_array_slice(key, upper_bound)

# if isinstance(key, np.integer):
# return int(key)

if isinstance(key, tuple):
# if tuple of slice we only need the first obj
# since the first obj is the datapoint indices
Expand Down Expand Up @@ -197,13 +203,54 @@ def cleanup_slice(key: Union[int, slice], upper_bound) -> Union[slice, int]:
stop = upper_bound

elif stop > upper_bound:
raise IndexError("Index out of bounds")
raise IndexError(f"Index: `{stop}` out of bounds for feature array of size: `{upper_bound}`")

step = key.step
if step is None:
step = 1

return slice(start, stop, step)
# return slice(int(start), int(stop), int(step))


def cleanup_array_slice(key: np.ndarray, upper_bound) -> np.ndarray:
"""
Cleanup numpy array used for fancy indexing, make sure key[-1] <= upper_bound.

Parameters
----------
key: np.ndarray
integer or boolean array

upper_bound

Returns
-------
np.ndarray
integer indexing array

"""

if key.ndim > 1:
raise TypeError(
f"Can only use 1D boolean or integer arrays for fancy indexing"
)

# if boolean array convert to integer array of indices
if key.dtype == bool:
key = np.nonzero(key)[0]

# make sure indices within bounds of feature buffer range
if key[-1] > upper_bound:
raise IndexError(f"Index: `{key[-1]}` out of bounds for feature array of size: `{upper_bound}`")

# make sure indices are integers
if np.issubdtype(key.dtype, np.integer):
return key

raise TypeError(
f"Can only use 1D boolean or integer arrays for fancy indexing"
)


class GraphicFeatureIndexable(GraphicFeature):
Expand Down Expand Up @@ -236,7 +283,8 @@ def _upper_bound(self) -> int:

def _update_range_indices(self, key):
"""Currently used by colors and positions data"""
key = cleanup_slice(key, self._upper_bound)
if not isinstance(key, np.ndarray):
key = cleanup_slice(key, self._upper_bound)

if isinstance(key, int):
self.buffer.update_range(key, size=1)
Expand All @@ -254,6 +302,12 @@ def _update_range_indices(self, key):
ixs = range(key.start, key.stop, step)
for ix in ixs:
self.buffer.update_range(ix, size=1)

# TODO: See how efficient this is with large indexing
elif isinstance(key, np.ndarray):
for ix in key:
self.buffer.update_range(int(ix), size=1)

else:
raise TypeError("must pass int or slice to update range")

26 changes: 18 additions & 8 deletions fastplotlib/graphics/features/_colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import numpy as np

from ._base import GraphicFeature, GraphicFeatureIndexable, cleanup_slice, FeatureEvent
from ._base import GraphicFeature, GraphicFeatureIndexable, cleanup_slice, FeatureEvent, cleanup_array_slice
from ...utils import make_colors, get_cmap_texture, make_pygfx_colors
from pygfx import Color

Expand Down Expand Up @@ -102,9 +102,8 @@ def __setitem__(self, key, value):
indices = range(_key.start, _key.stop, _key.step)

# or single numerical index
elif isinstance(key, int):
if key > self._upper_bound:
raise IndexError("Index out of bounds")
elif isinstance(key, (int, np.integer)):
key = cleanup_slice(key, self._upper_bound)
indices = [key]

elif isinstance(key, tuple):
Expand All @@ -128,6 +127,10 @@ def __setitem__(self, key, value):
self._feature_changed(key, value)
return

elif isinstance(key, np.ndarray):
key = cleanup_array_slice(key, self._upper_bound)
indices = key

else:
raise TypeError("Graphic features only support integer and numerical fancy indexing")

Expand Down Expand Up @@ -181,6 +184,8 @@ def _feature_changed(self, key, new_data):
indices = [key]
elif isinstance(key, slice):
indices = range(key.start, key.stop, key.step)
elif isinstance(key, np.ndarray):
indices = key
else:
raise TypeError("feature changed key must be slice or int")

Expand All @@ -205,11 +210,16 @@ def __init__(self, parent, colors):

def __setitem__(self, key, value):
key = cleanup_slice(key, self._upper_bound)
if not isinstance(key, slice):
raise TypeError("Cannot set cmap on single indices, must pass a slice object or "
"set it on the entire data.")
if not isinstance(key, (slice, np.ndarray)):
raise TypeError("Cannot set cmap on single indices, must pass a slice object, "
"numpy.ndarray or set it on the entire data.")

if isinstance(key, slice):
n_colors = len(range(key.start, key.stop, key.step))

n_colors = len(range(key.start, key.stop, key.step))
else:
# numpy array
n_colors = key.size

colors = make_colors(n_colors, cmap=value).astype(self._data.dtype)
super(CmapFeature, self).__setitem__(key, colors)
Expand Down
12 changes: 9 additions & 3 deletions fastplotlib/graphics/features/_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import numpy as np
from pygfx import Buffer, Texture

from ._base import GraphicFeatureIndexable, cleanup_slice, FeatureEvent, to_gpu_supported_dtype
from ._base import GraphicFeatureIndexable, cleanup_slice, FeatureEvent, to_gpu_supported_dtype, cleanup_array_slice


class PointsDataFeature(GraphicFeatureIndexable):
Expand Down Expand Up @@ -48,8 +48,12 @@ def _fix_data(self, data, parent):
return data

def __setitem__(self, key, value):
if isinstance(key, np.ndarray):
# make sure 1D array of int or boolean
key = cleanup_array_slice(key, self._upper_bound)

# put data into right shape if they're only indexing datapoints
if isinstance(key, (slice, int)):
if isinstance(key, (slice, int, np.ndarray, np.integer)):
value = self._fix_data(value, self._parent)
# otherwise assume that they have the right shape
# numpy will throw errors if it can't broadcast
Expand All @@ -66,10 +70,12 @@ def _update_range(self, key):
def _feature_changed(self, key, new_data):
if key is not None:
key = cleanup_slice(key, self._upper_bound)
if isinstance(key, int):
if isinstance(key, (int, np.integer)):
indices = [key]
elif isinstance(key, slice):
indices = range(key.start, key.stop, key.step)
elif isinstance(key, np.ndarray):
indices = key
elif key is None:
indices = None

Expand Down