GNU Radio C++ API Reference: freq_sink_c.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
freq_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_FREQ_SINK_C_H
12#define INCLUDED_QTGUI_FREQ_SINK_C_H
13
14#include <gnuradio/fft/window.h>
15#include <gnuradio/qtgui/api.h>
16#include <gnuradio/qtgui/trigger_mode.h>
17#include <gnuradio/sync_block.h>
18#include <qapplication.h>
19
20namespace gr {
21namespace qtgui {
22
23/*!
24 * \brief A graphical sink to display multiple signals in frequency.
25 * \ingroup instrumentation_blk
26 * \ingroup qtgui_blk
27 *
28 * \details
29 * This is a QT-based graphical sink the takes set of a complex
30 * streams and plots the PSD. Each signal is plotted with a
31 * different color, and the \a set_title and \a set_color
32 * functions can be used to change the label and color for a given
33 * input number.
34 *
35 * The sink supports plotting streaming complex data or
36 * messages. The message port is named "in". The two modes cannot
37 * be used simultaneously, and \p nconnections should be set to 0
38 * when using the message mode. GRC handles this issue by
39 * providing the "Complex Message" type that removes the streaming
40 * port(s).
41 *
42 * This sink can plot messages that contain either uniform vectors
43 * of complex 32 values (pmt::is_c32vector) or PDUs where the data
44 * is a uniform vector of complex 32 values.
45 *
46 * Message Ports:
47 *
48 * - freq (input):
49 * Receives a PMT pair: (intern("freq"), double(frequency)).
50 * This is used to retune the center frequency of the
51 * display's x-axis.
52 *
53 * - bw (input):
54 * Receives a PMT pair: (intern("bw"), double(bandwidth)).
55 * This is used to programmatically change the bandwidth of
56 * of the display's x-axis.
57 *
58 * - freq (output):
59 * Produces a PMT pair with (intern("freq"), double(frequency)).
60 * When a user double-clicks on the display, the block
61 * produces and emits a message containing the frequency of
62 * where on the x-axis the user clicked. This value can be
63 * used by other blocks to update their frequency setting.
64 *
65 * To perform click-to-tune behavior, this output 'freq'
66 * port can be redirected to this block's input 'freq' port
67 * to catch the message and update the center frequency of
68 * the display.
69 */
70 class QTGUI_API freq_sink_c : virtual public sync_block
71{
72public:
73 // gr::qtgui::freq_sink_c::sptr
74 typedef std::shared_ptr<freq_sink_c> sptr;
75
76 /*!
77 * \brief Build a complex PSD sink.
78 *
79 * \param fftsize size of the FFT to compute and display. If using
80 * the PDU message port to plot samples, the length of
81 * each PDU must be a multiple of the FFT size.
82 * \param wintype type of window to apply (see gr::fft::window::win_type).
83 * By setting bit 16 to one, this block will normalize the window
84 * before applying it. This allows switching between windows without
85 * sacrificing signal power due to tapering, but it will also
86 * amplify some samples. See also set_fft_window_normalized().
87 * \param fc center frequency of signal (use for x-axis labels)
88 * \param bw bandwidth of signal (used to set x-axis labels)
89 * \param name title for the plot
90 * \param nconnections number of signals to be connected to the
91 * sink. The PDU message port is always available for a
92 * connection, and this value must be set to 0 if only
93 * the PDU message port is being used.
94 * \param parent a QWidget parent object, if any
95 */
96 static sptr make(int fftsize,
97 int wintype,
98 double fc,
99 double bw,
100 const std::string& name,
101 int nconnections = 1,
102 QWidget* parent = NULL);
103
104 virtual void exec_() = 0;
105 virtual QWidget* qwidget() = 0;
106
107 virtual void set_fft_size(const int fftsize) = 0;
108 virtual int fft_size() const = 0;
109 virtual void set_fft_average(const float fftavg) = 0;
110 virtual float fft_average() const = 0;
111 virtual void set_fft_window(const gr::fft::window::win_type win) = 0;
112 virtual gr::fft::window::win_type fft_window() = 0;
113 //! If true, normalize window to unit power
114 virtual void set_fft_window_normalized(const bool enable) = 0;
115
116 virtual void set_frequency_range(const double centerfreq, const double bandwidth) = 0;
117 virtual void set_y_axis(double min, double max) = 0;
118
119 virtual void set_update_time(double t) = 0;
120
121 virtual void set_title(const std::string& title) = 0;
122 virtual void set_y_label(const std::string& label, const std::string& unit) = 0;
123 virtual void set_line_label(unsigned int which, const std::string& label) = 0;
124 virtual void set_line_color(unsigned int which, const std::string& color) = 0;
125 virtual void set_line_width(unsigned int which, int width) = 0;
126 virtual void set_line_style(unsigned int which, int style) = 0;
127 virtual void set_line_marker(unsigned int which, int marker) = 0;
128 virtual void set_line_alpha(unsigned int which, double alpha) = 0;
129
130 /*!
131 * Set up a trigger for the sink to know when to start
132 * plotting. Useful to isolate events and avoid noise.
133 *
134 * The trigger modes are Free, Auto, Normal, and Tag (see
135 * gr::qtgui::trigger_mode). The first three are like a normal
136 * trigger function. Free means free running with no trigger,
137 * auto will trigger if the trigger event is seen, but will
138 * still plot otherwise, and normal will hold until the trigger
139 * event is observed. The Tag trigger mode allows us to trigger
140 * off a specific stream tag. The tag trigger is based only on
141 * the name of the tag, so when a tag of the given name is seen,
142 * the trigger is activated.
143 *
144 * In auto and normal mode, we look to see if the magnitude of
145 * the any FFT point is over the set level.
146 *
147 * \param mode The trigger_mode: free, auto, normal, or tag.
148 * \param level The magnitude of the trigger even for auto or normal modes.
149 * \param channel Which input channel to use for the trigger events.
150 * \param tag_key The name (as a string) of the tag to trigger off
151 * of if using the tag mode.
152 */
153 virtual void set_trigger_mode(trigger_mode mode,
154 float level,
155 int channel,
156 const std::string& tag_key = "") = 0;
157
158 virtual std::string title() = 0;
159 virtual std::string line_label(unsigned int which) = 0;
160 virtual std::string line_color(unsigned int which) = 0;
161 virtual int line_width(unsigned int which) = 0;
162 virtual int line_style(unsigned int which) = 0;
163 virtual int line_marker(unsigned int which) = 0;
164 virtual double line_alpha(unsigned int which) = 0;
165
166 virtual void set_size(int width, int height) = 0;
167
168 virtual void enable_menu(bool en = true) = 0;
169 virtual void enable_grid(bool en = true) = 0;
170 virtual void enable_autoscale(bool en = true) = 0;
171 virtual void enable_control_panel(bool en = true) = 0;
172 virtual void enable_max_hold(bool en) = 0;
173 virtual void enable_min_hold(bool en) = 0;
174 virtual void clear_max_hold() = 0;
175 virtual void clear_min_hold() = 0;
176 virtual void disable_legend() = 0;
177 virtual void reset() = 0;
178 virtual void enable_axis_labels(bool en = true) = 0;
179
180 QApplication* d_qApplication;
181};
182
183} /* namespace qtgui */
184} /* namespace gr */
185
186#endif /* INCLUDED_QTGUI_FREQ_SINK_C_H */
gr::basic_block::color
vcolor color() const
Definition basic_block.h:122
gr::basic_block::name
std::string name() const
Definition basic_block.h:168
gr::fft::window::win_type
win_type
Definition window.h:28
gr::qtgui::freq_sink_c
A graphical sink to display multiple signals in frequency.
Definition freq_sink_c.h:71
gr::qtgui::freq_sink_c::sptr
std::shared_ptr< freq_sink_c > sptr
Definition freq_sink_c.h:74
gr::qtgui::freq_sink_c::set_fft_size
virtual void set_fft_size(const int fftsize)=0
gr::qtgui::freq_sink_c::qwidget
virtual QWidget * qwidget()=0
gr::qtgui::freq_sink_c::enable_min_hold
virtual void enable_min_hold(bool en)=0
gr::qtgui::freq_sink_c::enable_menu
virtual void enable_menu(bool en=true)=0
gr::qtgui::freq_sink_c::set_y_label
virtual void set_y_label(const std::string &label, const std::string &unit)=0
gr::qtgui::freq_sink_c::line_color
virtual std::string line_color(unsigned int which)=0
gr::qtgui::freq_sink_c::disable_legend
virtual void disable_legend()=0
gr::qtgui::freq_sink_c::set_trigger_mode
virtual void set_trigger_mode(trigger_mode mode, float level, int channel, const std::string &tag_key="")=0
gr::qtgui::freq_sink_c::set_line_label
virtual void set_line_label(unsigned int which, const std::string &label)=0
gr::qtgui::freq_sink_c::line_marker
virtual int line_marker(unsigned int which)=0
gr::qtgui::freq_sink_c::set_size
virtual void set_size(int width, int height)=0
gr::qtgui::freq_sink_c::set_fft_average
virtual void set_fft_average(const float fftavg)=0
gr::qtgui::freq_sink_c::line_width
virtual int line_width(unsigned int which)=0
gr::qtgui::freq_sink_c::set_title
virtual void set_title(const std::string &title)=0
gr::qtgui::freq_sink_c::reset
virtual void reset()=0
gr::qtgui::freq_sink_c::line_label
virtual std::string line_label(unsigned int which)=0
gr::qtgui::freq_sink_c::enable_max_hold
virtual void enable_max_hold(bool en)=0
gr::qtgui::freq_sink_c::title
virtual std::string title()=0
gr::qtgui::freq_sink_c::enable_grid
virtual void enable_grid(bool en=true)=0
gr::qtgui::freq_sink_c::set_update_time
virtual void set_update_time(double t)=0
gr::qtgui::freq_sink_c::set_fft_window_normalized
virtual void set_fft_window_normalized(const bool enable)=0
If true, normalize window to unit power.
gr::qtgui::freq_sink_c::clear_min_hold
virtual void clear_min_hold()=0
gr::qtgui::freq_sink_c::set_line_color
virtual void set_line_color(unsigned int which, const std::string &color)=0
gr::qtgui::freq_sink_c::set_y_axis
virtual void set_y_axis(double min, double max)=0
gr::qtgui::freq_sink_c::set_line_style
virtual void set_line_style(unsigned int which, int style)=0
gr::qtgui::freq_sink_c::line_style
virtual int line_style(unsigned int which)=0
gr::qtgui::freq_sink_c::set_frequency_range
virtual void set_frequency_range(const double centerfreq, const double bandwidth)=0
gr::qtgui::freq_sink_c::exec_
virtual void exec_()=0
gr::qtgui::freq_sink_c::enable_autoscale
virtual void enable_autoscale(bool en=true)=0
gr::qtgui::freq_sink_c::d_qApplication
QApplication * d_qApplication
Definition freq_sink_c.h:180
gr::qtgui::freq_sink_c::fft_average
virtual float fft_average() const =0
gr::qtgui::freq_sink_c::set_line_width
virtual void set_line_width(unsigned int which, int width)=0
gr::qtgui::freq_sink_c::make
static sptr make(int fftsize, int wintype, double fc, double bw, const std::string &name, int nconnections=1, QWidget *parent=NULL)
Build a complex PSD sink.
gr::qtgui::freq_sink_c::line_alpha
virtual double line_alpha(unsigned int which)=0
gr::qtgui::freq_sink_c::set_line_marker
virtual void set_line_marker(unsigned int which, int marker)=0
gr::qtgui::freq_sink_c::set_fft_window
virtual void set_fft_window(const gr::fft::window::win_type win)=0
gr::qtgui::freq_sink_c::enable_axis_labels
virtual void enable_axis_labels(bool en=true)=0
gr::qtgui::freq_sink_c::enable_control_panel
virtual void enable_control_panel(bool en=true)=0
gr::qtgui::freq_sink_c::clear_max_hold
virtual void clear_max_hold()=0
gr::qtgui::freq_sink_c::fft_size
virtual int fft_size() const =0
gr::qtgui::freq_sink_c::fft_window
virtual gr::fft::window::win_type fft_window()=0
gr::qtgui::freq_sink_c::set_line_alpha
virtual void set_line_alpha(unsigned int which, double alpha)=0
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
QTGUI_API
#define QTGUI_API
Definition gr-qtgui/include/gnuradio/qtgui/api.h:18
gr::qtgui
Definition ber_sink_b.h:20
gr::qtgui::trigger_mode
trigger_mode
Definition trigger_mode.h:17
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h
trigger_mode.h
window.h