diff options
Diffstat (limited to 'gr-qtgui/doc/qtgui.dox')
| -rw-r--r-- | gr-qtgui/doc/qtgui.dox | 47 |
1 files changed, 44 insertions, 3 deletions
diff --git a/gr-qtgui/doc/qtgui.dox b/gr-qtgui/doc/qtgui.dox index 8664af163d..c3ba512107 100644 --- a/gr-qtgui/doc/qtgui.dox +++ b/gr-qtgui/doc/qtgui.dox @@ -22,6 +22,40 @@ by using: help(qtgui) \endcode +\subsection Blocks + +There are a number of available QTGUI blocks for different plotting +purposes. These include: + +\li Time Domain: x-axis is time, y-axis is amplitude. +\li Frequency Domain or PSD: x-axis is frequency, y-axis is magnitude +in dB. +\li Waterfall or spectrogram: x-axis is frequency, y-axis is time, +z-axis is intensity related to magnitude in dB. +\li Constellation: polar plot of real vs. imaginary. +\li Time Raster: time vs. time with the z-axis being intensity based +on value of the sample. +\li Combined Sink: combines time, frequency, waterfall, and +constellation plots into one widget. + +The time domain, frequency domain, and waterfall have both a complex +and a floating point block. The constellation plot only makes sense +with complex inputs. The time raster plots accept bits and floats. + +Because the time raster plots are designed to show structure over time +in a signal, frame, packet, etc., they never drop samples. This is a +fairly taxing job and performance can be an issue. Since it is +expected that this block will work on a frame or packet structure, we +tend to be at the lowest possible rate at this point, so that will +help. Expect performance issues at high data rates. + +Note: There seem to be extra performance issue with the raster +plotters in QWT version 5 that were fixed with QWT version 6. As such, +the time raster plots have incredibly poor performance with QWT5 to +the point of almost being unusable. In the future, we may restrict +compilation and installation of these plots only if QWT6 or higher is +discovered. For now, just be aware of this limitation. + \section Dependencies @@ -51,7 +85,7 @@ while the GUI is alive. \code from PyQt4 import Qt -from gnuradio.qtgui import qtgui +from gnuradio import qtgui import sys, sip class grclass(gr.top_block): @@ -70,8 +104,15 @@ def main(): tb.start() qapp.exec_() tb.stop() - - \endcode +There are graphical controls in all but the combined plotting +tools. In the margins of the GUIs (that is, not on the canvas showing +the signal itself), right-clicking the mouse will pull up a drop-down +menu that will allow you to change difference parameters of the +plots. These include things like the look of the lines (width, color, +style, markers, etc.), the ability to start and stop the display, the +ability to save to a file, and other plot-specific controls (FFT size +for the frequency and waterfall plots, etc.). + */ |