File: overview.rst

package info (click to toggle)
plotpy 2.8.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 13,364 kB
  • sloc: python: 37,833; cpp: 2,005; sh: 32; makefile: 3
file content (94 lines) | stat: -rw-r--r-- 2,381 bytes parent folder | download
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
Overview
--------

The :ref:`items` module provides the classes for the plot items.
Plot items are the graphical objects that are displayed on a 2D plotting widget
like :py:class:`.BasePlot`.
Items may be created either by using the appropriate class constructor or by
using the :obj:`.builder.make` factory object.

.. seealso::

    :ref:`builder`
        Module providing the :obj:`.builder.make` factory object
        which can be used to create plot items

    :ref:`plot`
        Module providing ready-to-use curve and image plotting widgets and
        dialog boxes

Curves
^^^^^^

The following curve items are available:

* :py:class:`.CurveItem`: a curve plot item
* :py:class:`.ErrorBarCurveItem`: a curve plot item with error bars

Images
^^^^^^

The following image items are available:

* :py:class:`.ImageItem`: simple images
* :py:class:`.TrImageItem`: images supporting arbitrary
  affine transform
* :py:class:`.XYImageItem`: images with non-linear X/Y axes
* :py:class:`.Histogram2DItem`: 2D histogram
* :py:class:`.ImageFilterItem`: rectangular filtering
  area that may be resized and moved onto the processed image
* :py:func:`.assemble_imageitems`
* :py:func:`.get_plot_qrect`
* :py:func:`.get_image_from_plot`

Grid
^^^^

A single grid item is available: :py:class:`.GridItem`.

Shapes
^^^^^^

The following shape items are available:

* :py:class:`.PolygonShape`
* :py:class:`.RectangleShape`
* :py:class:`.ObliqueRectangleShape`
* :py:class:`.PointShape`
* :py:class:`.SegmentShape`
* :py:class:`.EllipseShape`
* :py:class:`.Axes`
* :py:class:`.XRangeSelection`
* :py:class:`.YRangeSelection`
* :py:class:`.Marker`
* :py:class:`.RectangleSVGShape`
* :py:class:`.SquareSVGShape`
* :py:class:`.CircleSVGShape`

Annotations
^^^^^^^^^^^

The following annotation items are available:

* :py:class:`.AnnotatedPoint`
* :py:class:`.AnnotatedSegment`
* :py:class:`.AnnotatedXRange`
* :py:class:`.AnnotatedYRange`
* :py:class:`.AnnotatedRectangle`
* :py:class:`.AnnotatedObliqueRectangle`
* :py:class:`.AnnotatedEllipse`
* :py:class:`.AnnotatedCircle`
* :py:class:`.AnnotatedPolygon`

Labels
^^^^^^

The following label items are available:

* :py:class:`.LabelItem`
* :py:class:`.LegendBoxItem`
* :py:class:`.SelectedLegendBoxItem`
* :py:class:`.XRangeComputation`
* :py:class:`.YRangeComputation`
* :py:class:`.RangeComputation2d`
* :py:class:`.DataInfoLabel`