44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
44 changes: 35 additions & 9 deletions src/spatialdata_plot/pl/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,28 @@
ColorLike = Union[tuple[float, ...], str]


def _is_color_like(color: Any) -> bool:
"""Check if a value is a valid color, returns False for pseudo-bools.

For discussion, see: https://github.com/scverse/spatialdata-plot/issues/327.
matplotlib accepts strings in [0, 1] as grey-scale values - therefore,
"0" and "1" are considered valid colors. However, we won't do that
so we're filtering these out.
"""
if isinstance(color, bool):
return False
if isinstance(color, str):
try:
num_value = float(color)
if 0 <= num_value <= 1:
return False
except ValueError:
# we're not dealing with what matplotlib considers greyscale
pass

return bool(colors.is_color_like(color))


def _prepare_params_plot(
# this param is inferred when `pl.show`` is called
num_panels: int,
Expand DownExpand Up@@ -532,7 +554,15 @@ def _normalize(

perc = np.percentile(img, [pmin, pmax])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps)
# Ensure perc is an array of two elements
if np.isscalar(perc):
logger.warning(
"Percentile range is too small, using the same percentile for both min "
"and max. Consider using a larger percentile range."
)
perc = np.array([perc, perc])

norm = (img - perc[0]) / (perc[1] - perc[0] + eps) # type: ignore

if clip:
norm = np.clip(norm, 0, 1)
Expand DownExpand Up@@ -727,7 +757,7 @@ def _map_color_seg(
val_im = np.squeeze(val_im, axis=0)
if "#" in str(color_vector[0]):
# we have hex colors
assert all(colors.is_color_like(c) for c in color_vector), "Not all values are color-like."
assert all(_is_color_like(c) for c in color_vector), "Not all values are color-like."
cols = colors.to_rgba_array(color_vector)
else:
cols = cmap_params.cmap(cmap_params.norm(color_vector))
Expand DownExpand Up@@ -1557,15 +1587,11 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
raise TypeError("Parameter 'contour_px' must be an integer.")

if (color := param_dict.get("color")) and element_type in {
"shapes",
"points",
"labels",
}:
if (color := param_dict.get("color")) and element_type in {"shapes", "points", "labels"}:
if not isinstance(color, str):
raise TypeError("Parameter 'color' must be a string.")
if element_type in {"shapes", "points"}:
if colors.is_color_like(color):
if _is_color_like(color):
logger.info("Value for parameter 'color' appears to be a color, using it as such.")
param_dict["col_for_color"] = None
else:
Expand DownExpand Up@@ -1645,7 +1671,7 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
raise TypeError("Parameter 'cmap' must be a string, a Colormap, or a list of these types.")

if (na_color := param_dict.get("na_color")) != "default" and (
na_color is not None and not colors.is_color_like(na_color)
na_color is not None and not _is_color_like(na_color)
):
raise ValueError("Parameter 'na_color' must be color-like.")

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions tests/pl/test_render_shapes.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import spatialdata_plot # noqa: F401
from anndata import AnnData
from shapely.geometry import MultiPolygon, Point, Polygon
from spatialdata import SpatialData
from spatialdata import SpatialData, deepcopy
from spatialdata.models import ShapesModel, TableModel

from tests.conftest import DPI, PlotTester, PlotTesterMeta
Expand DownExpand Up@@ -94,7 +94,7 @@ def _make_multi():
sdata.pl.render_shapes(color="val", outline=True, fill_alpha=0.3).pl.show()

def test_plot_can_color_from_geodataframe(self, sdata_blobs: SpatialData):
blob = sdata_blobs
blob = deepcopy(sdata_blobs)
blob["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
blob["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
blob.shapes["blobs_polygons"]["value"] = [1, 10, 1, 20, 1]
Expand Down
36 changes: 36 additions & 0 deletions tests/pl/test_utils.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from typing import Union

import matplotlib
import matplotlib.pyplot as plt
import numpy as np
Expand All@@ -23,6 +25,11 @@
# the comp. function can be accessed as `self.compare(<your_filename>, tolerance=<your_tolerance>)`
# ".png" is appended to <your_filename>, no need to set it

# replace with
# from spatialdata._types import ColorLike
# once https://github.com/scverse/spatialdata/pull/689/ is in a release
ColorLike = Union[tuple[float, ...], str]


class TestUtils(PlotTester, metaclass=PlotTesterMeta):
@pytest.mark.parametrize(
Expand All@@ -35,6 +42,18 @@ class TestUtils(PlotTester, metaclass=PlotTesterMeta):
def test_plot_set_outline_accepts_str_or_float_or_list_thereof(self, sdata_blobs: SpatialData, outline_color):
sdata_blobs.pl.render_shapes(element="blobs_polygons", outline=True, outline_color=outline_color).pl.show()

@pytest.mark.parametrize(
"colname",
["0", "0.5", "1"],
)
def test_plot_colnames_that_are_valid_matplotlib_greyscale_colors_are_not_evaluated_as_colors(
self, sdata_blobs: SpatialData, colname: str
):
sdata_blobs["table"].obs["region"] = ["blobs_polygons"] * sdata_blobs["table"].n_obs
sdata_blobs["table"].uns["spatialdata_attrs"]["region"] = "blobs_polygons"
sdata_blobs.shapes["blobs_polygons"][colname] = [1, 2, 3, 5, 20]
sdata_blobs.pl.render_shapes("blobs_polygons", color=colname).pl.show()

def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData):
from spatialdata_plot.pl.utils import set_zero_in_cmap_to_transparent

Expand All@@ -60,6 +79,23 @@ def test_plot_can_set_zero_in_cmap_to_transparent(self, sdata_blobs: SpatialData
).pl.show(ax=axs[1], colorbar=False)


@pytest.mark.parametrize(
"color_result",
[
("0", False),
("0.5", False),
("1", False),
("#00ff00", True),
((0.0, 1.0, 0.0, 1.0), True),
],
)
def test_is_color_like(color_result: tuple[ColorLike, bool]):

color, result = color_result

assert spatialdata_plot.pl.utils._is_color_like(color) == result


@pytest.mark.parametrize(
"input_output",
[
Expand Down