/usr/lib/python2.7/dist-packages/guiqwt/plot.py is in python-guiqwt 3.0.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 | # -*- coding: utf-8 -*-
#
# Copyright © 2009-2010 CEA
# Pierre Raybaut
# Licensed under the terms of the CECILL License
# (see guiqwt/__init__.py for details)
"""
guiqwt.plot
-----------
The `plot` module provides the following features:
* :py:class:`guiqwt.plot.PlotManager`: the `plot manager` is an object to
link `plots`, `panels` and `tools` together for designing highly
versatile graphical user interfaces
* :py:class:`guiqwt.plot.CurveWidget`: a ready-to-use widget for curve
displaying with an integrated and preconfigured `plot manager` providing
the `item list panel` and curve-related `tools`
* :py:class:`guiqwt.plot.CurveDialog`: a ready-to-use dialog box for
curve displaying with an integrated and preconfigured `plot manager`
providing the `item list panel` and curve-related `tools`
* :py:class:`guiqwt.plot.ImageWidget`: a ready-to-use widget for curve
and image displaying with an integrated and preconfigured `plot manager`
providing the `item list panel`, the `contrast adjustment` panel, the
`cross section panels` (along X and Y axes) and image-related `tools`
(e.g. colormap selection tool)
* :py:class:`guiqwt.plot.ImageDialog`: a ready-to-use dialog box for
curve and image displaying with an integrated and preconfigured
`plot manager` providing the `item list panel`, the `contrast adjustment`
panel, the `cross section panels` (along X and Y axes) and image-related
`tools` (e.g. colormap selection tool)
.. seealso::
Module :py:mod:`guiqwt.curve`
Module providing curve-related plot items and plotting widgets
Module :py:mod:`guiqwt.image`
Module providing image-related plot items and plotting widgets
Module :py:mod:`guiqwt.tools`
Module providing the `plot tools`
Module :py:mod:`guiqwt.panels`
Module providing the `plot panels` IDs
Module :py:mod:`guiqwt.baseplot`
Module providing the `guiqwt` plotting widget base class
Class diagrams
~~~~~~~~~~~~~~
Curve-related widgets with integrated plot manager:
.. image:: /images/curve_widgets.png
Image-related widgets with integrated plot manager:
.. image:: /images/image_widgets.png
Building your own plot manager:
.. image:: /images/my_plot_manager.png
Examples
~~~~~~~~
Simple example *without* the `plot manager`:
.. literalinclude:: /../guiqwt/tests/filtertest1.py
:start-after: SHOW
:end-before: Workaround for Sphinx v0.6 bug: empty 'end-before' directive
Simple example *with* the `plot manager`:
even if this simple example does not justify the use of the `plot manager`
(this is an unnecessary complication here), it shows how to use it. In more
complex applications, using the `plot manager` allows to design highly versatile
graphical user interfaces.
.. literalinclude:: /../guiqwt/tests/filtertest2.py
:start-after: SHOW
:end-before: Workaround for Sphinx v0.6 bug: empty 'end-before' directive
Reference
~~~~~~~~~
.. autoclass:: PlotManager
:members:
:inherited-members:
.. autoclass:: CurveWidget
:members:
.. autoclass:: CurveDialog
:members:
.. autoclass:: ImageWidget
:members:
.. autoclass:: ImageDialog
:members:
"""
import weakref
from guidata.qt.QtGui import (QDialogButtonBox, QVBoxLayout, QGridLayout,
QToolBar, QDialog, QHBoxLayout, QMenu,
QActionGroup, QSplitter, QSizePolicy,
QApplication, QWidget, QMainWindow)
from guidata.qt.QtCore import Qt
from guidata.qt import PYQT5
from guidata.configtools import get_icon
from guidata.utils import assert_interfaces_valid
from guidata.qthelpers import create_action
from guidata.py3compat import is_text_string
# Local imports
from guiqwt.config import _
from guiqwt.baseplot import BasePlot
from guiqwt.curve import CurvePlot, PlotItemList
from guiqwt.image import ImagePlot
from guiqwt.tools import (SelectTool, RectZoomTool, ColormapTool, HelpTool,
ReverseYAxisTool, BasePlotMenuTool, DeleteItemTool,
ItemListPanelTool, AntiAliasingTool, PrintTool,
DisplayCoordsTool, AxisScaleTool, SaveAsTool,
AspectRatioTool, ContrastPanelTool, XCSPanelTool,
YCSPanelTool, SnapshotTool, DummySeparatorTool,
CrossSectionTool, AverageCrossSectionTool, AboutTool,
ImageStatsTool, ExportItemDataTool, EditItemDataTool,
ItemCenterTool, SignalStatsTool, CopyToClipboardTool)
from guiqwt.interfaces import IPlotManager
class DefaultPlotID(object):
pass
class PlotManager(object):
"""
Construct a PlotManager object, a 'controller' that organizes relations
between plots (i.e. :py:class:`guiqwt.curve.CurvePlot` or
:py:class:`guiqwt.image.ImagePlot` objects), panels,
tools (see :py:mod:`guiqwt.tools`) and toolbars
"""
__implements__ = (IPlotManager,)
def __init__(self, main):
self.main = main # The main parent widget
self.plots = {} # maps ids to instances of BasePlot
self.panels = {} # Qt widgets that need to know about the plots
self.tools = []
self.toolbars = {}
self.active_tool = None
self.default_tool = None
self.default_plot = None
self.default_toolbar = None
self.synchronized_plots = {}
self.groups = {} # Action groups for grouping QActions
# Keep track of the registration sequence (plots, panels, tools):
self._first_tool_flag = True
def add_plot(self, plot, plot_id=DefaultPlotID):
"""
Register a plot to the plot manager:
* plot: :py:class:`guiqwt.curve.CurvePlot` or
:py:class:`guiqwt.image.ImagePlot` object
* plot_id (default id is the plot object's id: ``id(plot)``):
unique ID identifying the plot (any Python object),
this ID will be asked by the manager to access this plot later.
Plot manager's registration sequence is the following:
1. add plots
2. add panels
3. add tools
"""
if plot_id is DefaultPlotID:
plot_id = id(plot)
assert plot_id not in self.plots
assert isinstance(plot, BasePlot)
assert not self.tools, "tools must be added after plots"
assert not self.panels, "panels must be added after plots"
self.plots[plot_id] = plot
if len(self.plots) == 1:
self.default_plot = plot
plot.set_manager(self, plot_id)
# Connecting signals
plot.SIG_ITEMS_CHANGED.connect(self.update_tools_status)
plot.SIG_ACTIVE_ITEM_CHANGED.connect(self.update_tools_status)
plot.SIG_PLOT_AXIS_CHANGED.connect(self.plot_axis_changed)
def set_default_plot(self, plot):
"""
Set default plot
The default plot is the plot on which tools and panels will act.
"""
self.default_plot = plot
def get_default_plot(self):
"""
Return default plot
The default plot is the plot on which tools and panels will act.
"""
return self.default_plot
def add_panel(self, panel):
"""
Register a panel to the plot manager
Plot manager's registration sequence is the following:
1. add plots
2. add panels
3. add tools
"""
assert panel.PANEL_ID not in self.panels
assert not self.tools, "tools must be added after panels"
self.panels[panel.PANEL_ID] = panel
panel.register_panel(self)
def configure_panels(self):
"""
Call all the registred panels 'configure_panel' methods to finalize the
object construction (this allows to use tools registered to the same
plot manager as the panel itself with breaking the registration
sequence: "add plots, then panels, then tools")
"""
for panel_id in self.panels:
panel = self.get_panel(panel_id)
panel.configure_panel()
def add_toolbar(self, toolbar, toolbar_id="default"):
"""
Add toolbar to the plot manager
toolbar: a QToolBar object
toolbar_id: toolbar's id (default id is string "default")
"""
assert toolbar_id not in self.toolbars
self.toolbars[toolbar_id] = toolbar
if self.default_toolbar is None:
self.default_toolbar = toolbar
def set_default_toolbar(self, toolbar):
"""
Set default toolbar
"""
self.default_toolbar = toolbar
def get_default_toolbar(self):
"""
Return default toolbar
"""
return self.default_toolbar
def add_tool(self, ToolKlass, *args, **kwargs):
"""
Register a tool to the manager
* ToolKlass: tool's class (`guiqwt` builtin tools are defined in
module :py:mod:`guiqwt.tools`)
* args: arguments sent to the tool's class
* kwargs: keyword arguments sent to the tool's class
Plot manager's registration sequence is the following:
1. add plots
2. add panels
3. add tools
"""
if self._first_tool_flag:
# This is the very first tool to be added to this manager
self._first_tool_flag = False
self.configure_panels()
tool = ToolKlass(self, *args, **kwargs)
self.tools.append(tool)
for plot in list(self.plots.values()):
tool.register_plot(plot)
if len(self.tools) == 1:
self.default_tool = tool
return tool
def get_tool(self, ToolKlass):
"""Return tool instance from its class"""
for tool in self.tools:
if isinstance(tool, ToolKlass):
return tool
def add_separator_tool(self, toolbar_id=None):
"""
Register a separator tool to the plot manager: the separator tool is
just a tool which insert a separator in the plot context menu
"""
if toolbar_id is None:
for _id, toolbar in list(self.toolbars.items()):
if toolbar is self.get_default_toolbar():
toolbar_id = _id
break
self.add_tool(DummySeparatorTool, toolbar_id)
def set_default_tool(self, tool):
"""
Set default tool
"""
self.default_tool = tool
def get_default_tool(self):
"""
Get default tool
"""
return self.default_tool
def activate_default_tool(self):
"""
Activate default tool
"""
self.get_default_tool().activate()
def get_active_tool(self):
"""
Return active tool
"""
return self.active_tool
def set_active_tool(self, tool=None):
"""
Set active tool (if tool argument is None, the active tool will be
the default tool)
"""
self.active_tool = tool
def get_plot(self, plot_id=DefaultPlotID):
"""
Return plot associated to `plot_id` (if method is called without
specifying the `plot_id` parameter, return the default plot)
"""
if plot_id is DefaultPlotID:
return self.default_plot
return self.plots[plot_id]
def get_plots(self):
"""
Return all registered plots
"""
return list(self.plots.values())
def get_active_plot(self):
"""
Return the active plot
The active plot is the plot whose canvas has the focus
otherwise it's the "default" plot
"""
for plot in list(self.plots.values()):
canvas = plot.canvas()
if canvas.hasFocus():
return plot
return self.default_plot
def get_tool_group(self, groupname):
group = self.groups.get(groupname, None)
if group is None:
group = QActionGroup(self.main)
self.groups[groupname] = weakref.ref(group)
return group
else:
return group()
def get_main(self):
"""
Return the main (parent) widget
Note that for py:class:`guiqwt.plot.CurveWidget` or
:py:class:`guiqwt.plot.ImageWidget` objects, this method will
return the widget itself because the plot manager is integrated to it.
"""
return self.main
def set_main(self, main):
self.main = main
def get_panel(self, panel_id):
"""
Return panel from its ID
Panel IDs are listed in module guiqwt.panels
"""
return self.panels.get(panel_id, None)
def get_itemlist_panel(self):
"""
Convenience function to get the `item list panel`
Return None if the item list panel has not been added to this manager
"""
from guiqwt import panels
return self.get_panel(panels.ID_ITEMLIST)
def get_contrast_panel(self):
"""
Convenience function to get the `contrast adjustment panel`
Return None if the contrast adjustment panel has not been added
to this manager
"""
from guiqwt import panels
return self.get_panel(panels.ID_CONTRAST)
def set_contrast_range(self, zmin, zmax):
"""
Convenience function to set the `contrast adjustment panel` range
This is strictly equivalent to the following::
# Here, *widget* is for example a CurveWidget instance
# (the same apply for CurvePlot, ImageWidget, ImagePlot or any
# class deriving from PlotManager)
widget.get_contrast_panel().set_range(zmin, zmax)
"""
self.get_contrast_panel().set_range(zmin, zmax)
def get_xcs_panel(self):
"""
Convenience function to get the `X-axis cross section panel`
Return None if the X-axis cross section panel has not been added
to this manager
"""
from guiqwt import panels
return self.get_panel(panels.ID_XCS)
def get_ycs_panel(self):
"""
Convenience function to get the `Y-axis cross section panel`
Return None if the Y-axis cross section panel has not been added
to this manager
"""
from guiqwt import panels
return self.get_panel(panels.ID_YCS)
def update_cross_sections(self):
"""
Convenience function to update the `cross section panels` at once
This is strictly equivalent to the following::
# Here, *widget* is for example a CurveWidget instance
# (the same apply for CurvePlot, ImageWidget, ImagePlot or any
# class deriving from PlotManager)
widget.get_xcs_panel().update_plot()
widget.get_ycs_panel().update_plot()
"""
self.get_xcs_panel().update_plot()
self.get_ycs_panel().update_plot()
def get_toolbar(self, toolbar_id="default"):
"""
Return toolbar from its ID
toolbar_id: toolbar's id (default id is string "default")
"""
return self.toolbars.get(toolbar_id, None)
def get_context_menu(self, plot=None):
"""
Return widget context menu -- built using active tools
"""
if plot is None:
plot = self.get_plot()
menu = QMenu(plot)
self.update_tools_status(plot)
for tool in self.tools:
tool.setup_context_menu(menu, plot)
return menu
def update_tools_status(self, plot=None):
"""
Update tools for current plot
"""
if plot is None:
plot = self.get_plot()
for tool in self.tools:
tool.update_status(plot)
def create_action(self, title, triggered=None, toggled=None,
shortcut=None, icon=None, tip=None, checkable=None,
context=Qt.WindowShortcut, enabled=None):
"""
Create a new QAction
"""
return create_action(self.main, title, triggered=triggered,
toggled=toggled, shortcut=shortcut,
icon=icon, tip=tip, checkable=checkable,
context=context, enabled=enabled)
# The following methods provide some sets of tools that
# are often registered together
def register_standard_tools(self):
"""
Registering basic tools for standard plot dialog
--> top of the context-menu
"""
t = self.add_tool(SelectTool)
self.set_default_tool(t)
self.add_tool(RectZoomTool)
self.add_tool(BasePlotMenuTool, "item")
self.add_tool(ExportItemDataTool)
try:
try:
import spyderlib.widgets.objecteditor # analysis:ignore
except ImportError:
import spyder.widgets.variableexplorer.objecteditor # analysis:ignore
self.add_tool(EditItemDataTool)
except ImportError:
pass
self.add_tool(ItemCenterTool)
self.add_tool(DeleteItemTool)
self.add_separator_tool()
self.add_tool(BasePlotMenuTool, "grid")
self.add_tool(BasePlotMenuTool, "axes")
self.add_tool(DisplayCoordsTool)
if self.get_itemlist_panel():
self.add_tool(ItemListPanelTool)
def register_curve_tools(self):
"""
Register only curve-related tools
.. seealso::
:py:meth:`guiqwt.plot.PlotManager.add_tool`
:py:meth:`guiqwt.plot.PlotManager.register_standard_tools`
:py:meth:`guiqwt.plot.PlotManager.register_other_tools`
:py:meth:`guiqwt.plot.PlotManager.register_image_tools`
"""
self.add_tool(SignalStatsTool)
self.add_tool(AntiAliasingTool)
self.add_tool(AxisScaleTool)
def register_image_tools(self):
"""
Register only image-related tools
.. seealso::
:py:meth:`guiqwt.plot.PlotManager.add_tool`
:py:meth:`guiqwt.plot.PlotManager.register_standard_tools`
:py:meth:`guiqwt.plot.PlotManager.register_other_tools`
:py:meth:`guiqwt.plot.PlotManager.register_curve_tools`
"""
self.add_tool(ColormapTool)
self.add_tool(ReverseYAxisTool)
self.add_tool(AspectRatioTool)
if self.get_contrast_panel():
self.add_tool(ContrastPanelTool)
self.add_tool(SnapshotTool)
self.add_tool(ImageStatsTool)
if self.get_xcs_panel() and self.get_ycs_panel():
self.add_tool(XCSPanelTool)
self.add_tool(YCSPanelTool)
self.add_tool(CrossSectionTool)
self.add_tool(AverageCrossSectionTool)
def register_other_tools(self):
"""
Register other common tools
.. seealso::
:py:meth:`guiqwt.plot.PlotManager.add_tool`
:py:meth:`guiqwt.plot.PlotManager.register_standard_tools`
:py:meth:`guiqwt.plot.PlotManager.register_curve_tools`
:py:meth:`guiqwt.plot.PlotManager.register_image_tools`
"""
self.add_tool(SaveAsTool)
self.add_tool(CopyToClipboardTool)
self.add_tool(PrintTool)
self.add_tool(HelpTool)
self.add_tool(AboutTool)
def register_all_curve_tools(self):
"""
Register standard, curve-related and other tools
.. seealso::
:py:meth:`guiqwt.plot.PlotManager.add_tool`
:py:meth:`guiqwt.plot.PlotManager.register_standard_tools`
:py:meth:`guiqwt.plot.PlotManager.register_other_tools`
:py:meth:`guiqwt.plot.PlotManager.register_curve_tools`
:py:meth:`guiqwt.plot.PlotManager.register_image_tools`
:py:meth:`guiqwt.plot.PlotManager.register_all_image_tools`
"""
self.register_standard_tools()
self.add_separator_tool()
self.register_curve_tools()
self.add_separator_tool()
self.register_other_tools()
self.add_separator_tool()
self.update_tools_status()
self.get_default_tool().activate()
def register_all_image_tools(self):
"""
Register standard, image-related and other tools
.. seealso::
:py:meth:`guiqwt.plot.PlotManager.add_tool`
:py:meth:`guiqwt.plot.PlotManager.register_standard_tools`
:py:meth:`guiqwt.plot.PlotManager.register_other_tools`
:py:meth:`guiqwt.plot.PlotManager.register_curve_tools`
:py:meth:`guiqwt.plot.PlotManager.register_image_tools`
:py:meth:`guiqwt.plot.PlotManager.register_all_curve_tools`
"""
self.register_standard_tools()
self.add_separator_tool()
self.register_image_tools()
self.add_separator_tool()
self.register_other_tools()
self.add_separator_tool()
self.update_tools_status()
self.get_default_tool().activate()
def synchronize_axis(self, axis, plots):
for plot_id in plots:
synclist = self.synchronized_plots.setdefault(plot_id, [])
for plot2_id in plots:
if plot_id==plot2_id:
continue
item = (axis, plot2_id)
if item not in synclist:
synclist.append(item)
def plot_axis_changed(self, plot):
plot_id = plot.plot_id
if plot_id not in self.synchronized_plots:
return
for (axis, other_plot_id) in self.synchronized_plots[plot_id]:
scalediv = plot.axisScaleDiv(axis)
map = plot.canvasMap(axis)
other = self.get_plot(other_plot_id)
lb = scalediv.lowerBound()
ub = scalediv.upperBound()
other.setAxisScale(axis, lb, ub)
other.replot()
assert_interfaces_valid(PlotManager)
#===============================================================================
# Curve Plot Widget/Dialog with integrated Item list widget
#===============================================================================
def configure_plot_splitter(qsplit, decreasing_size=True):
qsplit.setChildrenCollapsible(False)
qsplit.setHandleWidth(4)
if decreasing_size:
qsplit.setStretchFactor(0, 1)
qsplit.setStretchFactor(1, 0)
qsplit.setSizes([2, 1])
else:
qsplit.setStretchFactor(0, 0)
qsplit.setStretchFactor(1, 1)
qsplit.setSizes([1, 2])
class SubplotWidget(QSplitter):
"""Construct a Widget that helps managing several plots
together handled by the same manager
Since the plots must be added to the manager before the panels
the add_itemlist method can be called after having declared
all the subplots
"""
def __init__(self, manager, parent=None, **kwargs):
super(SubplotWidget, self).__init__(parent, **kwargs)
self.setOrientation(Qt.Horizontal)
self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
self.manager = manager
self.plots = []
self.itemlist = None
main = QWidget()
self.plotlayout = QGridLayout()
main.setLayout(self.plotlayout)
self.addWidget(main)
def add_itemlist(self, show_itemlist=False):
self.itemlist = PlotItemList(self)
self.itemlist.setVisible(show_itemlist)
self.addWidget(self.itemlist)
configure_plot_splitter(self)
self.manager.add_panel(self.itemlist)
def add_subplot(self, plot, i=0, j=0, plot_id=None):
"""Add a plot to the grid of plots"""
self.plotlayout.addWidget(plot, i, j)
self.plots.append(plot)
if plot_id is None:
plot_id = id(plot)
self.manager.add_plot(plot, plot_id)
class BaseCurveWidget(QSplitter):
"""
Construct a BaseCurveWidget object, which includes:
* A plot (:py:class:`guiqwt.curve.CurvePlot`)
* An `item list` panel (:py:class:`guiqwt.curve.PlotItemList`)
This object does nothing in itself because plot and panels are not
connected to each other.
See children class :py:class:`guiqwt.plot.CurveWidget`
"""
def __init__(self, parent=None, title=None,
xlabel=None, ylabel=None, xunit=None, yunit=None,
section="plot", show_itemlist=False, gridparam=None,
curve_antialiasing=None, **kwargs):
if PYQT5:
super(BaseCurveWidget, self).__init__(parent, **kwargs)
self.setOrientation(Qt.Horizontal)
else:
QSplitter.__init__(self, Qt.Horizontal, parent)
self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
self.plot = CurvePlot(parent=self, title=title, xlabel=xlabel,
ylabel=ylabel, xunit=xunit, yunit=yunit,
section=section, gridparam=gridparam)
if curve_antialiasing is not None:
self.plot.set_antialiasing(curve_antialiasing)
self.addWidget(self.plot)
self.itemlist = PlotItemList(self)
self.itemlist.setVisible(show_itemlist)
self.addWidget(self.itemlist)
configure_plot_splitter(self)
class CurveWidget(BaseCurveWidget, PlotManager):
"""
Construct a CurveWidget object: plotting widget with integrated
plot manager
* parent: parent widget
* title: plot title
* xlabel: (bottom axis title, top axis title) or bottom axis title only
* ylabel: (left axis title, right axis title) or left axis title only
* xunit: (bottom axis unit, top axis unit) or bottom axis unit only
* yunit: (left axis unit, right axis unit) or left axis unit only
* panels (optional): additionnal panels (list, tuple)
"""
def __init__(self, parent=None, title=None,
xlabel=None, ylabel=None, xunit=None, yunit=None,
section="plot", show_itemlist=False, gridparam=None,
panels=None):
if PYQT5:
super(CurveWidget, self).__init__(parent=parent, title=title,
xlabel=xlabel, ylabel=ylabel, xunit=xunit, yunit=yunit,
section=section, show_itemlist=show_itemlist,
gridparam=gridparam, main=self)
else:
BaseCurveWidget.__init__(self, parent, title,
xlabel, ylabel, xunit, yunit,
section, show_itemlist, gridparam)
PlotManager.__init__(self, main=self)
# Configuring plot manager
self.add_plot(self.plot)
self.add_panel(self.itemlist)
if panels is not None:
for panel in panels:
self.add_panel(panel)
class CurveWidgetMixin(PlotManager):
def __init__(self, wintitle="guiqwt plot", icon="guiqwt.svg",
toolbar=False, options=None, panels=None):
PlotManager.__init__(self, main=self)
self.plot_layout = QGridLayout()
if options is None:
options = {}
self.plot_widget = None
self.create_plot(options)
if panels is not None:
for panel in panels:
self.add_panel(panel)
self.toolbar = QToolBar(_("Tools"))
if not toolbar:
self.toolbar.hide()
# Configuring widget layout
self.setup_widget_properties(wintitle=wintitle, icon=icon)
self.setup_widget_layout()
# Configuring plot manager
self.add_toolbar(self.toolbar, "default")
self.register_tools()
def setup_widget_layout(self):
raise NotImplementedError
def setup_widget_properties(self, wintitle, icon):
self.setWindowTitle(wintitle)
if is_text_string(icon):
icon = get_icon(icon)
if icon is not None:
self.setWindowIcon(icon)
self.setMinimumSize(320, 240)
self.resize(640, 480)
def register_tools(self):
"""
Register the plotting dialog box tools: the base implementation
provides standard, curve-related and other tools - i.e. calling
this method is exactly the same as calling
:py:meth:`guiqwt.plot.CurveDialog.register_all_curve_tools`
This method may be overriden to provide a fully customized set of tools
"""
self.register_all_curve_tools()
def create_plot(self, options, row=0, column=0, rowspan=1, columnspan=1):
"""
Create the plotting widget (which is an instance of class
:py:class:`guiqwt.plot.BaseCurveWidget`), add it to the dialog box
main layout (:py:attr:`guiqwt.plot.CurveDialog.plot_layout`) and
then add the `item list` panel
May be overriden to customize the plot layout
(:py:attr:`guiqwt.plot.CurveDialog.plot_layout`)
"""
self.plot_widget = BaseCurveWidget(self, **options)
self.plot_layout.addWidget(self.plot_widget,
row, column, rowspan, columnspan)
# Configuring plot manager
self.add_plot(self.plot_widget.plot)
self.add_panel(self.plot_widget.itemlist)
class CurveDialog(QDialog, CurveWidgetMixin):
"""
Construct a CurveDialog object: plotting dialog box with integrated
plot manager
* wintitle: window title
* icon: window icon
* edit: editable state
* toolbar: show/hide toolbar
* options: options sent to the :py:class:`guiqwt.curve.CurvePlot` object
(dictionary)
* parent: parent widget
* panels (optional): additionnal panels (list, tuple)
"""
def __init__(self, wintitle="guiqwt plot", icon="guiqwt.svg", edit=False,
toolbar=False, options=None, parent=None, panels=None):
if not PYQT5:
QDialog.__init__(self, parent)
self.edit = edit
self.button_box = None
self.button_layout = None
if PYQT5:
super(CurveDialog, self).__init__(parent, wintitle=wintitle,
icon=icon, toolbar=toolbar, options=options, panels=panels)
else:
CurveWidgetMixin.__init__(self, wintitle=wintitle, icon=icon,
toolbar=toolbar, options=options,
panels=panels)
self.setWindowFlags(Qt.Window)
def setup_widget_layout(self):
vlayout = QVBoxLayout(self)
vlayout.addWidget(self.toolbar)
vlayout.addLayout(self.plot_layout)
self.setLayout(vlayout)
if self.edit:
self.button_layout = QHBoxLayout()
self.install_button_layout()
vlayout.addLayout(self.button_layout)
def install_button_layout(self):
"""
Install standard buttons (OK, Cancel) in dialog button box layout
(:py:attr:`guiqwt.plot.CurveDialog.button_layout`)
This method may be overriden to customize the button box
"""
bbox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
bbox.accepted.connect(self.accept)
bbox.rejected.connect(self.reject)
self.button_layout.addWidget(bbox)
self.button_box = bbox
class CurveWindow(QMainWindow, CurveWidgetMixin):
"""
Construct a CurveWindow object: plotting window with integrated plot
manager
* wintitle: window title
* icon: window icon
* toolbar: show/hide toolbar
* options: options sent to the :py:class:`guiqwt.curve.CurvePlot` object
(dictionary)
* parent: parent widget
* panels (optional): additionnal panels (list, tuple)
"""
def __init__(self, wintitle="guiqwt plot", icon="guiqwt.svg",
toolbar=False, options=None, parent=None, panels=None):
if PYQT5:
super(CurveWindow, self).__init__(parent, wintitle=wintitle,
icon=icon, toolbar=toolbar, options=options, panels=panels)
else:
QMainWindow.__init__(self, parent)
CurveWidgetMixin.__init__(self, wintitle=wintitle, icon=icon,
toolbar=toolbar, options=options,
panels=panels)
def setup_widget_layout(self):
self.addToolBar(self.toolbar)
widget = QWidget()
widget.setLayout(self.plot_layout)
self.setCentralWidget(widget)
def closeEvent(self, event):
# Closing panels (necessary if at least one of these panels has no
# parent widget: otherwise, this panel will stay open after the main
# window has been closed which is not the expected behavior)
for panel in self.panels:
self.get_panel(panel).close()
QMainWindow.closeEvent(self, event)
#===============================================================================
# Image Plot Widget/Dialog with integrated Levels Histogram and other widgets
#===============================================================================
class BaseImageWidget(QSplitter):
"""
Construct a BaseImageWidget object, which includes:
* A plot (:py:class:`guiqwt.curve.CurvePlot`)
* An `item list` panel (:py:class:`guiqwt.curve.PlotItemList`)
* A `contrast adjustment` panel
(:py:class:`guiqwt.histogram.ContrastAdjustment`)
* An `X-axis cross section` panel
(:py:class:`guiqwt.histogram.XCrossSection`)
* An `Y-axis cross section` panel
(:py:class:`guiqwt.histogram.YCrossSection`)
This object does nothing in itself because plot and panels are not
connected to each other.
See children class :py:class:`guiqwt.plot.ImageWidget`
"""
def __init__(self, parent=None, title="",
xlabel=("", ""), ylabel=("", ""), zlabel=None,
xunit=("", ""), yunit=("", ""), zunit=None, yreverse=True,
colormap="jet", aspect_ratio=1.0, lock_aspect_ratio=True,
show_contrast=False, show_itemlist=False, show_xsection=False,
show_ysection=False, xsection_pos="top", ysection_pos="right",
gridparam=None, curve_antialiasing=None, **kwargs):
if PYQT5:
super(BaseImageWidget, self).__init__(parent, **kwargs)
self.setOrientation(Qt.Vertical)
else:
QSplitter.__init__(self, Qt.Vertical, parent)
self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
self.sub_splitter = QSplitter(Qt.Horizontal, self)
self.plot = ImagePlot(parent=self, title=title,
xlabel=xlabel, ylabel=ylabel, zlabel=zlabel,
xunit=xunit, yunit=yunit, zunit=zunit,
yreverse=yreverse, aspect_ratio=aspect_ratio,
lock_aspect_ratio=lock_aspect_ratio,
gridparam=gridparam)
if curve_antialiasing is not None:
self.plot.set_antialiasing(curve_antialiasing)
from guiqwt.cross_section import YCrossSection
self.ycsw = YCrossSection(self, position=ysection_pos,
xsection_pos=xsection_pos)
self.ycsw.setVisible(show_ysection)
from guiqwt.cross_section import XCrossSection
self.xcsw = XCrossSection(self)
self.xcsw.setVisible(show_xsection)
self.xcsw.SIG_VISIBILITY_CHANGED.connect(self.xcsw_is_visible)
self.xcsw_splitter = QSplitter(Qt.Vertical, self)
if xsection_pos == "top":
self.xcsw_splitter.addWidget(self.xcsw)
self.xcsw_splitter.addWidget(self.plot)
else:
self.xcsw_splitter.addWidget(self.plot)
self.xcsw_splitter.addWidget(self.xcsw)
self.xcsw_splitter.splitterMoved.connect(
lambda pos, index: self.adjust_ycsw_height())
self.ycsw_splitter = QSplitter(Qt.Horizontal, self)
if ysection_pos == "left":
self.ycsw_splitter.addWidget(self.ycsw)
self.ycsw_splitter.addWidget(self.xcsw_splitter)
else:
self.ycsw_splitter.addWidget(self.xcsw_splitter)
self.ycsw_splitter.addWidget(self.ycsw)
configure_plot_splitter(self.xcsw_splitter,
decreasing_size=xsection_pos == "bottom")
configure_plot_splitter(self.ycsw_splitter,
decreasing_size=ysection_pos == "right")
self.sub_splitter.addWidget(self.ycsw_splitter)
self.itemlist = PlotItemList(self)
self.itemlist.setVisible(show_itemlist)
self.sub_splitter.addWidget(self.itemlist)
# Contrast adjustment (Levels histogram)
from guiqwt.histogram import ContrastAdjustment
self.contrast = ContrastAdjustment(self)
self.contrast.setVisible(show_contrast)
self.addWidget(self.contrast)
configure_plot_splitter(self)
configure_plot_splitter(self.sub_splitter)
def adjust_ycsw_height(self, height=None):
if height is None:
height = self.xcsw.height()-self.ycsw.toolbar.height()
self.ycsw.adjust_height(height)
if height:
QApplication.processEvents()
def xcsw_is_visible(self, state):
if state:
QApplication.processEvents()
self.adjust_ycsw_height()
else:
self.adjust_ycsw_height(0)
class ImageWidget(BaseImageWidget, PlotManager):
"""
Construct a ImageWidget object: plotting widget with integrated
plot manager
* parent: parent widget
* title: plot title (string)
* xlabel, ylabel, zlabel: resp. bottom, left and right axis titles
(strings)
* xunit, yunit, zunit: resp. bottom, left and right axis units (strings)
* yreverse: reversing Y-axis (bool)
* aspect_ratio: height to width ratio (float)
* lock_aspect_ratio: locking aspect ratio (bool)
* show_contrast: showing contrast adjustment tool (bool)
* show_xsection: showing x-axis cross section plot (bool)
* show_ysection: showing y-axis cross section plot (bool)
* xsection_pos: x-axis cross section plot position
(string: "top", "bottom")
* ysection_pos: y-axis cross section plot position
(string: "left", "right")
* panels (optional): additionnal panels (list, tuple)
"""
def __init__(self, parent=None, title="",
xlabel=("", ""), ylabel=("", ""), zlabel=None,
xunit=("", ""), yunit=("", ""), zunit=None, yreverse=True,
colormap="jet", aspect_ratio=1.0, lock_aspect_ratio=True,
show_contrast=False, show_itemlist=False, show_xsection=False,
show_ysection=False, xsection_pos="top", ysection_pos="right",
gridparam=None, panels=None):
if PYQT5:
super(ImageWidget, self).__init__(parent=parent, title=title,
xlabel=xlabel, ylabel=ylabel, zlabel=zlabel,
xunit=xunit, yunit=yunit, zunit=zunit, yreverse=yreverse,
colormap=colormap, aspect_ratio=aspect_ratio,
lock_aspect_ratio=lock_aspect_ratio,
show_contrast=show_contrast, show_itemlist=show_itemlist,
show_xsection=show_xsection, show_ysection=show_ysection,
xsection_pos=xsection_pos, ysection_pos=ysection_pos,
gridparam=gridparam, main=self)
else:
BaseImageWidget.__init__(self, parent, title, xlabel, ylabel, zlabel,
xunit, yunit, zunit, yreverse, colormap, aspect_ratio,
lock_aspect_ratio, show_contrast, show_itemlist,
show_xsection, show_ysection, xsection_pos, ysection_pos,
gridparam)
PlotManager.__init__(self, main=self)
# Configuring plot manager
self.add_plot(self.plot)
self.add_panel(self.itemlist)
self.add_panel(self.xcsw)
self.add_panel(self.ycsw)
self.add_panel(self.contrast)
if panels is not None:
for panel in panels:
self.add_panel(panel)
class ImageWidgetMixin(CurveWidgetMixin):
def register_tools(self):
"""
Register the plotting dialog box tools: the base implementation
provides standard, image-related and other tools - i.e. calling
this method is exactly the same as calling
:py:meth:`guiqwt.plot.CurveDialog.register_all_image_tools`
This method may be overriden to provide a fully customized set of tools
"""
self.register_all_image_tools()
def create_plot(self, options, row=0, column=0, rowspan=1, columnspan=1):
"""
Create the plotting widget (which is an instance of class
:py:class:`guiqwt.plot.BaseImageWidget`), add it to the dialog box
main layout (:py:attr:`guiqwt.plot.CurveDialog.plot_layout`) and
then add the `item list`, `contrast adjustment` and X/Y axes
cross section panels.
May be overriden to customize the plot layout
(:py:attr:`guiqwt.plot.CurveDialog.plot_layout`)
"""
self.plot_widget = BaseImageWidget(self, **options)
self.plot_layout.addWidget(self.plot_widget,
row, column, rowspan, columnspan)
# Configuring plot manager
self.add_plot(self.plot_widget.plot)
self.add_panel(self.plot_widget.itemlist)
self.add_panel(self.plot_widget.xcsw)
self.add_panel(self.plot_widget.ycsw)
self.add_panel(self.plot_widget.contrast)
class ImageDialog(CurveDialog, ImageWidgetMixin):
"""
Construct a ImageDialog object: plotting dialog box with integrated
plot manager
* wintitle: window title
* icon: window icon
* edit: editable state
* toolbar: show/hide toolbar
* options: options sent to the :py:class:`guiqwt.image.ImagePlot` object
(dictionary)
* parent: parent widget
* panels (optional): additionnal panels (list, tuple)
"""
pass
class ImageWindow(CurveWindow, ImageWidgetMixin):
"""
Construct a ImageWindow object: plotting window with integrated plot manager
* wintitle: window title
* icon: window icon
* toolbar: show/hide toolbar
* options: options sent to the :py:class:`guiqwt.image.ImagePlot` object
(dictionary)
* parent: parent widget
* panels (optional): additionnal panels (list, tuple)
"""
pass
|