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