functions.rst 2.31 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
Pyqtgraph's Helper Functions
============================

Simple Data Display Functions
-----------------------------

.. autofunction:: pyqtgraph.plot

.. autofunction:: pyqtgraph.image

11
.. autofunction:: pyqtgraph.dbg
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

Color, Pen, and Brush Functions
-------------------------------

Qt uses the classes QColor, QPen, and QBrush to determine how to draw lines and fill shapes. These classes are highly capable but somewhat awkward to use. Pyqtgraph offers the functions :func:`~pyqtgraph.mkColor`, :func:`~pyqtgraph.mkPen`, and :func:`~pyqtgraph.mkBrush` to simplify the process of creating these classes. In most cases, however, it will be unnecessary to call these functions directly--any function or method that accepts *pen* or *brush* arguments will make use of these functions for you. For example, the following three lines all have the same effect::
    
    pg.plot(xdata, ydata, pen='r')
    pg.plot(xdata, ydata, pen=pg.mkPen('r'))
    pg.plot(xdata, ydata, pen=QPen(QColor(255, 0, 0)))


.. autofunction:: pyqtgraph.mkColor

.. autofunction:: pyqtgraph.mkPen

.. autofunction:: pyqtgraph.mkBrush

.. autofunction:: pyqtgraph.hsvColor

.. autofunction:: pyqtgraph.intColor

.. autofunction:: pyqtgraph.colorTuple

.. autofunction:: pyqtgraph.colorStr

37 38
.. autofunction:: pyqtgraph.glColor

39 40 41 42 43 44 45

Data Slicing
------------

.. autofunction:: pyqtgraph.affineSlice


46 47 48 49 50 51 52 53 54 55 56 57
Coordinate Transformation
-------------------------

.. autofunction:: pyqtgraph.transformToArray

.. autofunction:: pyqtgraph.transformCoordinates

.. autofunction:: pyqtgraph.solve3DTransform

.. autofunction:: pyqtgraph.solveBilinearTransform


58 59 60 61 62 63 64 65 66 67

SI Unit Conversion Functions
----------------------------

.. autofunction:: pyqtgraph.siFormat

.. autofunction:: pyqtgraph.siScale

.. autofunction:: pyqtgraph.siEval

Luke Campagnola's avatar
Luke Campagnola committed
68 69 70 71 72 73 74 75

Image Preparation Functions
---------------------------

.. autofunction:: pyqtgraph.makeARGB

.. autofunction:: pyqtgraph.makeQImage

76 77 78 79 80 81
.. autofunction:: pyqtgraph.applyLookupTable

.. autofunction:: pyqtgraph.rescaleData

.. autofunction:: pyqtgraph.imageToArray

Luke Campagnola's avatar
Luke Campagnola committed
82 83 84 85 86 87 88 89 90

Mesh Generation Functions
-------------------------

.. autofunction:: pyqtgraph.isocurve

.. autofunction:: pyqtgraph.isosurface


91 92 93
Miscellaneous Functions
-----------------------

94 95
.. autofunction:: pyqtgraph.arrayToQPath

96 97 98 99 100 101
.. autofunction:: pyqtgraph.pseudoScatter

.. autofunction:: pyqtgraph.systemInfo



Luke Campagnola's avatar
Luke Campagnola committed
102