Skip to content

indexable graphic attributes #78

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
kushalkolar merged 11 commits into from
Dec 23, 2022
Merged

indexable graphic attributes #78

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
75cc2c7
started graphic attributes, colors work
kushalkolar Dec 19, 2022
865cbf0
cleanup ColorFeature
kushalkolar Dec 19, 2022
3012e20
more color indexing stuff
kushalkolar Dec 19, 2022
6904bb4
more organized color feature
kushalkolar Dec 19, 2022
5ceb397
ColorFeature working, updated graphics and base Graphic color handlin…
kushalkolar Dec 19, 2022
3c9ce6f
update simple.ipynb, better line plot example
kushalkolar Dec 19, 2022
f7dc063
can directly set graphic features, Graphic has __setattr__, added Gra…
kushalkolar Dec 21, 2022
71037f0
added PresentFeature to toggle graphic's presence in the scene
kushalkolar Dec 21, 2022
c0ccb03
add DataFeature, refactor to update other things, HistogramGraphic is…
kushalkolar Dec 22, 2022
78aeb2e
features now trigger events, similar format as pygfx events, tested a…
kushalkolar Dec 22, 2022
22f7283
warning if event handlers already registered or has weird argspec
kushalkolar Dec 22, 2022
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
Prev Previous commit
Next Next commit
add DataFeature, refactor to update other things, HistogramGraphic is… 
… broken because of DataFeature
  • Loading branch information
@kushalkolar
kushalkolar committed Dec 22, 2022
commit c0ccb03845f0e00abe6977258e15d1843c10a30a
20 changes: 10 additions & 10 deletions examples/gridplot.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions examples/gridplot_simple.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

19 changes: 8 additions & 11 deletions examples/lineplot.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

82 changes: 64 additions & 18 deletions examples/scatter.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

236 changes: 190 additions & 46 deletions examples/simple.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

38 changes: 25 additions & 13 deletions fastplotlib/graphics/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
from typing import *

import numpy as np
import pygfx

from fastplotlib.utils import get_colors, map_labels_to_colors
from ._graphic_attribute import GraphicFeature, ColorFeature, PresentFeature
from ..utils import get_colors
from .features import GraphicFeature, DataFeature, ColorFeature, PresentFeature


