Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added group item #3898

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
108 changes: 108 additions & 0 deletions examples/plotGroups.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
#!/usr/bin/env python
# /*##########################################################################
#
# Copyright (c) 2016-2019 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.
#
# ###########################################################################*/
"""
Example to show the use of :class:`~silx.gui.items.group.Group`.
"""

__license__ = "MIT"

import logging
import numpy
from silx.gui.plot import PlotWindow
from silx.gui import qt
from silx.gui.plot.items.group import Group
from silx.gui.plot.items.curve import Curve


logging.basicConfig()
logger = logging.getLogger(__name__)


class MyGroup(Group):

def __init__(self):
super(MyGroup, self).__init__()
self._cursor = 0
self._tick = 0

def update(self):
x = numpy.linspace(self._cursor, self._cursor + 100, 50)
y = numpy.random.poisson((numpy.sin(x / 100) + 1) * 100)
self._cursor += 100
self._tick += 1

curve = Curve()
curve.setColor("C0")
curve.setSymbol("")
curve.setLineStyle("-")
curve.setData(x, y, copy=False)
curve.setVisible(self._tick % 7 != 0)
self.addItem(curve)

if len(self.getItems()) > 10:
old = self.getItems()[0]
self.removeItem(old)


def main(argv=None):
global app # QApplication must be global to avoid seg fault on quit
app = qt.QApplication([])
sys.excepthook = qt.exceptionHandler

win = qt.QWidget()
win.setAttribute(qt.Qt.WA_DeleteOnClose)
layout = qt.QVBoxLayout(win)

plot = PlotWindow()
layout.addWidget(plot)

item = MyGroup()
plot.addItem(item)

def update():
item.update()
plot.resetZoom()

t = qt.QTimer()
t.timeout.connect(update)
t.start(1000)

show = qt.QPushButton()
show.setText("Show")
layout.addWidget(show)
show.clicked.connect(lambda: item.setVisible(True))

hide = qt.QPushButton()
hide.setText("Hide")
layout.addWidget(hide)
hide.clicked.connect(lambda: item.setVisible(False))

win.show()
return app.exec()


if __name__ == "__main__":
import sys
sys.exit(main(argv=sys.argv[1:]))
157 changes: 157 additions & 0 deletions src/silx/gui/plot/items/group.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
# /*##########################################################################
#
# Copyright (c) 2018-2023 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 base components to create group item for
the :class:`~silx.gui.plot.PlotWidget`.
"""

__authors__ = ["V. Valls"]
__license__ = "MIT"
__date__ = "30/06/2023"


import logging
import weakref
from typing import List

from ... import qt
from .. import items


logger = logging.getLogger(__name__)


class Group(items.Item):
"""Object describing a group of items.

A group is only a item which hold a set of items.

Each child are also part of the plot as flat items.
"""

sigChildAdded = qt.Signal(object)
"""Signal emitted when a child is added to this group"""

sigChildRemoved = qt.Signal(object)
"""Signal emitted when a child is added to this group"""

def __init__(self):
items.Item.__init__(self)
self._child = []
self._childVisibility = weakref.WeakKeyDictionary()

def _setItemName(self, item):
"""Helper to generate a unique id to a plot item"""
legend = "__CHILD-%d__%d" % (id(self), id(item))
item.setName(legend)

def _setPlot(self, plot):
"""Override `_setPlot` in order to update this children's group."""
previousPlot = self.getPlot()
if plot is previousPlot:
return
if plot is None:
for c in self._child:
previousPlot.removeItem(c)
else:
for c in self._child:
plot.addItem(c)
items.Item._setPlot(self, plot)

def addItem(self, item: items.Item):
"""Add an item to this group.

This item will be added and removed to the plot used by the group.

If the group is already part of a plot, the item will also be added to
the plot.

It the item do not have a name already, a unique one is generated to
avoid item collision in the plot.

:param item: A plot item
"""
assert item is not None
self._child.append(item)
self.sigChildAdded.emit(item)
if item.getName() == '':
self._setItemName(item)
itemVisible = item.isVisible()
if not itemVisible:
self._childVisibility[item] = False
plot = self.getPlot()
if plot is not None:
if not self.isVisible():
item.setVisible(False)
item._parentGroup = True # FIXME: This can be a normal reference from the API
plot.addItem(item)

def removeItem(self, item: items.Item):
"""Remove an item from this group.

If the item is part of a plot it will be removed too.

:param item: A plot item
"""
assert item is not None
self._child.remove(item)
self.sigChildRemoved.emit(item)
plot = item.getPlot()
if plot is not None:
del item._parentGroup
plot.removeItem(item)

def getItems(self) -> List[items.Item]:
"""Returns the list of PlotWidget items from this group.
"""
return tuple(self._child)

def setItemVisible(self, child: items.Item, visible: bool):
"""Set the visibility of this child when this group is set visible.

:param visible: True to display it, False otherwise
"""
self._childVisibility[child] = visible
if self.isVisible():
child.setVisible(visible)

def isItemVisible(self, child: items.Item):
"""Define if this child is visible from the group."""
return self._childVisibility.get(child, True)

def setVisible(self, visible: bool):
"""Set visibility of item.

This also affect the child visibility from the description set by
:meth:`setItemVisible`.

:param visible: True to display it, False otherwise
"""
if self.isVisible() == visible:
return
for c in self._child:
if visible:
c.setVisible(self.isItemVisible(c))
else:
c.setVisible(False)
items.Item.setVisible(self, visible)