GNU Radio Manual and C++ API Reference  3.9.0.0
The Free & Open Software Radio Ecosystem
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  * SPDX-License-Identifier: GPL-3.0-or-later
8  *
9  */
10 
11 #ifndef INCLUDED_QTGUI_WATERFALL_SINK_C_H
12 #define INCLUDED_QTGUI_WATERFALL_SINK_C_H
13 
14 #ifdef ENABLE_PYTHON
15 #include <Python.h>
16 #endif
17 
18 #include <gnuradio/fft/window.h>
19 #include <gnuradio/qtgui/api.h>
20 #include <gnuradio/sync_block.h>
21 #include <qapplication.h>
22 
23 namespace gr {
24 namespace qtgui {
25 
26 /*!
27  * \brief A graphical sink to display multiple signals on a
28  * waterfall (spectrogram) plot.
29  * \ingroup instrumentation_blk
30  * \ingroup qtgui_blk
31  *
32  * \details
33  * This is a QT-based graphical sink the takes set of a complex
34  * streams and plots a waterfall (spectrogram) plot.
35  *
36  * Note that unlike the other qtgui sinks, this one does not
37  * support multiple input streams. We have yet to figure out a
38  * good way to display multiple, independent signals on this kind
39  * of a plot. If there are any suggestions or examples of this, we
40  * would love to see them. Otherwise, to display multiple signals
41  * here, it's probably best to sum the signals together and
42  * connect that here.
43  *
44  * The sink supports plotting streaming complex data or
45  * messages. The message port is named "in". The two modes cannot
46  * be used simultaneously, and \p nconnections should be set to 0
47  * when using the message mode. GRC handles this issue by
48  * providing the "Complex Message" type that removes the streaming
49  * port(s).
50  *
51  * This sink can plot messages that contain either uniform vectors
52  * of complex 32 values (pmt::is_c32vector) or PDUs where the data
53  * is a uniform vector of complex 32 values.
54  *
55  * Message Ports:
56  *
57  * - freq (input):
58  * Receives a PMT pair: (intern("freq"), double(frequency)).
59  * This is used to retune the center frequency of the
60  * display's x-axis.
61  *
62  * - bw (input):
63  * Receives a PMT pair: (intern("bw"), double(bandwidth)).
64  * This is used to programmatically change the bandwidth of
65  * of the display's x-axis.
66  *
67  * - freq (output):
68  * Produces a PMT pair with (intern("freq"), double(frequency)).
69  * When a user double-clicks on the display, the block
70  * produces and emits a message containing the frequency of
71  * where on the x-axis the user clicked. This value can be
72  * used by other blocks to update their frequency setting.
73  *
74  * To perform click-to-tune behavior, this output 'freq'
75  * port can be redirected to this block's input 'freq' port
76  * to catch the message and update the center frequency of
77  * the display.
78  */
79 class QTGUI_API waterfall_sink_c : virtual public sync_block
80 {
81 public:
82  // gr::qtgui::waterfall_sink_c::sptr
83  typedef std::shared_ptr<waterfall_sink_c> sptr;
84 
85  /*!
86  * \brief Build a complex waterfall sink.
87  *
88  * \param fftsize size of the FFT to compute and display. If using
89  * the PDU message port to plot samples, the length of
90  * each PDU must be a multiple of the FFT size.
91  * \param wintype type of window to apply (see gr::fft::window::win_type)
92  * \param fc center frequency of signal (use for x-axis labels)
93  * \param bw bandwidth of signal (used to set x-axis labels)
94  * \param name title for the plot
95  * \param nconnections number of signals to be connected to the
96  * sink. The PDU message port is always available for a
97  * connection, and this value must be set to 0 if only
98  * the PDU message port is being used.
99  * \param parent a QWidget parent object, if any
100  */
101  static sptr make(int fftsize,
102  int wintype,
103  double fc,
104  double bw,
105  const std::string& name,
106  int nconnections = 1,
107  QWidget* parent = NULL);
108 
109  virtual void exec_() = 0;
110  virtual QWidget* qwidget() = 0;
111 
112 #ifdef ENABLE_PYTHON
113  virtual PyObject* pyqwidget() = 0;
114 #else
115  virtual void* pyqwidget() = 0;
116 #endif
117 
118  virtual void clear_data() = 0;
119 
120  virtual void set_fft_size(const int fftsize) = 0;
121  virtual int fft_size() const = 0;
122  virtual void set_time_per_fft(const double t) = 0;
123  virtual void set_fft_average(const float fftavg) = 0;
124  virtual float fft_average() const = 0;
125  virtual void set_fft_window(const gr::fft::window::win_type win) = 0;
127 
128  virtual void set_frequency_range(const double centerfreq, const double bandwidth) = 0;
129  virtual void set_intensity_range(const double min, const double max) = 0;
130 
131  virtual void set_update_time(double t) = 0;
132  virtual void set_title(const std::string& title) = 0;
133  virtual void set_time_title(const std::string& title) = 0;
134  virtual void set_line_label(unsigned int which, const std::string& line) = 0;
135  virtual void set_line_alpha(unsigned int which, double alpha) = 0;
136  virtual void set_color_map(unsigned int which, const int color) = 0;
137 
138  virtual std::string title() = 0;
139  virtual std::string line_label(unsigned int which) = 0;
140  virtual double line_alpha(unsigned int which) = 0;
141  virtual int color_map(unsigned int which) = 0;
142 
143  virtual void set_size(int width, int height) = 0;
144 
145  virtual void auto_scale() = 0;
146  virtual double min_intensity(unsigned int which) = 0;
147  virtual double max_intensity(unsigned int which) = 0;
148 
149  virtual void enable_menu(bool en = true) = 0;
150  virtual void enable_grid(bool en = true) = 0;
151  virtual void disable_legend() = 0;
152  virtual void enable_axis_labels(bool en = true) = 0;
153 
154  QApplication* d_qApplication;
155 };
156 
157 } /* namespace qtgui */
158 } /* namespace gr */
159 
160 #endif /* INCLUDED_QTGUI_WATERFALL_SINK_C_H */
win_type
Definition: window.h:25
A graphical sink to display multiple signals on a waterfall (spectrogram) plot.
Definition: waterfall_sink_c.h:80
virtual void set_fft_window(const gr::fft::window::win_type win)=0
virtual void auto_scale()=0
virtual double line_alpha(unsigned int which)=0
virtual std::string line_label(unsigned int which)=0
virtual void enable_axis_labels(bool en=true)=0
virtual void set_time_title(const std::string &title)=0
virtual void set_fft_size(const int fftsize)=0
virtual void enable_grid(bool en=true)=0
virtual double min_intensity(unsigned int which)=0
QApplication * d_qApplication
Definition: waterfall_sink_c.h:154
virtual gr::fft::window::win_type fft_window()=0
virtual void set_fft_average(const float fftavg)=0
virtual void set_line_alpha(unsigned int which, double alpha)=0
virtual void set_update_time(double t)=0
virtual QWidget * qwidget()=0
std::shared_ptr< waterfall_sink_c > sptr
Definition: waterfall_sink_c.h:83
virtual int fft_size() const =0
static sptr make(int fftsize, int wintype, double fc, double bw, const std::string &name, int nconnections=1, QWidget *parent=NULL)
Build a complex waterfall sink.
virtual std::string title()=0
virtual void set_size(int width, int height)=0
virtual void set_title(const std::string &title)=0
virtual void * pyqwidget()=0
virtual void set_line_label(unsigned int which, const std::string &line)=0
virtual void set_intensity_range(const double min, const double max)=0
virtual double max_intensity(unsigned int which)=0
virtual void enable_menu(bool en=true)=0
virtual int color_map(unsigned int which)=0
virtual void set_color_map(unsigned int which, const int color)=0
virtual float fft_average() const =0
virtual void clear_data()=0
virtual void disable_legend()=0
virtual void set_time_per_fft(const double t)=0
virtual void set_frequency_range(const double centerfreq, const double bandwidth)=0
synchronous 1:1 input to output with history
Definition: sync_block.h:26
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:18
float min(float a, float b)
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition: basic_block.h:29