GNU Radio Manual and C++ API Reference  3.9.1.0
The Free & Open Software Radio Ecosystem
waterfall_sink_f.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_F_H
12 #define INCLUDED_QTGUI_WATERFALL_SINK_F_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 floating
34  * point 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 float 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 "Float Message" type that removes the streaming
49  * port(s).
50  *
51  * This sink can plot messages that contain either uniform vectors
52  * of float 32 values (pmt::is_f32vector) or PDUs where the data
53  * is a uniform vector of float 32 values.
54  *
55  *
56  * Message Ports:
57  *
58  * - freq (input):
59  * Receives a PMT pair: (intern("freq"), double(frequency)).
60  * This is used to retune the center frequency of the
61  * display's x-axis.
62  *
63  * - bw (input):
64  * Receives a PMT pair: (intern("bw"), double(bandwidth)).
65  * This is used to programmatically change the bandwidth of
66  * of the display's x-axis.
67  *
68  * - freq (output):
69  * Produces a PMT pair with (intern("freq"), double(frequency)).
70  * When a user double-clicks on the display, the block
71  * produces and emits a message containing the frequency of
72  * where on the x-axis the user clicked. This value can be
73  * used by other blocks to update their frequency setting.
74  *
75  * To perform click-to-tune behavior, this output 'freq'
76  * port can be redirected to this block's input 'freq' port
77  * to catch the message and update the center frequency of
78  * the display.
79  */
80 class QTGUI_API waterfall_sink_f : virtual public sync_block
81 {
82 public:
83  // gr::qtgui::waterfall_sink_f::sptr
84  typedef std::shared_ptr<waterfall_sink_f> sptr;
85 
86  /*!
87  * \brief Build a floating point waterfall sink.
88  *
89  * \param size size of the FFT to compute and display. If using
90  * the PDU message port to plot samples, the length of
91  * each PDU must be a multiple of the FFT size.
92  * \param wintype type of window to apply (see gr::fft::window::win_type)
93  * \param fc center frequency of signal (use for x-axis labels)
94  * \param bw bandwidth of signal (used to set x-axis labels)
95  * \param name title for the plot
96  * \param nconnections number of signals to be connected to the
97  * sink. The PDU message port is always available for a
98  * connection, and this value must be set to 0 if only
99  * the PDU message port is being used.
100  * \param parent a QWidget parent object, if any
101  */
102  static sptr make(int size,
103  int wintype,
104  double fc,
105  double bw,
106  const std::string& name,
107  int nconnections = 1,
108  QWidget* parent = NULL);
109 
110  virtual void exec_() = 0;
111  virtual QWidget* qwidget() = 0;
112 
113 #ifdef ENABLE_PYTHON
114  virtual PyObject* pyqwidget() = 0;
115 #else
116  virtual void* pyqwidget() = 0;
117 #endif
118 
119  virtual void clear_data() = 0;
120 
121  virtual void set_fft_size(const int fftsize) = 0;
122  virtual int fft_size() const = 0;
123  virtual void set_time_per_fft(const double t) = 0;
124  virtual void set_fft_average(const float fftavg) = 0;
125  virtual float fft_average() const = 0;
126  virtual void set_fft_window(const gr::fft::window::win_type win) = 0;
127  virtual gr::fft::window::win_type fft_window() = 0;
128 
129  virtual void set_frequency_range(const double centerfreq, const double bandwidth) = 0;
130  virtual void set_intensity_range(const double min, const double max) = 0;
131 
132  virtual void set_update_time(double t) = 0;
133  virtual void set_title(const std::string& title) = 0;
134  virtual void set_time_title(const std::string& title) = 0;
135  virtual void set_line_label(unsigned int which, const std::string& line) = 0;
136  virtual void set_line_alpha(unsigned int which, double alpha) = 0;
137  virtual void set_color_map(unsigned int which, const int color) = 0;
138 
139  /*!
140  * Pass "true" to this function to only show the positive half
141  * of the spectrum. By default, this plotter shows the full
142  * spectrum (positive and negative halves).
143  */
144  virtual void set_plot_pos_half(bool half) = 0;
145 
146  virtual std::string title() = 0;
147  virtual std::string line_label(unsigned int which) = 0;
148  virtual double line_alpha(unsigned int which) = 0;
149  virtual int color_map(unsigned int which) = 0;
150 
151  virtual void set_size(int width, int height) = 0;
152 
153  virtual void auto_scale() = 0;
154  virtual double min_intensity(unsigned int which) = 0;
155  virtual double max_intensity(unsigned int which) = 0;
156 
157  virtual void enable_menu(bool en = true) = 0;
158  virtual void enable_grid(bool en = true) = 0;
159  virtual void disable_legend() = 0;
160  virtual void enable_axis_labels(bool en = true) = 0;
161 
162  QApplication* d_qApplication;
163 };
164 
165 } /* namespace qtgui */
166 } /* namespace gr */
167 
168 #endif /* INCLUDED_QTGUI_WATERFALL_SINK_F_H */
gr::fft::window::win_type
win_type
Definition: window.h:25
gr::qtgui::waterfall_sink_f::d_qApplication
QApplication * d_qApplication
Definition: waterfall_sink_f.h:162
QTGUI_API
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:18
gr::trellis::min
float min(float a, float b)
api.h
gr::sync_block
synchronous 1:1 input to output with history
Definition: sync_block.h:25
sync_block.h
window.h
gr
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition: basic_block.h:29
gr::qtgui::waterfall_sink_f::sptr
std::shared_ptr< waterfall_sink_f > sptr
Definition: waterfall_sink_f.h:84
gr::qtgui::waterfall_sink_f
A graphical sink to display multiple signals on a waterfall (spectrogram) plot.
Definition: waterfall_sink_f.h:80