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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2016-2018 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 contains a DataViewer with a view selector.
"""
__authors__ = ["V. Valls"]
__license__ = "MIT"
__date__ = "12/02/2019"
from silx.gui import qt
from .DataViewer import DataViewer
from .DataViewerSelector import DataViewerSelector
class DataViewerFrame(qt.QWidget):
"""
A :class:`DataViewer` with a view selector.
.. image:: img/DataViewerFrame.png
This widget provides the same API as :class:`DataViewer`. Therefore, for more
documentation, take a look at the documentation of the class
:class:`DataViewer`.
.. code-block:: python
import numpy
data = numpy.random.rand(500,500)
viewer = DataViewerFrame()
viewer.setData(data)
viewer.setVisible(True)
"""
displayedViewChanged = qt.Signal(object)
"""Emitted when the displayed view changes"""
dataChanged = qt.Signal()
"""Emitted when the data changes"""
def __init__(self, parent=None):
"""
Constructor
:param qt.QWidget parent:
"""
super(DataViewerFrame, self).__init__(parent)
class _DataViewer(DataViewer):
"""Overwrite methods to avoid to create views while the instance
is not created. `initializeViews` have to be called manually."""
def _initializeViews(self):
pass
def initializeViews(self):
"""Avoid to create views while the instance is not created."""
super(_DataViewer, self)._initializeViews()
def _createDefaultViews(self, parent):
"""Expose the original `createDefaultViews` function"""
return super(_DataViewer, self).createDefaultViews()
def createDefaultViews(self, parent=None):
"""Allow the DataViewerFrame to override this function"""
return self.parent().createDefaultViews(parent)
self.__dataViewer = _DataViewer(self)
# initialize views when `self.__dataViewer` is set
self.__dataViewer.initializeViews()
self.__dataViewer.setFrameShape(qt.QFrame.StyledPanel)
self.__dataViewer.setFrameShadow(qt.QFrame.Sunken)
self.__dataViewerSelector = DataViewerSelector(self, self.__dataViewer)
self.__dataViewerSelector.setFlat(True)
layout = qt.QVBoxLayout(self)
layout.setContentsMargins(0, 0, 0, 0)
layout.setSpacing(0)
layout.addWidget(self.__dataViewer, 1)
layout.addWidget(self.__dataViewerSelector)
self.setLayout(layout)
self.__dataViewer.dataChanged.connect(self.__dataChanged)
self.__dataViewer.displayedViewChanged.connect(self.__displayedViewChanged)
def __dataChanged(self):
"""Called when the data is changed"""
self.dataChanged.emit()
def __displayedViewChanged(self, view):
"""Called when the displayed view changes"""
self.displayedViewChanged.emit(view)
def setGlobalHooks(self, hooks):
"""Set a data view hooks for all the views
:param DataViewHooks context: The hooks to use
"""
self.__dataViewer.setGlobalHooks(hooks)
def getReachableViews(self):
return self.__dataViewer.getReachableViews()
def availableViews(self):
"""Returns the list of registered views
:rtype: List[DataView]
"""
return self.__dataViewer.availableViews()
def currentAvailableViews(self):
"""Returns the list of available views for the current data
:rtype: List[DataView]
"""
return self.__dataViewer.currentAvailableViews()
def createDefaultViews(self, parent=None):
"""Create and returns available views which can be displayed by default
by the data viewer. It is called internally by the widget. It can be
overwriten to provide a different set of viewers.
:param QWidget parent: QWidget parent of the views
:rtype: List[silx.gui.data.DataViews.DataView]
"""
return self.__dataViewer._createDefaultViews(parent)
def addView(self, view):
"""Allow to add a view to the dataview.
If the current data support this view, it will be displayed.
:param DataView view: A dataview
"""
return self.__dataViewer.addView(view)
def removeView(self, view):
"""Allow to remove a view which was available from the dataview.
If the view was displayed, the widget will be updated.
:param DataView view: A dataview
"""
return self.__dataViewer.removeView(view)
def setData(self, data):
"""Set the data to view.
It mostly can be a h5py.Dataset or a numpy.ndarray. Other kind of
objects will be displayed as text rendering.
:param numpy.ndarray data: The data.
"""
self.__dataViewer.setData(data)
def data(self):
"""Returns the data"""
return self.__dataViewer.data()
def setDisplayedView(self, view):
self.__dataViewer.setDisplayedView(view)
def displayedView(self):
return self.__dataViewer.displayedView()
def displayMode(self):
return self.__dataViewer.displayMode()
def setDisplayMode(self, modeId):
"""Set the displayed view using display mode.
Change the displayed view according to the requested mode.
:param int modeId: Display mode, one of
- `EMPTY_MODE`: display nothing
- `PLOT1D_MODE`: display the data as a curve
- `PLOT2D_MODE`: display the data as an image
- `TEXT_MODE`: display the data as a text
- `ARRAY_MODE`: display the data as a table
"""
return self.__dataViewer.setDisplayMode(modeId)
def getViewFromModeId(self, modeId):
"""See :meth:`DataViewer.getViewFromModeId`"""
return self.__dataViewer.getViewFromModeId(modeId)
def replaceView(self, modeId, newView):
"""Replace one of the builtin data views with a custom view.
See :meth:`DataViewer.replaceView` for more documentation.
:param DataViews.DataView newView: New data view
:return: True if replacement was successful, else False
"""
return self.__dataViewer.replaceView(modeId, newView)
|
