-
Notifications
You must be signed in to change notification settings - Fork 4
/
core.py
1698 lines (1436 loc) · 56.5 KB
/
core.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Provides core functionality of imagetool."""
from __future__ import annotations
__all__ = ["ImageSlicerArea"]
import collections
import functools
import inspect
import os
import time
import weakref
from typing import TYPE_CHECKING, Any, Literal, TypedDict, cast
import numpy as np
import numpy.typing as npt
import pyqtgraph as pg
import xarray as xr
from qtpy import QtCore, QtGui, QtWidgets
from erlab.interactive.colors import (
BetterColorBarItem,
BetterImageItem,
pg_colormap_powernorm,
)
from erlab.interactive.imagetool.slicer import ArraySlicer
from erlab.interactive.utilities import BetterAxisItem, copy_to_clipboard
if TYPE_CHECKING:
from collections.abc import Callable, Iterable, Sequence
from pyqtgraph.graphicsItems.ViewBox import ViewBoxMenu
from pyqtgraph.GraphicsScene import mouseEvents
class ColorMapProperties(TypedDict):
cmap: str | pg.ColorMap
gamma: float
reversed: bool
highContrast: bool
zeroCentered: bool
suppressnanwarning = np.testing.suppress_warnings()
suppressnanwarning.filter(RuntimeWarning, r"All-NaN (slice|axis) encountered")
def _link_splitters(
s0: QtWidgets.QSplitter, s1: QtWidgets.QSplitter, reverse: bool = False
):
s0.blockSignals(True)
s1.blockSignals(True)
sizes = s0.sizes()
total = sum(sizes)
if reverse:
sizes = list(reversed(sizes))
sizes[0] = s1.sizes()[-1]
else:
sizes[0] = s1.sizes()[0]
if all(x == 0 for x in sizes[1:]) and sizes[0] != total:
sizes[1:] = [1] * len(sizes[1:])
try:
factor = (total - sizes[0]) / sum(sizes[1:])
except ZeroDivisionError:
factor = 0.0
for k in range(1, len(sizes)):
sizes[k] = round(sizes[k] * factor)
if reverse:
sizes = list(reversed(sizes))
s0.setSizes(sizes)
s0.blockSignals(False)
s1.blockSignals(False)
def _sync_splitters(s0: QtWidgets.QSplitter, s1: QtWidgets.QSplitter):
s0.splitterMoved.connect(lambda: _link_splitters(s1, s0))
s1.splitterMoved.connect(lambda: _link_splitters(s0, s1))
# class ItoolGraphicsLayoutWidget(pg.GraphicsLayoutWidget):
class ItoolGraphicsLayoutWidget(pg.PlotWidget):
# Unsure of whether to subclass GraphicsLayoutWidget or PlotWidget at the moment
# Will need to run some benchmarks in the future
def __init__(
self,
slicer_area: ImageSlicerArea,
display_axis: tuple[int, ...],
image: bool = False,
**item_kw,
):
# super().__init__()
# self.ci.layout.setContentsMargins(0, 0, 0, 0)
# self.ci.layout.setSpacing(3)
# self.plotItem = ItoolPlotItem(slicer_area, display_axis, image, **item_kw)
# self.addItem(self.plotItem)
super().__init__(
plotItem=ItoolPlotItem(slicer_area, display_axis, image, **item_kw),
)
self.viewport().setAttribute(
QtCore.Qt.WidgetAttribute.WA_AcceptTouchEvents, False
)
self.scene().sigMouseClicked.connect(self.getPlotItem().mouseDragEvent)
def getPlotItem(self) -> ItoolPlotItem:
return self.plotItem
def getPlotItemViewBox(self) -> pg.ViewBox:
return self.getPlotItem().vb
def link_slicer(
func: Callable | None = None,
*,
indices: bool = False,
steps: bool = False,
color: bool = False,
):
"""Sync decorated methods across multiple `ImageSlicerArea` instances.
Parameters
----------
func
The method to sync across multiple instances of `ImageSlicerArea`.
indices
If `True`, the input argument named `value` given to `func` are interpreted as
indices, and will be converted to appropriate values for other instances of
`ImageSlicerArea`. The behavior of this conversion is determined by `steps`. If
`True`, An input argument named `axis` of type integer must be present in the
decorated method to determine the axis along which the index is to be changed.
steps
If `False`, considers `value` as an absolute index. If `True`, considers `value`
as a relative value such as the number of steps or bins. See the implementation
of `SlicerLinkProxy` for more information.
color
Boolean whether the decorated method is related to visualization, such as
colormap control.
"""
def my_decorator(func: Callable):
@functools.wraps(func)
def wrapped(*args, **kwargs):
# skip sync if already synced
skip_sync: bool = kwargs.pop("__slicer_skip_sync", False)
out = func(*args, **kwargs)
if args[0].is_linked:
if not skip_sync:
all_args = inspect.Signature.from_callable(func).bind(
*args, **kwargs
)
all_args.apply_defaults()
obj: ImageSlicerArea = all_args.arguments.pop("self")
if obj._linking_proxy is not None:
obj._linking_proxy.sync(
obj,
func.__name__,
all_args.arguments,
indices,
steps,
color,
)
return out
return wrapped
if func is not None:
return my_decorator(func)
return my_decorator
class SlicerLinkProxy:
"""Internal class for handling linked `ImageSlicerArea` s.
Parameters
----------
link_colors
Whether to sync color related changes.
*slicers
The slicers to link.
"""
def __init__(self, *slicers: ImageSlicerArea, link_colors: bool = True):
self.link_colors = link_colors
self._slicers: set[ImageSlicerArea] = set()
for s in slicers:
self.add(s)
def add(self, slicer: ImageSlicerArea):
if slicer.is_linked:
if slicer._linking_proxy == self:
return
else:
raise ValueError("Already linked to another proxy.")
self._slicers.add(slicer)
slicer._linking_proxy = self
def remove(self, slicer: ImageSlicerArea):
self._slicers.remove(slicer)
slicer._linking_proxy = None
def sync(
self,
source: ImageSlicerArea,
funcname: str,
arguments: dict[str, Any],
indices: bool,
steps: bool,
color: bool,
):
"""Propagate changes across multiple `ImageSlicerArea`s.
This method is invoked every time a method decorated with :func:`link_slicer` in
a linked `ImageSlicerArea` is called.
Parameters
----------
source
Instance of `ImageSlicerArea` corresponding to the called method.
funcname
Name of the called method.
arguments
Arguments included in the function call.
indices, steps, color
Arguments given to the decorator. See :func:`link_slicer`
"""
if color and not self.link_colors:
return
for target in self._slicers.difference({source}):
getattr(target, funcname)(
**self.convert_args(source, target, arguments, indices, steps)
)
def convert_args(
self,
source: ImageSlicerArea,
target: ImageSlicerArea,
args: dict[str, Any],
indices: bool,
steps: bool,
):
if indices:
index: int | None = args.get("value", None)
if index is not None:
axis: int | None = args.get("axis")
if axis is None:
raise ValueError(
"Axis argument not found in decorated method with `indices=True`"
)
args["value"] = self.convert_index(source, target, axis, index, steps)
args["__slicer_skip_sync"] = True # passed onto the decorator
return args
@staticmethod
def convert_index(
source: ImageSlicerArea,
target: ImageSlicerArea,
axis: int,
index: int,
steps: bool,
):
if steps:
return round(
index * source.array_slicer.incs[axis] / target.array_slicer.incs[axis]
)
else:
value: np.float32 = source.array_slicer.value_of_index(
axis, index, uniform=False
)
new_index: int = target.array_slicer.index_of_value(
axis, value, uniform=False
)
return new_index
class ImageSlicerArea(QtWidgets.QWidget):
"""A interactive tool based on :mod:`pyqtgraph` for exploring 3D data.
Parameters
----------
parent
Parent widget.
data
Data to display. The data must have 2 to 4 dimensions.
cmap
Default colormap of the data.
gamma
Default power law normalization of the colormap.
zeroCentered
If `True`, the normalization is applied symmetrically from the midpoint of
the colormap.
rad2deg
If `True` and `data` is not `None`, converts some known angle coordinates to
degrees. If an iterable of strings is given, only the coordinates that
correspond to the given strings are converted.
bench
Prints the fps on Ctrl + drag, for debug purposes
Signals
-------
sigDataChanged()
sigCurrentCursorChanged(index)
sigViewOptionChanged()
sigCursorCountChanged(n_cursors)
Inherited from :class:`erlab.interactive.slicer.ArraySlicer`.
sigIndexChanged(cursor, axes)
Inherited from :class:`erlab.interactive.slicer.ArraySlicer`.
sigBinChanged(cursor, axes)
Inherited from :class:`erlab.interactive.slicer.ArraySlicer`.
sigShapeChanged()
Inherited from :class:`erlab.interactive.slicer.ArraySlicer`.
"""
COLORS: tuple[QtGui.QColor, ...] = (
pg.mkColor(0.8),
pg.mkColor("y"),
pg.mkColor("m"),
pg.mkColor("c"),
pg.mkColor("g"),
pg.mkColor("r"),
pg.mkColor("b"),
) #: :class:`PySide6.QtGui.QColor`\ s for multiple cursors.
sigDataChanged = QtCore.Signal() #: :meta private:
sigCurrentCursorChanged = QtCore.Signal(int) #: :meta private:
sigViewOptionChanged = QtCore.Signal() #: :meta private:
@property
def sigCursorCountChanged(self) -> QtCore.SignalInstance:
""":meta private:""" # noqa: D400
return self.array_slicer.sigCursorCountChanged
@property
def sigIndexChanged(self) -> QtCore.SignalInstance:
""":meta private:""" # noqa: D400
return self.array_slicer.sigIndexChanged
@property
def sigBinChanged(self) -> QtCore.SignalInstance:
""":meta private:""" # noqa: D400
return self.array_slicer.sigBinChanged
@property
def sigShapeChanged(self) -> QtCore.SignalInstance:
""":meta private:""" # noqa: D400
return self.array_slicer.sigShapeChanged
def __init__(
self,
parent: QtWidgets.QWidget | None = None,
data: xr.DataArray | npt.ArrayLike | None = None,
cmap: str | pg.ColorMap = "magma",
gamma: float = 0.5,
zeroCentered: bool = False,
rad2deg: bool | Iterable[str] = False,
*,
bench: bool = False,
image_cls=None,
plotdata_cls=None,
):
super().__init__(parent)
self._linking_proxy: SlicerLinkProxy | None = None
self.bench = bench
layout = QtWidgets.QHBoxLayout()
self.setLayout(layout)
layout.setContentsMargins(0, 0, 0, 0)
layout.setSpacing(0)
self._splitters = (
QtWidgets.QSplitter(QtCore.Qt.Orientation.Vertical),
QtWidgets.QSplitter(QtCore.Qt.Orientation.Horizontal),
QtWidgets.QSplitter(QtCore.Qt.Orientation.Vertical),
QtWidgets.QSplitter(QtCore.Qt.Orientation.Vertical),
QtWidgets.QSplitter(QtCore.Qt.Orientation.Horizontal),
QtWidgets.QSplitter(QtCore.Qt.Orientation.Vertical),
QtWidgets.QSplitter(QtCore.Qt.Orientation.Horizontal),
)
for s in self._splitters:
s.setHandleWidth(4)
s.setStyleSheet("QSplitter::handle{background: #222222;}")
# palette = s.palette()
# palette.setColor(QtGui.QPalette.ColorRole.Light, QtGui.QColor("yellow"))
# s.setPalette(palette)
# print(s.handleWidth())
# pass
layout.addWidget(self._splitters[0])
for i, j in ((0, 1), (1, 2), (1, 3), (0, 4), (4, 5), (4, 6)):
self._splitters[i].addWidget(self._splitters[j])
_sync_splitters(self._splitters[1], self._splitters[4])
self.cursor_colors: list[QtGui.QColor] = [self.COLORS[0]]
self._colorbar = ItoolColorBar(self)
layout.addWidget(self._colorbar)
self._colorbar.setVisible(False)
pkw = {"image_cls": image_cls, "plotdata_cls": plotdata_cls}
self.manual_limits: dict[str, list[float]] = {}
self._plots: tuple[ItoolGraphicsLayoutWidget, ...] = (
ItoolGraphicsLayoutWidget(self, image=True, display_axis=(0, 1), **pkw),
ItoolGraphicsLayoutWidget(self, display_axis=(0,), **pkw),
ItoolGraphicsLayoutWidget(self, display_axis=(1,), is_vertical=True, **pkw),
ItoolGraphicsLayoutWidget(self, display_axis=(2,), **pkw),
ItoolGraphicsLayoutWidget(self, image=True, display_axis=(0, 2), **pkw),
ItoolGraphicsLayoutWidget(self, image=True, display_axis=(2, 1), **pkw),
ItoolGraphicsLayoutWidget(self, display_axis=(3,), **pkw),
ItoolGraphicsLayoutWidget(self, image=True, display_axis=(3, 2), **pkw),
)
for i in (1, 4):
self._splitters[2].addWidget(self._plots[i])
for i in (6, 3, 7):
self._splitters[3].addWidget(self._plots[i])
self._splitters[5].addWidget(self._plots[0])
for i in (5, 2):
self._splitters[6].addWidget(self._plots[i])
self.qapp = cast(QtWidgets.QApplication, QtWidgets.QApplication.instance())
self.qapp.aboutToQuit.connect(self.on_close)
cmap_reversed = False
if isinstance(cmap, str):
if cmap.endswith("_r"):
cmap = cmap[:-2]
cmap_reversed = True
if cmap.startswith("cet_CET"):
cmap = cmap[4:]
self.colormap_properties: ColorMapProperties = {
"cmap": cmap,
"gamma": gamma,
"reversed": cmap_reversed,
"highContrast": False,
"zeroCentered": zeroCentered,
}
self._data: xr.DataArray | None = None
self.current_cursor: int = 0
self.levels_locked: bool = False
if data is not None:
self.set_data(data, rad2deg=rad2deg)
if self.bench:
print("\n")
def on_close(self):
self.array_slicer.clear_cache()
self.data.close()
if hasattr(self, "_data") and self._data is not None:
self._data.close()
del self._data
def connect_axes_signals(self):
for ax in self.axes:
ax.connect_signals()
def disconnect_axes_signals(self):
for ax in self.axes:
ax.disconnect_signals()
def connect_signals(self):
self.connect_axes_signals()
self.sigDataChanged.connect(self.refresh_all)
self.sigShapeChanged.connect(self.refresh_all)
self.sigCursorCountChanged.connect(lambda: self.set_colormap(update=True))
def add_link(self, proxy: SlicerLinkProxy):
proxy.add(self)
def remove_link(self):
if self.is_linked:
cast(SlicerLinkProxy, self._linking_proxy).remove(self)
@property
def is_linked(self) -> bool:
return self._linking_proxy is not None
@property
def colormap(self) -> str | pg.ColorMap:
return self.colormap_properties["cmap"]
@property
def slices(self) -> tuple[ItoolPlotItem, ...]:
if self.data.ndim == 2:
return ()
elif self.data.ndim == 3:
return tuple(self.get_axes(ax) for ax in (4, 5))
elif self.data.ndim == 4:
return tuple(self.get_axes(ax) for ax in (4, 5, 7))
else:
raise ValueError("Data must have 2 to 4 dimensions")
@property
def profiles(self) -> tuple[ItoolPlotItem, ...]:
if self.data.ndim == 2:
profile_axes = [1, 2]
elif self.data.ndim == 3:
profile_axes = [1, 2, 3]
else:
profile_axes = [1, 2, 3, 6]
return tuple(self.get_axes(ax) for ax in profile_axes)
@property
def main_image(self) -> ItoolPlotItem:
"""Return the main PlotItem."""
return self.get_axes(0)
@property
def images(self) -> tuple[ItoolPlotItem, ...]:
return (self.main_image, *self.slices)
@property
def axes(self) -> tuple[ItoolPlotItem, ...]:
"""Currently valid subset of self._plots."""
return self.images + self.profiles
@property
def _imageitems(self) -> tuple[ItoolImageItem, ...]:
return tuple(im for ax in self.images for im in ax.slicer_data_items)
@property
def array_slicer(self) -> ArraySlicer:
return self._array_slicer
@property
def n_cursors(self) -> int:
return self.array_slicer.n_cursors
@property
def current_indices(self) -> list[int]:
return self.array_slicer.get_indices(self.current_cursor)
@property
def current_values(self) -> list[float]:
return self.array_slicer.get_values(self.current_cursor, uniform=False)
@property
def current_values_uniform(self) -> list[float]:
return self.array_slicer.get_values(self.current_cursor, uniform=True)
@property
def data(self) -> xr.DataArray:
return self.array_slicer._obj
@property
def color_locked(self) -> bool:
return self._colorbar.isVisible()
def get_current_index(self, axis: int) -> int:
return self.array_slicer.get_index(self.current_cursor, axis)
def get_current_value(self, axis: int, uniform: bool = False) -> float:
return self.array_slicer.get_value(self.current_cursor, axis, uniform=uniform)
def get_axes_widget(self, index: int) -> ItoolGraphicsLayoutWidget:
return self._plots[index]
def get_axes(self, index: int) -> ItoolPlotItem:
return self._plots[index].plotItem
@QtCore.Slot()
@QtCore.Slot(tuple)
@QtCore.Slot(tuple, bool)
def refresh_all(
self, axes: tuple[int, ...] | None = None, only_plots: bool = False
):
for c in range(self.n_cursors):
self.sigIndexChanged.emit(c, axes)
if not only_plots:
for ax in self.axes:
ax.refresh_labels()
@QtCore.Slot(tuple)
@link_slicer
def refresh_current(self, axes: tuple[int, ...] | None = None):
self.sigIndexChanged.emit(self.current_cursor, axes)
@QtCore.Slot(int, list)
@link_slicer
def refresh(self, cursor: int, axes: tuple[int, ...] | None = None):
self.sigIndexChanged.emit(cursor, axes)
def view_all(self):
for ax in self.axes:
ax.vb.enableAutoRange()
ax.vb.updateAutoRange()
@link_slicer
def center_all_cursors(self):
for i in range(self.n_cursors):
self.array_slicer.center_cursor(i)
@link_slicer
def center_cursor(self):
self.array_slicer.center_cursor(self.current_cursor)
@link_slicer
def set_current_cursor(self, cursor: int, update=True):
if cursor > self.n_cursors - 1:
raise IndexError("Cursor index out of range")
self.current_cursor = cursor
if update:
self.refresh_current()
self.sigCurrentCursorChanged.emit(cursor)
def set_data(
self, data: xr.DataArray | npt.ArrayLike, rad2deg: bool | Iterable[str] = False
):
"""Set the data to be displayed.
Parameters
----------
data
The data to be displayed. If a `xarray.DataArray` is given, the
dimensions and coordinates are used to determine the axes of the plots. If a
:class:`xarray.Dataset` is given, the first data variable is used. If a
:class:`numpy.ndarray` is given, it is converted to a `xarray.DataArray`
with default dimensions.
rad2deg
If `True`, converts coords along dimensions that have angle-like names to
degrees. If an iterable of strings is given, coordinates for dimensions that
correspond to the given strings are converted.
"""
if hasattr(self, "_array_slicer"):
n_cursors_old = self.n_cursors
if isinstance(self._data, xr.DataArray):
self._data.close()
del self._data
self.disconnect_axes_signals()
else:
n_cursors_old = 1
if not isinstance(data, xr.DataArray):
if isinstance(data, xr.Dataset):
data = data[next(iter(data.data_vars.keys()))]
else:
data = xr.DataArray(np.asarray(data))
if hasattr(data.data, "flags"):
if not data.data.flags["WRITEABLE"]:
data = data.copy()
if not rad2deg:
self._data = data
else:
if np.iterable(rad2deg):
conv_dims = rad2deg
else:
conv_dims = [
d
for d in ("phi", "theta", "beta", "alpha", "chi", "xi")
if d in data.dims
]
self._data = data.assign_coords({d: np.rad2deg(data[d]) for d in conv_dims})
if hasattr(self, "_array_slicer"):
self._array_slicer.set_array(self._data, reset=True)
else:
self._array_slicer: ArraySlicer = ArraySlicer(self._data)
while self.n_cursors != n_cursors_old:
self.array_slicer.add_cursor(update=False)
self.connect_signals()
self.adjust_layout()
if self.current_cursor > self.n_cursors - 1:
self.set_current_cursor(self.n_cursors - 1, update=False)
self.sigDataChanged.emit()
# self.refresh_current()
self.set_colormap(update=True)
self._colorbar.cb.setImageItem()
self.lock_levels(False)
def update_values(self, values: npt.NDArray | xr.DataArray, update: bool = True):
"""Update only the values of the data.
The coords and shape of the data array are not changed.
Parameters
----------
values
The new values to be set. If a `xarray.DataArray` is given, the dimensions
must match the current data array. If a `numpy.ndarray` is given, the shape
must match the current data array. Note that if the user has transposed the
current data array, passing a `numpy.ndarray` with the original shape will
fail.
update
If `True`, the plots are updated after setting the new values.
Note
----
This method only checks for matching dimension name and shape, and does not
check for equal coordinate values.
"""
if isinstance(values, xr.DataArray):
if self.array_slicer._obj.ndim != values.ndim:
raise ValueError("DataArray dimensions do not match")
if set(self.array_slicer._obj.dims) != set(values.dims):
raise ValueError("DataArray dimensions do not match")
if self.array_slicer._obj.dims != values.dims:
values = values.transpose(*self.array_slicer._obj.dims)
if self.array_slicer._obj.shape != values.shape:
raise ValueError("DataArray shape does not match")
values = values.values
else:
if self.array_slicer._obj.shape != values.shape:
raise ValueError(
"Data shape does not match. Array is "
f"{self.array_slicer._obj.shape} but {values.shape} given"
)
self.array_slicer._obj[:] = values
if update:
self.array_slicer.clear_val_cache(include_vals=True)
self.refresh_all(only_plots=True)
@QtCore.Slot(int, int)
@link_slicer
def swap_axes(self, ax1: int, ax2: int):
self.array_slicer.swap_axes(ax1, ax2)
@QtCore.Slot(int, int, bool)
@link_slicer(indices=True)
def set_index(
self, axis: int, value: int, update: bool = True, cursor: int | None = None
):
if cursor is None:
cursor = self.current_cursor
self.array_slicer.set_index(cursor, axis, value, update)
@QtCore.Slot(int, int, bool)
@link_slicer(indices=True, steps=True)
def step_index(
self, axis: int, value: int, update: bool = True, cursor: int | None = None
):
if cursor is None:
cursor = self.current_cursor
self.array_slicer.step_index(cursor, axis, value, update)
@QtCore.Slot(int, int, bool)
@link_slicer(indices=True, steps=True)
def step_index_all(self, axis: int, value: int, update: bool = True):
for i in range(self.n_cursors):
self.array_slicer.step_index(i, axis, value, update)
@QtCore.Slot(int, float, bool, bool)
@link_slicer
def set_value(
self,
axis: int,
value: float,
update: bool = True,
uniform: bool = False,
cursor: int | None = None,
):
if cursor is None:
cursor = self.current_cursor
self.array_slicer.set_value(cursor, axis, value, update, uniform)
@QtCore.Slot(int, int, bool)
@link_slicer(indices=True, steps=True)
def set_bin(
self, axis: int, value: int, update: bool = True, cursor: int | None = None
):
if cursor is None:
cursor = self.current_cursor
new_bins: list[int | None] = [None] * self.data.ndim
new_bins[axis] = value
self.array_slicer.set_bins(cursor, new_bins, update)
@QtCore.Slot(int, int, bool)
@link_slicer(indices=True, steps=True)
def set_bin_all(self, axis: int, value: int, update: bool = True):
new_bins: list[int | None] = [None] * self.data.ndim
new_bins[axis] = value
for c in range(self.n_cursors):
self.array_slicer.set_bins(c, new_bins, update)
@QtCore.Slot()
@link_slicer
def add_cursor(self):
self.array_slicer.add_cursor(self.current_cursor, update=False)
self.cursor_colors.append(self.gen_cursor_color(self.n_cursors - 1))
self.current_cursor = self.n_cursors - 1
for ax in self.axes:
ax.add_cursor(update=False)
self._colorbar.cb.level_change()
self.refresh_current()
self.sigCursorCountChanged.emit(self.n_cursors)
self.sigCurrentCursorChanged.emit(self.current_cursor)
@QtCore.Slot(int)
@link_slicer
def remove_cursor(self, index: int):
if self.n_cursors == 1:
return
self.array_slicer.remove_cursor(index, update=False)
self.cursor_colors.pop(index)
if self.current_cursor == index:
if index == 0:
self.current_cursor = 1
self.current_cursor -= 1
for ax in self.axes:
ax.remove_cursor(index)
self.refresh_current()
self.sigCursorCountChanged.emit(self.n_cursors)
self.sigCurrentCursorChanged.emit(self.current_cursor)
@QtCore.Slot()
def remove_current_cursor(self):
self.remove_cursor(self.current_cursor)
def gen_cursor_color(self, index: int) -> QtGui.QColor:
clr = self.COLORS[index % len(self.COLORS)]
while clr in self.cursor_colors:
clr = self.COLORS[index % len(self.COLORS)]
if self.n_cursors > len(self.COLORS):
break
index += 1
return clr
def gen_cursor_colors(
self, index: int
) -> tuple[QtGui.QColor, QtGui.QColor, QtGui.QColor, QtGui.QColor, QtGui.QColor]:
clr = self.cursor_colors[index]
clr_cursor = pg.mkColor(clr)
clr_cursor_hover = pg.mkColor(clr)
clr_span = pg.mkColor(clr)
clr_span_edge = pg.mkColor(clr)
clr_cursor.setAlphaF(0.75)
clr_cursor_hover.setAlphaF(0.95)
clr_span.setAlphaF(0.15)
clr_span_edge.setAlphaF(0.35)
return clr, clr_cursor, clr_cursor_hover, clr_span, clr_span_edge
@link_slicer(color=True)
def set_colormap(
self,
cmap: str | pg.ColorMap | None = None,
gamma: float | None = None,
reversed: bool | None = None,
highContrast: bool | None = None,
zeroCentered: bool | None = None,
update: bool = True,
):
if cmap is not None:
self.colormap_properties["cmap"] = cmap
if gamma is not None:
self.colormap_properties["gamma"] = gamma
if reversed is not None:
self.colormap_properties["reversed"] = reversed
if highContrast is not None:
self.colormap_properties["highContrast"] = highContrast
if zeroCentered is not None:
self.colormap_properties["zeroCentered"] = zeroCentered
cmap = pg_colormap_powernorm(
self.colormap_properties["cmap"],
self.colormap_properties["gamma"],
self.colormap_properties["reversed"],
highContrast=self.colormap_properties["highContrast"],
zeroCentered=self.colormap_properties["zeroCentered"],
)
for im in self._imageitems:
im.set_pg_colormap(cmap, update=update)
self.sigViewOptionChanged.emit()
@QtCore.Slot(bool)
def lock_levels(self, lock: bool):
self.levels_locked = lock
if self.levels_locked:
levels = self.array_slicer.limits
self._colorbar.cb.setLimits(levels)
for im in self._imageitems:
if self.levels_locked:
im.setLevels(levels, update=False)
else:
im.levels = None
im.refresh_data()
self._colorbar.setVisible(self.levels_locked)
self.sigViewOptionChanged.emit()
def adjust_layout(
self,
horiz_pad: int = 45,
vert_pad: int = 30,
font_size: float = 11.0,
r: tuple[float, float, float, float] = (1.2, 1.5, 3.0, 1.0),
):
"""Determine the padding and aspect ratios.
Parameters
----------
horiz_pad, vert_pad
Reserved space for the x and y axes.
font_size
Font size in points.
r
4 numbers that determine the layout aspect ratios. See notes.
Notes
-----
Axes indices and layout parameters.
.. code-block:: text
┌───────────┬───────────┐
r[0] │ 1 │ 6 │
│ ├───────────┤
├───────────┤ 3 │
r[1] │ 4 ├───────────┤
│ │ 7 │
│───────────┼───────┬───┤
│ │ │ │
r[2] │ 0 │ 5 │ 2 │
│ │ │ │
└───────────┴───────┴───┘
r[3] * r[2]
"""
font = QtGui.QFont()
font.setPointSizeF(float(font_size))
valid_axis: tuple[tuple[Literal[0, 1], ...], ...] = (
(1, 0, 0, 1),
(1, 1, 0, 0),
(0, 0, 1, 1),
(0, 1, 1, 0),
(1, 0, 0, 0),
(0, 0, 0, 1),
(0, 1, 1, 0),
(0, 1, 1, 0),
) # booleans corresponding to the (left, top, right, bottom) axes of each plot.
invalid: list[int] = [] # axes to hide.
r0, r1, r2, r3 = r
# !TODO: automate this based on ItoolPlotItem.display_axis
if self.data.ndim == 2:
invalid = [4, 5, 6, 7]
r1 = r0 / 6
elif self.data.ndim == 3:
invalid = [6, 7]
r01 = r0 / r1
scale = 100
d = self._splitters[0].handleWidth() / scale # padding due to splitters
sizes: list[tuple[float, ...]] = [
(r0 + r1, r2),
(r3 * r2, r3 * (r0 + r1)),
((r0 + r1 - d) * r01, (r0 + r1 - d) / r01),
((r0 + r1 - d) / 2, (r0 + r1 - d) / 2, 0),
(r3 * r2, r3 * (r0 + r1)),
(r2,),
((r3 * (r0 + r1) - d) / r01, (r3 * (r0 + r1) - d) * r01),
]
if self.data.ndim == 4:
sizes[3] = (0, 0, (r0 + r1 - d))
for split, sz in zip(self._splitters, sizes, strict=True):
split.setSizes(tuple(round(s * scale) for s in sz))
for i, sel in enumerate(valid_axis):
self.get_axes_widget(i).setVisible(i not in invalid)
if i in invalid:
continue
axes = self.get_axes(i)
axes.setDefaultPadding(0)
for axis in ("left", "bottom", "right", "top"):
axes.getAxis(axis).setTickFont(font)
axes.getAxis(axis).setStyle(
autoExpandTextSpace=True, autoReduceTextSpace=True
)