GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
waterfall_sink_c.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012,2014-2015 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_QTGUI_WATERFALL_SINK_C_H
24 #define INCLUDED_QTGUI_WATERFALL_SINK_C_H
25 
26 #ifdef ENABLE_PYTHON
27 #include <Python.h>
28 #endif
29 
30 #include <gnuradio/qtgui/api.h>
31 #include <gnuradio/sync_block.h>
32 #include <qapplication.h>
33 #include <gnuradio/filter/firdes.h>
34 
35 namespace gr {
36  namespace qtgui {
37 
38  /*!
39  * \brief A graphical sink to display multiple signals on a
40  * waterfall (spectrogram) plot.
41  * \ingroup instrumentation_blk
42  * \ingroup qtgui_blk
43  *
44  * \details
45  * This is a QT-based graphical sink the takes set of a complex
46  * streams and plots a waterfall (spectrogram) plot.
47  *
48  * Note that unlike the other qtgui sinks, this one does not
49  * support multiple input streams. We have yet to figure out a
50  * good way to display multiple, independent signals on this kind
51  * of a plot. If there are any suggestions or examples of this, we
52  * would love to see them. Otherwise, to display multiple signals
53  * here, it's probably best to sum the signals together and
54  * connect that here.
55  *
56  * The sink supports plotting streaming complex data or
57  * messages. The message port is named "in". The two modes cannot
58  * be used simultaneously, and \p nconnections should be set to 0
59  * when using the message mode. GRC handles this issue by
60  * providing the "Complex Message" type that removes the streaming
61  * port(s).
62  *
63  * This sink can plot messages that contain either uniform vectors
64  * of complex 32 values (pmt::is_c32vector) or PDUs where the data
65  * is a uniform vector of complex 32 values.
66  *
67  * Message Ports:
68  *
69  * - freq (input):
70  * Receives a PMT pair: (intern("freq"), double(frequency)).
71  * This is used to retune the center frequency of the
72  * display's x-axis.
73  *
74  * - freq (output):
75  * Produces a PMT pair with (intern("freq"), double(frequency)).
76  * When a user double-clicks on the display, the block
77  * produces and emits a message containing the frequency of
78  * where on the x-axis the user clicked. This value can be
79  * used by other blocks to update their frequency setting.
80  *
81  * To perform click-to-tune behavior, this output 'freq'
82  * port can be redirected to this block's input 'freq' port
83  * to catch the message and update the center frequency of
84  * the display.
85  */
86  class QTGUI_API waterfall_sink_c : virtual public sync_block
87  {
88  public:
89  // gr::qtgui::waterfall_sink_c::sptr
90  typedef boost::shared_ptr<waterfall_sink_c> sptr;
91 
92  /*!
93  * \brief Build a complex waterfall sink.
94  *
95  * \param size size of the FFT to compute and display. If using
96  * the PDU message port to plot samples, the length of
97  * each PDU must be a multiple of the FFT size.
98  * \param wintype type of window to apply (see gnuradio/filter/firdes.h)
99  * \param fc center frequency of signal (use for x-axis labels)
100  * \param bw bandwidth of signal (used to set x-axis labels)
101  * \param name title for the plot
102  * \param nconnections number of signals to be connected to the
103  * sink. The PDU message port is always available for a
104  * connection, and this value must be set to 0 if only
105  * the PDU message port is being used.
106  * \param parent a QWidget parent object, if any
107  */
108  static sptr make(int size, int wintype,
109  double fc, double bw,
110  const std::string &name,
111  int nconnections=1,
112  QWidget *parent=NULL);
113 
114  virtual void exec_() = 0;
115  virtual QWidget* qwidget() = 0;
116 
117 #ifdef ENABLE_PYTHON
118  virtual PyObject* pyqwidget() = 0;
119 #else
120  virtual void* pyqwidget() = 0;
121 #endif
122 
123  virtual void clear_data() = 0;
124 
125  virtual void set_fft_size(const int fftsize) = 0;
126  virtual int fft_size() const = 0;
127  virtual void set_time_per_fft(const double t) = 0;
128  virtual void set_fft_average(const float fftavg) = 0;
129  virtual float fft_average() const = 0;
130  virtual void set_fft_window(const gr::filter::firdes::win_type win) = 0;
131  virtual gr::filter::firdes::win_type fft_window() = 0;
132 
133  virtual void set_frequency_range(const double centerfreq,
134  const double bandwidth) = 0;
135  virtual void set_intensity_range(const double min,
136  const double max) = 0;
137 
138  virtual void set_update_time(double t) = 0;
139  virtual void set_title(const std::string &title) = 0;
140  virtual void set_time_title(const std::string &title) = 0;
141  virtual void set_line_label(int which, const std::string &line) = 0;
142  virtual void set_line_alpha(int which, double alpha) = 0;
143  virtual void set_color_map(int which, const int color) = 0;
144 
145  virtual std::string title() = 0;
146  virtual std::string line_label(int which) = 0;
147  virtual double line_alpha(int which) = 0;
148  virtual int color_map(int which) = 0;
149 
150  virtual void set_size(int width, int height) = 0;
151 
152  virtual void auto_scale() = 0;
153  virtual double min_intensity(int which) = 0;
154  virtual double max_intensity(int which) = 0;
155 
156  virtual void enable_menu(bool en=true) = 0;
157  virtual void enable_grid(bool en=true) = 0;
158  virtual void disable_legend() = 0;
159 
160  QApplication *d_qApplication;
161  };
162 
163  } /* namespace qtgui */
164 } /* namespace gr */
165 
166 #endif /* INCLUDED_QTGUI_WATERFALL_SINK_C_H */
QApplication * d_qApplication
Definition: waterfall_sink_c.h:160
float min(float a, float b)
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:30
A graphical sink to display multiple signals on a waterfall (spectrogram) plot.
Definition: waterfall_sink_c.h:86
Include this header to use the message passing features.
Definition: logger.h:131
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
win_type
Definition: firdes.h:45
boost::shared_ptr< waterfall_sink_c > sptr
Definition: waterfall_sink_c.h:90