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