163 lines
8.4 KiB
HTML
163 lines
8.4 KiB
HTML
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>Introduction — pyqtgraph v1.8 documentation</title>
|
|
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '',
|
|
VERSION: '1.8',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<link rel="top" title="pyqtgraph v1.8 documentation" href="index.html" />
|
|
<link rel="next" title="How to use pyqtgraph" href="how_to_use.html" />
|
|
<link rel="prev" title="Welcome to the documentation for pyqtgraph 1.8" href="index.html" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="how_to_use.html" title="How to use pyqtgraph"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="index.html" title="Welcome to the documentation for pyqtgraph 1.8"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="index.html">pyqtgraph v1.8 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="introduction">
|
|
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="what-is-pyqtgraph">
|
|
<h2>What is pyqtgraph?<a class="headerlink" href="#what-is-pyqtgraph" title="Permalink to this headline">¶</a></h2>
|
|
<p>Pyqtgraph is a graphics and user interface library for Python that provides functionality commonly required in engineering and science applications. Its primary goals are 1) to provide fast, interactive graphics for displaying data (plots, video, etc.) and 2) to provide tools to aid in rapid application development (for example, property trees such as used in Qt Designer).</p>
|
|
<p>Pyqtgraph makes heavy use of the Qt GUI platform (via PyQt or PySide) for its high-performance graphics and numpy for heavy number crunching. In particular, pyqtgraph uses Qt’s GraphicsView framework which is a highly capable graphics system on its own; we bring optimized and simplified primitives to this framework to allow data visualization with minimal effort.</p>
|
|
<p>It is known to run on Linux, Windows, and OSX</p>
|
|
</div>
|
|
<div class="section" id="what-can-it-do">
|
|
<h2>What can it do?<a class="headerlink" href="#what-can-it-do" title="Permalink to this headline">¶</a></h2>
|
|
<p>Amongst the core features of pyqtgraph are:</p>
|
|
<ul class="simple">
|
|
<li>Basic data visualization primitives: Images, line and scatter plots</li>
|
|
<li>Fast enough for realtime update of video/plot data</li>
|
|
<li>Interactive scaling/panning, averaging, FFTs, SVG/PNG export</li>
|
|
<li>Widgets for marking/selecting plot regions</li>
|
|
<li>Widgets for marking/selecting image region-of-interest and automatically slicing multi-dimensional image data</li>
|
|
<li>Framework for building customized image region-of-interest widgets</li>
|
|
<li>Docking system that replaces/complements Qt’s dock system to allow more complex (and more predictable) docking arrangements</li>
|
|
<li>ParameterTree widget for rapid prototyping of dynamic interfaces (Similar to the property trees in Qt Designer and many other applications)</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="examples">
|
|
<span id="id1"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
|
<p>Pyqtgraph includes an extensive set of examples that can be accessed by running:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">pyqtgraph.examples</span>
|
|
<span class="n">pyqtgraph</span><span class="o">.</span><span class="n">examples</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>This will start a launcher with a list of available examples. Select an item from the list to view its source code and double-click an item to run the example.</p>
|
|
</div>
|
|
<div class="section" id="how-does-it-compare-to">
|
|
<h2>How does it compare to...<a class="headerlink" href="#how-does-it-compare-to" title="Permalink to this headline">¶</a></h2>
|
|
<ul class="simple">
|
|
<li>matplotlib: For plotting and making publication-quality graphics, matplotlib is far more mature than pyqtgraph. However, matplotlib is also much slower and not suitable for applications requiring realtime update of plots/video or rapid interactivity. It also does not provide any of the GUI tools and image interaction/slicing functionality in pyqtgraph.</li>
|
|
<li>pyqwt5: pyqwt is generally more mature than pyqtgraph for plotting and is about as fast. The major differences are 1) pyqtgraph is written in pure python, so it is somewhat more portable than pyqwt, which often lags behind pyqt in development (and can be a pain to install on some platforms) and 2) like matplotlib, pyqwt does not provide any of the GUI tools and image interaction/slicing functionality in pyqtgraph.</li>
|
|
</ul>
|
|
<p>(My experience with these libraries is somewhat outdated; please correct me if I am wrong here)</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">Introduction</a><ul>
|
|
<li><a class="reference internal" href="#what-is-pyqtgraph">What is pyqtgraph?</a></li>
|
|
<li><a class="reference internal" href="#what-can-it-do">What can it do?</a></li>
|
|
<li><a class="reference internal" href="#examples">Examples</a></li>
|
|
<li><a class="reference internal" href="#how-does-it-compare-to">How does it compare to...</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="index.html"
|
|
title="previous chapter">Welcome to the documentation for pyqtgraph 1.8</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="how_to_use.html"
|
|
title="next chapter">How to use pyqtgraph</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/introduction.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" size="18" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="how_to_use.html" title="How to use pyqtgraph"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="index.html" title="Welcome to the documentation for pyqtgraph 1.8"
|
|
>previous</a> |</li>
|
|
<li><a href="index.html">pyqtgraph v1.8 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2011, Luke Campagnola.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
|
|
</div>
|
|
</body>
|
|
</html> |