-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathbasetransform.py
More file actions
310 lines (250 loc) · 9.64 KB
/
basetransform.py
File metadata and controls
310 lines (250 loc) · 9.64 KB
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
# -*- coding: utf-8 -*-
#
# Licensed under the terms of the BSD 3-Clause
# (see plotpy/LICENSE for details)
"""
base
----
The `base` module provides base objects for internal use of the
:mod:`.widgets` package.
"""
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Union
from guidata.configtools import get_icon
from guidata.qthelpers import create_toolbutton
from qtpy import QtWidgets as QW
from plotpy._scaler import INTERP_LINEAR
from plotpy.config import _
from plotpy.items import TrImageItem
from plotpy.plot import PlotOptions, PlotWidget
if TYPE_CHECKING:
import numpy as np
from plotpy.plot.base import BasePlot
from plotpy.plot.manager import PlotManager
from plotpy.widgets.fliprotate import FlipRotateWidget
from plotpy.widgets.rotatecrop import RotateCropWidget
TransfWidget = Union[FlipRotateWidget, RotateCropWidget]
class BaseTransform:
"""Base transform class (for manipulating TrImageItem objects)
This is to be mixed with a class providing the get_plot method,
like PlotDialog, or BaseTransformWidget (see below)
Args:
parent (QWidget): Parent widget
manager (PlotManager): Plot manager
"""
def __init__(self, parent: QW.QWidget, manager: PlotManager) -> None:
self.parent = parent
self.manager = manager
self.item: TrImageItem = None
self.item_original_state: tuple[bool, bool, bool, bool] = None
self.item_original_crop: tuple[float, float, float, float] = None
self.item_original_transform: tuple[float, float, float] = None
self.output_array: np.ndarray = None
# ------Public API----------------------------------------------------------
def get_result(self) -> np.ndarray:
"""Return the result array
Returns:
numpy.ndarray: Result array
"""
return self.output_array
def set_item(self, item: TrImageItem) -> None:
"""Set associated item
Args:
item (TrImageItem): Image item
"""
assert isinstance(item, TrImageItem)
self.item = item
self.item_original_state = (
item.can_select(),
item.can_move(),
item.can_resize(),
item.can_rotate(),
)
self.item_original_crop = item.get_crop()
self.item_original_transform = item.get_transform()
self.item.set_selectable(True)
self.item.set_movable(True)
self.item.set_resizable(False)
self.item.set_rotatable(True)
item.set_lut_threshold(2.0)
item.set_interpolation(INTERP_LINEAR)
plot = self.manager.get_plot()
plot.add_item(self.item)
# Setting the item as active item (even if the cropping rectangle item
# will also be set as active item just below), for the image tools to
# register this item (contrast, ...):
plot.set_active_item(self.item)
self.item.unselect()
def unset_item(self) -> None:
"""Unset the associated item, freeing memory"""
plot = self.manager.get_plot()
plot.del_item(self.item)
self.item = None
def reset(self) -> None:
"""Reset crop/transform image settings"""
self.item.set_crop(*self.item_original_crop)
self.item.set_transform(*self.item_original_transform)
self.reset_transformation()
self.apply_transformation()
def reset_transformation(self) -> None:
"""Reset transformation"""
raise NotImplementedError
def apply_transformation(self) -> None:
"""Apply transformation, e.g. crop or rotate"""
raise NotImplementedError
def compute_transformation(self) -> np.ndarray:
"""Compute transformation, return compute output array
Returns:
numpy.ndarray: Output array
"""
raise NotImplementedError
# ------Private API---------------------------------------------------------
def restore_original_state(self) -> None:
"""Restore item original state"""
select, move, resize, rotate = self.item_original_state
self.item.set_selectable(select)
self.item.set_movable(move)
self.item.set_resizable(resize)
self.item.set_rotatable(rotate)
def accept_changes(self) -> None:
"""Computed rotated/cropped array and apply changes to item"""
self.restore_original_state()
self.apply_transformation()
self.output_array = self.compute_transformation()
# Ignoring image position changes
pos_x0, pos_y0, _angle, sx, sy, hf, vf = self.item_original_transform
_pos_x0, _pos_y0, angle, _sx, _sy, hf, vf = self.item.get_transform()
self.item.set_transform(pos_x0, pos_y0, angle, sx, sy, hf, vf)
def reject_changes(self) -> None:
"""Restore item original transform settings"""
self.restore_original_state()
self.item.set_crop(*self.item_original_crop)
self.item.set_transform(*self.item_original_transform)
class BaseTransformWidget(QW.QWidget):
"""Base transform widget: see for example rotatecrop.py
Args:
parent (QWidget): Parent widget
toolbar (bool | None): Whether to show toolbar. Defaults to False.
options (dict | None): Plot options. Defaults to None.
"""
def __init__(
self,
parent: QW.QWidget,
toolbar: bool = False,
options: PlotOptions | dict[str, Any] | None = None,
) -> None:
super().__init__(parent)
if isinstance(options, dict):
options = PlotOptions(**options)
options = options if options is not None else PlotOptions()
options.type = "image"
self.plot_widget = PlotWidget(self, options=options, toolbar=toolbar)
self.plot_widget.manager.register_all_image_tools()
hlayout = QW.QHBoxLayout()
self.add_buttons_to_layout(hlayout)
vlayout = QW.QVBoxLayout()
vlayout.addWidget(self.plot_widget)
vlayout.addLayout(hlayout)
self.setLayout(vlayout)
def get_plot(self) -> BasePlot:
"""Required for BaseTransformMixin
Returns:
BasePlot: Plot widget
"""
return self.plot_widget.get_plot()
def add_buttons_to_layout(
self, layout: QW.QBoxLayout, apply=True, reset=True
) -> None:
"""Add tool buttons to layout
Args:
layout (QBoxLayout): Layout
apply (bool | None): Add apply button. Defaults to True.
reset (bool | None): Add reset button. Defaults to True.
"""
if reset:
self.__add_reset_button(layout)
if apply:
self.__add_apply_button(layout)
def __add_apply_button(self, layout: QW.QBoxLayout) -> None:
"""Add the standard apply button
Args:
layout (QBoxLayout): Layout
"""
apply_btn = create_toolbutton(
self.plot_widget,
text=_("Apply"),
icon=get_icon("apply.png"),
triggered=self.apply_transformation,
autoraise=False,
)
layout.addWidget(apply_btn)
layout.addStretch()
def __add_reset_button(self, layout: QW.QBoxLayout) -> None:
"""Add the standard reset button
Args:
layout (QBoxLayout): Layout
"""
edit_options_btn = create_toolbutton(
self.plot_widget,
text=_("Reset"),
icon=get_icon("eraser.png"),
triggered=self.reset,
autoraise=False,
)
layout.addWidget(edit_options_btn)
layout.addStretch()
def reset(self) -> None:
"""Reset crop/transform image settings"""
return NotImplementedError
def apply_transformation(self) -> None:
"""Apply transformation, e.g. crop or rotate"""
return NotImplementedError
class BaseMultipleTransformWidget(QW.QTabWidget):
"""Base Multiple Transform Widget
Transform several :py:class:`.image.TrImageItem` plot items
Args:
parent: Parent widget
options: Plot options. Defaults to None.
"""
TRANSFORM_WIDGET_CLASS: TransfWidget # to be defined in subclass
def __init__(self, parent: QW.QWidget, options: PlotOptions | None = None):
QW.QTabWidget.__init__(self, parent)
self.options = options
self.output_arrays = None
def set_items(self, *items: TrImageItem) -> None:
"""Set the associated items
Args:
*items (TrImageItem): Items
"""
for item in items:
self.add_item(item)
def add_item(self, item: TrImageItem) -> TransfWidget:
"""Add item to widget
Args:
item (TrImageItem): Item
"""
widget: TransfWidget = self.TRANSFORM_WIDGET_CLASS(self, options=self.options)
widget.transform.set_item(item)
self.addTab(widget, item.title().text())
return widget
def clear_items(self) -> None:
"""Clear all items, freeing memory"""
self.items = None
for index in range(self.count()):
self.widget(index).unset_item()
self.clear()
def reset(self) -> None:
"""Reset transform image settings"""
for index in range(self.count()):
self.widget(index).reset()
def accept_changes(self) -> None:
"""Accept all changes"""
self.output_arrays = []
for index in range(self.count()):
widget: TransfWidget = self.widget(index)
widget.transf.accept_changes()
self.output_arrays.append(widget.transf.output_array)
def reject_changes(self) -> None:
"""Reject all changes"""
for index in range(self.count()):
self.widget(index).reject_changes()