Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 5 additions & 10 deletions src/quantem/core/datastructures/dataset2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
from numpy.typing import NDArray

from quantem.core.datastructures.dataset import Dataset
from quantem.core.utils.utils import to_numpy
from quantem.core.utils.validators import ensure_valid_array
from quantem.core.visualization.visualization import show_2d
from quantem.core.visualization.visualization_utils import ScalebarConfig
Expand Down Expand Up @@ -159,21 +158,17 @@ def show(

Parameters
----------
scalebar: ScalebarConfig or bool
If True, displays scalebar
scalebar: ScalebarConfig, ShowParams.Scalebar, dict or bool
If True, displays a scalebar. Sampling and units are taken from the
dataset unless set explicitly, so e.g. ``{"outline_color": "black"}``
still gives a calibrated scalebar.
title: str
Title of Dataset
**kwargs: dict
Keyword arguments for show_2d
"""

if scalebar is True:
scalebar = ScalebarConfig(
sampling=self.sampling[-1],
units=self.units[-1],
)

if title is None:
title = self.name

return show_2d(to_numpy(self.array), scalebar=scalebar, title=title, **kwargs)
return show_2d(self, scalebar=scalebar, title=title, **kwargs)
18 changes: 15 additions & 3 deletions src/quantem/core/visualization/show_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from quantem.core.utils.validators import validate_gt, validate_lt
from quantem.core.visualization.custom_normalizations import NormalizationConfig
from quantem.core.visualization.visualization_utils import ScalebarConfig
from quantem.core.visualization.visualization_utils import ScalebarConfig, _parse_length_units


class ShowParams:
Expand Down Expand Up @@ -234,8 +234,13 @@ class Scalebar:
Unit label displayed on the scale bar (e.g. ``"Å"``, ``"nm"``,
``"1/Å"``). Default ``"pixels"``.
length : float or None
Fixed scale bar length in physical units. ``None`` auto-estimates
a "nice" length.
Fixed scale bar length in physical units (in ``display_units`` if
given). ``None`` auto-estimates a "nice" length.
display_units : str or None
Units to show the scale bar in, converting from ``units``: e.g.
``"nm"`` for data calibrated in ``"μm"``, or ``"1/Å"`` for data in
``"1/nm"``. Supports pm, Å, nm, μm, mm, cm, m and their reciprocals.
``None`` picks units automatically from the bar length.
width_px : float
Thickness of the bar in image pixels. Default 1.
pad_px : float
Expand Down Expand Up @@ -265,11 +270,13 @@ class Scalebar:
>>> ShowParams.Scalebar(sampling=0.5, units="Å")
>>> ShowParams.Scalebar(sampling=0.02, units="1/Å", color="black", fontsize=16)
>>> ShowParams.Scalebar(sampling=0.5, units="Å", outline_color="black")
>>> ShowParams.Scalebar(sampling=0.002, units="μm", display_units="nm")
"""

sampling: float = 1.0
units: str = "pixels"
length: float | None = None
display_units: str | None = None
width_px: float = 1
pad_px: float = 0.5
color: str = "white"
Expand All @@ -289,6 +296,11 @@ def __post_init__(self) -> None:
validate_gt(self.width_px, 0, "width_px")
validate_gt(self.fontsize, 0, "fontsize")
validate_gt(self.outline_width, 0, "outline_width")
if self.display_units is not None and _parse_length_units(self.display_units) is None:
raise ValueError(
f"Unknown display_units {self.display_units!r}; use pm, Å, nm, μm, mm, cm, "
"m or a reciprocal such as '1/nm'."
)
if not 0 <= self.box_alpha <= 1:
raise ValueError(f"box_alpha must be between 0 and 1, got {self.box_alpha}")

Expand Down
35 changes: 35 additions & 0 deletions src/quantem/core/visualization/visualization.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from quantem.core.visualization.show_params import ShowParams
from quantem.core.visualization.visualization_utils import (
ScalebarConfig,
_fill_scalebar_calibration,
_resolve_scalebar,
add_arg_cbar_to_ax,
add_cbar_to_ax,
Expand Down Expand Up @@ -185,6 +186,7 @@ def _show_2d_array(
box_alpha=scalebar_config.box_alpha,
outline_color=scalebar_config.outline_color,
outline_width=scalebar_config.outline_width,
display_units=scalebar_config.display_units,
)

for spine in ax.spines.values(): # fixes asymmetry of bbox for some reason
Expand Down Expand Up @@ -307,11 +309,32 @@ def _show_2d_combined(
box_alpha=scalebar_config.box_alpha,
outline_color=scalebar_config.outline_color,
outline_width=scalebar_config.outline_width,
display_units=scalebar_config.display_units,
)

return fig, ax


def _dataset_calibration_grid(arrays: Any) -> list[list[tuple[float, str] | None]]:
"""Return (sampling, units) for each Dataset2d in the input grid, None for plain arrays.

Mirrors the grid layout of ``_normalize_show_input_to_grid`` so entries line up
with the panels, and must be called before ``to_cpu`` strips the datasets.
"""
from quantem.core.datastructures import Dataset2d

def calib(obj: Any) -> tuple[float, str] | None:
if isinstance(obj, Dataset2d):
return float(obj.sampling[-1]), str(obj.units[-1])
return None

if not isinstance(arrays, (list, tuple)) or len(arrays) == 0:
return [[calib(arrays)]]
if not isinstance(arrays[0], (list, tuple)):
return [[calib(a) for a in arrays]]
return [[calib(a) for a in row] for row in arrays]


def _normalize_show_input_to_grid(
arrays: Any, # NDArray | Sequence[NDArray] | Sequence[Sequence[NDArray]]
) -> list[list[NDArray]]:
Expand Down Expand Up @@ -577,6 +600,7 @@ def show_2d(
>>> labels = [["BF", "ADF", "ABF"], ["HAADF", "DPC", "SSB"]]
>>> fig, axs = show_2d(rows, title=labels, cmap="gray", scalebar={"sampling": 0.5, "units": "Å"})
"""
calibrations = _dataset_calibration_grid(arrays)
arrays = to_cpu(arrays)
grid = _normalize_show_input_to_grid(arrays)
nrows = len(grid)
Expand All @@ -589,6 +613,8 @@ def show_2d(
norm = norm[0] if not isinstance(norm[0], Sequence) else norm[0][0]
if isinstance(scalebar, Sequence): # flatten scalebar
scalebar = scalebar[0] if not isinstance(scalebar[0], Sequence) else scalebar[0][0]
if calibrations[0][0] is not None:
scalebar = _fill_scalebar_calibration(scalebar, *calibrations[0][0])
if isinstance(title, Sequence) and not isinstance(title, str): # flatten title
title = title[0] if isinstance(title[0], str) else title[0][0]

Expand Down Expand Up @@ -628,6 +654,15 @@ def show_2d(
for i, row in enumerate(grid):
for j, array in enumerate(row):
figax_local = (fig, axs[i][j])
calibration = (
calibrations[i][j]
if i < len(calibrations) and j < len(calibrations[i])
else None
)
if calibration is not None:
normalized_args[i][j]["scalebar"] = _fill_scalebar_calibration(
normalized_args[i][j]["scalebar"], *calibration
)
_show_2d_array(
array,
figax=figax_local,
Expand Down
Loading
Loading