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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2004-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""This module provides a set of QToolButton to use with :class:`.PlotWidget`.
The following QToolButton are available:
- :class:`AspectToolButton`
- :class:`YAxisOriginToolButton`
- :class:`ProfileToolButton`
"""
__authors__ = ["V. Valls", "H. Payno"]
__license__ = "MIT"
__date__ = "27/06/2017"
import logging
from .. import icons
from .. import qt
_logger = logging.getLogger(__name__)
class PlotToolButton(qt.QToolButton):
"""A QToolButton connected to a :class:`.PlotWidget`.
"""
def __init__(self, parent=None, plot=None):
super(PlotToolButton, self).__init__(parent)
self._plot = None
if plot is not None:
self.setPlot(plot)
def plot(self):
"""
Returns the plot connected to the widget.
"""
return self._plot
def setPlot(self, plot):
"""
Set the plot connected to the widget
:param plot: :class:`.PlotWidget` instance on which to operate.
"""
if self._plot is plot:
return
if self._plot is not None:
self._disconnectPlot(self._plot)
self._plot = plot
if self._plot is not None:
self._connectPlot(self._plot)
def _connectPlot(self, plot):
"""
Called when the plot is connected to the widget
:param plot: :class:`.PlotWidget` instance
"""
pass
def _disconnectPlot(self, plot):
"""
Called when the plot is disconnected from the widget
:param plot: :class:`.PlotWidget` instance
"""
pass
class AspectToolButton(PlotToolButton):
STATE = None
"""Lazy loaded states used to feed AspectToolButton"""
def __init__(self, parent=None, plot=None):
if self.STATE is None:
self.STATE = {}
# dont keep ratio
self.STATE[False, "icon"] = icons.getQIcon('shape-ellipse-solid')
self.STATE[False, "state"] = "Aspect ratio is not kept"
self.STATE[False, "action"] = "Do no keep data aspect ratio"
# keep ratio
self.STATE[True, "icon"] = icons.getQIcon('shape-circle-solid')
self.STATE[True, "state"] = "Aspect ratio is kept"
self.STATE[True, "action"] = "Keep data aspect ratio"
super(AspectToolButton, self).__init__(parent=parent, plot=plot)
keepAction = self._createAction(True)
keepAction.triggered.connect(self.keepDataAspectRatio)
keepAction.setIconVisibleInMenu(True)
dontKeepAction = self._createAction(False)
dontKeepAction.triggered.connect(self.dontKeepDataAspectRatio)
dontKeepAction.setIconVisibleInMenu(True)
menu = qt.QMenu(self)
menu.addAction(keepAction)
menu.addAction(dontKeepAction)
self.setMenu(menu)
self.setPopupMode(qt.QToolButton.InstantPopup)
def _createAction(self, keepAspectRatio):
icon = self.STATE[keepAspectRatio, "icon"]
text = self.STATE[keepAspectRatio, "action"]
return qt.QAction(icon, text, self)
def _connectPlot(self, plot):
plot.sigSetKeepDataAspectRatio.connect(self._keepDataAspectRatioChanged)
self._keepDataAspectRatioChanged(plot.isKeepDataAspectRatio())
def _disconnectPlot(self, plot):
plot.sigSetKeepDataAspectRatio.disconnect(self._keepDataAspectRatioChanged)
def keepDataAspectRatio(self):
"""Configure the plot to keep the aspect ratio"""
plot = self.plot()
if plot is not None:
# This will trigger _keepDataAspectRatioChanged
plot.setKeepDataAspectRatio(True)
def dontKeepDataAspectRatio(self):
"""Configure the plot to not keep the aspect ratio"""
plot = self.plot()
if plot is not None:
# This will trigger _keepDataAspectRatioChanged
plot.setKeepDataAspectRatio(False)
def _keepDataAspectRatioChanged(self, aspectRatio):
"""Handle Plot set keep aspect ratio signal"""
icon, toolTip = self.STATE[aspectRatio, "icon"], self.STATE[aspectRatio, "state"]
self.setIcon(icon)
self.setToolTip(toolTip)
class YAxisOriginToolButton(PlotToolButton):
STATE = None
"""Lazy loaded states used to feed YAxisOriginToolButton"""
def __init__(self, parent=None, plot=None):
if self.STATE is None:
self.STATE = {}
# is down
self.STATE[False, "icon"] = icons.getQIcon('plot-ydown')
self.STATE[False, "state"] = "Y-axis is oriented downward"
self.STATE[False, "action"] = "Orient Y-axis downward"
# keep ration
self.STATE[True, "icon"] = icons.getQIcon('plot-yup')
self.STATE[True, "state"] = "Y-axis is oriented upward"
self.STATE[True, "action"] = "Orient Y-axis upward"
super(YAxisOriginToolButton, self).__init__(parent=parent, plot=plot)
upwardAction = self._createAction(True)
upwardAction.triggered.connect(self.setYAxisUpward)
upwardAction.setIconVisibleInMenu(True)
downwardAction = self._createAction(False)
downwardAction.triggered.connect(self.setYAxisDownward)
downwardAction.setIconVisibleInMenu(True)
menu = qt.QMenu(self)
menu.addAction(upwardAction)
menu.addAction(downwardAction)
self.setMenu(menu)
self.setPopupMode(qt.QToolButton.InstantPopup)
def _createAction(self, isUpward):
icon = self.STATE[isUpward, "icon"]
text = self.STATE[isUpward, "action"]
return qt.QAction(icon, text, self)
def _connectPlot(self, plot):
yAxis = plot.getYAxis()
yAxis.sigInvertedChanged.connect(self._yAxisInvertedChanged)
self._yAxisInvertedChanged(yAxis.isInverted())
def _disconnectPlot(self, plot):
plot.getYAxis().sigInvertedChanged.disconnect(self._yAxisInvertedChanged)
def setYAxisUpward(self):
"""Configure the plot to use y-axis upward"""
plot = self.plot()
if plot is not None:
# This will trigger _yAxisInvertedChanged
plot.getYAxis().setInverted(False)
def setYAxisDownward(self):
"""Configure the plot to use y-axis downward"""
plot = self.plot()
if plot is not None:
# This will trigger _yAxisInvertedChanged
plot.getYAxis().setInverted(True)
def _yAxisInvertedChanged(self, inverted):
"""Handle Plot set y axis inverted signal"""
isUpward = not inverted
icon, toolTip = self.STATE[isUpward, "icon"], self.STATE[isUpward, "state"]
self.setIcon(icon)
self.setToolTip(toolTip)
class ProfileToolButton(PlotToolButton):
"""Button used in Profile3DToolbar to switch between 2D profile
and 1D profile."""
STATE = None
"""Lazy loaded states used to feed ProfileToolButton"""
sigDimensionChanged = qt.Signal(int)
def __init__(self, parent=None, plot=None):
if self.STATE is None:
self.STATE = {
(1, "icon"): icons.getQIcon('profile1D'),
(1, "state"): "1D profile is computed on visible image",
(1, "action"): "1D profile on visible image",
(2, "icon"): icons.getQIcon('profile2D'),
(2, "state"): "2D profile is computed, one 1D profile for each image in the stack",
(2, "action"): "2D profile on image stack"}
# Compute 1D profile
# Compute 2D profile
super(ProfileToolButton, self).__init__(parent=parent, plot=plot)
profile1DAction = self._createAction(1)
profile1DAction.triggered.connect(self.computeProfileIn1D)
profile1DAction.setIconVisibleInMenu(True)
profile2DAction = self._createAction(2)
profile2DAction.triggered.connect(self.computeProfileIn2D)
profile2DAction.setIconVisibleInMenu(True)
menu = qt.QMenu(self)
menu.addAction(profile1DAction)
menu.addAction(profile2DAction)
self.setMenu(menu)
self.setPopupMode(qt.QToolButton.InstantPopup)
menu.setTitle('Select profile dimension')
def _createAction(self, profileDimension):
icon = self.STATE[profileDimension, "icon"]
text = self.STATE[profileDimension, "action"]
return qt.QAction(icon, text, self)
def _profileDimensionChanged(self, profileDimension):
"""Update icon in toolbar, emit number of dimensions for profile"""
self.setIcon(self.STATE[profileDimension, "icon"])
self.setToolTip(self.STATE[profileDimension, "state"])
self.sigDimensionChanged.emit(profileDimension)
def computeProfileIn1D(self):
self._profileDimensionChanged(1)
def computeProfileIn2D(self):
self._profileDimensionChanged(2)
|