class Graphic:
Expand All @@ -21,21 +20,35 @@ def __init__(

Parameters
----------
data
data: array-like
data to show in the graphic, must be float32.
Automatically converted to float32 for numpy arrays.
Tensorflow Tensors also work but this is not fully
tested and might not be supported in the future.

colors: Any
if ``False``, no color generation is performed, cmap is also ignored.

n_colors
cmap
alpha
name

cmap: str
name of colormap to use

alpha: float, optional
alpha value for the colors

name: str, optional
name this graphic, makes it indexable within plots

"""
self.data = data.astype(np.float32)
# self.data = data.astype(np.float32)
self.data = DataFeature(parent=self, data=data, graphic_name=self.__class__.__name__)
self.colors = None

self.name = name

if n_colors is None:
n_colors = self.data.shape[0]
n_colors = self.data.feature_data.shape[0]

if cmap is not None and colors is not False:
colors = get_colors(n_colors=n_colors, cmap=cmap, alpha=alpha)
Expand All @@ -60,7 +73,8 @@ def world_object(self) -> pygfx.WorldObject:
return self._world_object

@property
def valid_features(self) -> Tuple[str]:
def interact_features(self) -> Tuple[str]:
"""The features for this ``Graphic`` that support interaction."""
return self._valid_features

@property
Expand All @@ -69,15 +83,13 @@ def visible(self) -> bool:

@visible.setter
def visible(self, v):
"""Toggle the visibility of this Graphic"""
self.world_object.visible = v

@property
def children(self) -> pygfx.WorldObject:
return self.world_object.children

def update_data(self, data: Any):
pass

def __setattr__(self, key, value):
if hasattr(self, key):
attr = getattr(self, key)
Expand Down
269 changes: 0 additions & 269 deletions fastplotlib/graphics/_graphic_attribute.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,272 +1,3 @@
from abc import ABC, abstractmethod
from typing import *
from pygfx import Color, Scene
import numpy as np


class GraphicFeature(ABC):
def __init__(self, parent, data: Any):
self._parent = parent
if isinstance(data, np.ndarray):
data = data.astype(np.float32)

self._data = data

@property
def data(self):
return self._data

@abstractmethod
def _set(self, value):
pass

@abstractmethod
def __repr__(self):
pass


class GraphicFeatureIndexable(GraphicFeature):
"""And indexable Graphic Feature, colors, data, sizes etc."""
def _set(self, value):
self[:] = value

@abstractmethod
def __getitem__(self, item):
pass

@abstractmethod
def __setitem__(self, key, value):
pass

@abstractmethod
def _update_range(self, key):
pass


def cleanup_slice(slice_obj: slice, upper_bound) -> slice:
start = slice_obj.start
stop = slice_obj.stop
step = slice_obj.step
for attr in [start, stop, step]:
if attr is None:
continue
if attr < 0:
raise IndexError("Negative indexing not supported.")

if start is None:
start = 0

if stop is None:
stop = upper_bound

elif stop > upper_bound:
raise IndexError("Index out of bounds")

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

return slice(start, stop, step)


class ColorFeature(GraphicFeatureIndexable):
def __init__(self, parent, colors, n_colors, alpha: float = 1.0):
"""
ColorFeature

Parameters
----------
parent: Graphic or GraphicCollection

colors: str, array, or iterable
specify colors as a single human readable string, RGBA array,
or an iterable of strings or RGBA arrays

n_colors: number of colors to hold, if passing in a single str or single RGBA array
"""
# if provided as a numpy array of str
if isinstance(colors, np.ndarray):
if colors.dtype.kind in ["U", "S"]:
colors = colors.tolist()
# if the color is provided as a numpy array
if isinstance(colors, np.ndarray):
if colors.shape == (4,): # single RGBA array
data = np.repeat(
np.array([colors]),
n_colors,
axis=0
)
# else assume it's already a stack of RGBA arrays, keep this directly as the data
elif colors.ndim == 2:
if colors.shape[1] != 4 and colors.shape[0] != n_colors:
raise ValueError(
"Valid array color arguments must be a single RGBA array or a stack of "
"RGBA arrays for each datapoint in the shape [n_datapoints, 4]"
)
data = colors
else:
raise ValueError(
"Valid array color arguments must be a single RGBA array or a stack of "
"RGBA arrays for each datapoint in the shape [n_datapoints, 4]"
)

# if the color is provided as an iterable
elif isinstance(colors, (list, tuple, np.ndarray)):
# if iterable of str
if all([isinstance(val, str) for val in colors]):
if not len(colors) == n_colors:
raise ValueError(
f"Valid iterable color arguments must be a `tuple` or `list` of `str` "
f"where the length of the iterable is the same as the number of datapoints."
)

data = np.vstack([np.array(Color(c)) for c in colors])

# if it's a single RGBA array as a tuple/list
elif len(colors) == 4:
c = Color(colors)
data = np.repeat(np.array([c]), n_colors, axis=0)

else:
raise ValueError(
f"Valid iterable color arguments must be a `tuple` or `list` representing RGBA values or "
f"an iterable of `str` with the same length as the number of datapoints."
)
else:
# assume it's a single color, use pygfx.Color to parse it
c = Color(colors)
data = np.repeat(np.array([c]), n_colors, axis=0)

if alpha != 1.0:
data[:, -1] = alpha

super(ColorFeature, self).__init__(parent, data)

self._upper_bound = data.shape[0]

def __setitem__(self, key, value):
# parse numerical slice indices
if isinstance(key, slice):
key = cleanup_slice(key, self._upper_bound)
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")
indices = [key]

elif isinstance(key, tuple):
if not isinstance(value, (float, int, np.ndarray)):
raise ValueError(
"If using multiple-fancy indexing for color, you can only set numerical"
"values since this sets the RGBA array data directly."
)

if len(key) != 2:
raise ValueError("fancy indexing for colors must be 2-dimension, i.e. [n_datapoints, RGBA]")

# set the user passed data directly
self._parent.world_object.geometry.colors.data[key] = value

# update range
_key = cleanup_slice(key[0], self._upper_bound)
self._update_range(_key)
return

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

new_data_size = len(indices)

if not isinstance(value, np.ndarray):
color = np.array(Color(value)) # pygfx color parser
# make it of shape [n_colors_modify, 4]
new_colors = np.repeat(
np.array([color]).astype(np.float32),
new_data_size,
axis=0
)

# if already a numpy array
elif isinstance(value, np.ndarray):
# if a single color provided as numpy array
if value.shape == (4,):
new_colors = value.astype(np.float32)
# if there are more than 1 datapoint color to modify
if new_data_size > 1:
new_colors = np.repeat(
np.array([new_colors]).astype(np.float32),
new_data_size,
axis=0
)

elif value.ndim == 2:
if value.shape[1] != 4 and value.shape[0] != new_data_size:
raise ValueError("numpy array passed to color must be of shape (4,) or (n_colors_modify, 4)")
# if there is a single datapoint to change color of but user has provided shape [1, 4]
if new_data_size == 1:
new_colors = value.ravel().astype(np.float32)
else:
new_colors = value.astype(np.float32)

else:
raise ValueError("numpy array passed to color must be of shape (4,) or (n_colors_modify, 4)")

self._parent.world_object.geometry.colors.data[key] = new_colors

self._update_range(key)

def _update_range(self, key):
if isinstance(key, int):
self._parent.world_object.geometry.colors.update_range(key, size=1)
if key.step is None:
# update range according to size using the offset
self._parent.world_object.geometry.colors.update_range(offset=key.start, size=key.stop - key.start)

else:
step = key.step
ixs = range(key.start, key.stop, step)
# convert slice to indices
for ix in ixs:
self._parent.world_object.geometry.colors.update_range(ix, size=1)

def __getitem__(self, item):
return self._parent.world_object.geometry.colors.data[item]

def __repr__(self):
return repr(self._parent.world_object.geometry.colors.data)


class PresentFeature(GraphicFeature):
"""
Toggles if the object is present in the scene, different from visible \n
Useful for computing bounding boxes from the Scene to only include graphics
that are present
"""
def __init__(self, parent, present: bool = True):
self._scene = None
super(PresentFeature, self).__init__(parent, present)

def _set(self, present: bool):
i = 0
while not isinstance(self._scene, Scene):
self._scene = self._parent.world_object.parent
i += 1

if i > 100:
raise RecursionError(
"Exceded scene graph depth threshold, cannot find Scene associated with"
"this graphic."
)

if present:
if self._parent.world_object not in self._scene.children:
self._scene.add(self._parent.world_object)

else:
if self._parent.world_object in self._scene.children:
self._scene.remove(self._parent.world_object)

def __repr__(self):
return repr(self.data)
4 changes: 4 additions & 0 deletions fastplotlib/graphics/features/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from ._colors import ColorFeature
from ._data import DataFeature
from ._present import PresentFeature
from ._base import GraphicFeature
Loading