GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
freq_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 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_QTGUI_FREQ_SINK_F_H
24#define INCLUDED_QTGUI_FREQ_SINK_F_H
25
26#ifdef ENABLE_PYTHON
27#include <Python.h>
28#endif
29
31#include <gnuradio/qtgui/api.h>
33#include <gnuradio/sync_block.h>
34#include <qapplication.h>
35
36namespace gr {
37namespace qtgui {
38
39/*!
40 * \brief A graphical sink to display multiple signals in frequency.
41 * \ingroup instrumentation_blk
42 * \ingroup qtgui_blk
43 *
44 * \details
45 * This is a QT-based graphical sink the takes set of a floating
46 * point streams and plots the PSD. Each signal is plotted with a
47 * different color, and the \a set_title and \a set_color
48 * functions can be used to change the lable and color for a given
49 * input number.
50 *
51 * The sink supports plotting streaming float data or
52 * messages. The message port is named "in". The two modes cannot
53 * be used simultaneously, and \p nconnections should be set to 0
54 * when using the message mode. GRC handles this issue by
55 * providing the "Float Message" type that removes the streaming
56 * port(s).
57 *
58 * This sink can plot messages that contain either uniform vectors
59 * of float 32 values (pmt::is_f32vector) or PDUs where the data
60 * is a uniform vector of float 32 values.
61 *
62 * Message Ports:
63 *
64 * - freq (input):
65 * Receives a PMT pair: (intern("freq"), double(frequency).
66 * This is used to retune the center frequency of the
67 * display's x-axis.
68 *
69 * - freq (output):
70 * Produces a PMT pair with (intern("freq"), double(frequency).
71 * When a user double-clicks on the display, the block
72 * produces and emits a message containing the frequency of
73 * where on the x-axis the user clicked. This value can be
74 * used by other blocks to update their frequency setting.
75 *
76 * To perform click-to-tune behavior, this output 'freq'
77 * port can be redirected to this block's input 'freq' port
78 * to catch the message and update the center frequency of
79 * the display.
80 */
81class QTGUI_API freq_sink_f : virtual public sync_block
82{
83public:
84 // gr::qtgui::freq_sink_f::sptr
85 typedef boost::shared_ptr<freq_sink_f> sptr;
86
87 /*!
88 * \brief Build a floating point PSD sink.
89 *
90 * \param fftsize size of the FFT to compute and display. If using
91 * the PDU message port to plot samples, the length of
92 * each PDU must be a multiple of the FFT size.
93 * \param wintype type of window to apply (see gr::fft::window::win_type)
94 * \param fc center frequency of signal (use for x-axis labels)
95 * \param bw bandwidth of signal (used to set x-axis labels)
96 * \param name title for the plot
97 * \param nconnections number of signals to be connected to the
98 * sink. The PDU message port is always available for a
99 * connection, and this value must be set to 0 if only
100 * the PDU message port is being used.
101 * \param parent a QWidget parent object, if any
102 */
103 static sptr make(int fftsize,
104 int wintype,
105 double fc,
106 double bw,
107 const std::string& name,
108 int nconnections = 1,
109 QWidget* parent = NULL);
110
111 virtual void exec_() = 0;
112 virtual QWidget* qwidget() = 0;
113
114#ifdef ENABLE_PYTHON
115 virtual PyObject* pyqwidget() = 0;
116#else
117 virtual void* pyqwidget() = 0;
118#endif
119
120 virtual void set_fft_size(const int fftsize) = 0;
121 virtual int fft_size() const = 0;
122 virtual void set_fft_average(const float fftavg) = 0;
123 virtual float fft_average() const = 0;
124 virtual void set_fft_window(const gr::filter::firdes::win_type win) = 0;
126
127 virtual void set_frequency_range(const double centerfreq, const double bandwidth) = 0;
128 virtual void set_y_axis(double min, double max) = 0;
129
130 virtual void set_update_time(double t) = 0;
131
132 virtual void set_title(const std::string& title) = 0;
133 virtual void set_y_label(const std::string& label, const std::string& unit) = 0;
134 virtual void set_line_label(int which, const std::string& label) = 0;
135 virtual void set_line_color(int which, const std::string& color) = 0;
136 virtual void set_line_width(int which, int width) = 0;
137 virtual void set_line_style(int which, int style) = 0;
138 virtual void set_line_marker(int which, int marker) = 0;
139 virtual void set_line_alpha(int which, double alpha) = 0;
140
141 /*!
142 * Pass "true" to this function to only show the positive half
143 * of the spectrum. By default, this plotter shows the full
144 * spectrum (positive and negative halves).
145 */
146 virtual void set_plot_pos_half(bool half) = 0;
147
148 /*!
149 * Set up a trigger for the sink to know when to start
150 * plotting. Useful to isolate events and avoid noise.
151 *
152 * The trigger modes are Free, Auto, Normal, and Tag (see
153 * gr::qtgui::trigger_mode). The first three are like a normal
154 * trigger function. Free means free running with no trigger,
155 * auto will trigger if the trigger event is seen, but will
156 * still plot otherwise, and normal will hold until the trigger
157 * event is observed. The Tag trigger mode allows us to trigger
158 * off a specific stream tag. The tag trigger is based only on
159 * the name of the tag, so when a tag of the given name is seen,
160 * the trigger is activated.
161 *
162 * In auto and normal mode, we look to see if the magnitude of
163 * the any FFT point is over the set level.
164 *
165 * \param mode The trigger_mode: free, auto, normal, or tag.
166 * \param level The magnitude of the trigger even for auto or normal modes.
167 * \param channel Which input channel to use for the trigger events.
168 * \param tag_key The name (as a string) of the tag to trigger off
169 * of if using the tag mode.
170 */
172 float level,
173 int channel,
174 const std::string& tag_key = "") = 0;
175
176 virtual std::string title() = 0;
177 virtual std::string line_label(int which) = 0;
178 virtual std::string line_color(int which) = 0;
179 virtual int line_width(int which) = 0;
180 virtual int line_style(int which) = 0;
181 virtual int line_marker(int which) = 0;
182 virtual double line_alpha(int which) = 0;
183
184 virtual void set_size(int width, int height) = 0;
185
186 virtual void enable_menu(bool en = true) = 0;
187 virtual void enable_grid(bool en = true) = 0;
188 virtual void enable_autoscale(bool en = true) = 0;
189 virtual void enable_control_panel(bool en = true) = 0;
190 virtual void enable_max_hold(bool en) = 0;
191 virtual void enable_min_hold(bool en) = 0;
192 virtual void clear_max_hold() = 0;
193 virtual void clear_min_hold() = 0;
194 virtual void disable_legend() = 0;
195 virtual void reset() = 0;
196 virtual void enable_axis_labels(bool en = true) = 0;
197
198 QApplication* d_qApplication;
199};
200
201} /* namespace qtgui */
202} /* namespace gr */
203
204#endif /* INCLUDED_QTGUI_FREQ_SINK_F_H */
win_type
Definition: firdes.h:45
A graphical sink to display multiple signals in frequency.
Definition: freq_sink_f.h:82
virtual void disable_legend()=0
virtual void set_plot_pos_half(bool half)=0
virtual void set_fft_size(const int fftsize)=0
virtual void enable_min_hold(bool en)=0
virtual void set_update_time(double t)=0
boost::shared_ptr< freq_sink_f > sptr
Definition: freq_sink_f.h:85
virtual void * pyqwidget()=0
virtual void enable_menu(bool en=true)=0
virtual void reset()=0
virtual void clear_min_hold()=0
virtual void exec_()=0
virtual int fft_size() const =0
virtual void set_line_color(int which, const std::string &color)=0
virtual void enable_autoscale(bool en=true)=0
virtual std::string title()=0
virtual void set_fft_average(const float fftavg)=0
virtual void set_size(int width, int height)=0
virtual int line_width(int which)=0
virtual void clear_max_hold()=0
virtual gr::filter::firdes::win_type fft_window()=0
virtual void set_frequency_range(const double centerfreq, const double bandwidth)=0
virtual QWidget * qwidget()=0
virtual double line_alpha(int which)=0
virtual void set_title(const std::string &title)=0
virtual int line_marker(int which)=0
virtual void set_line_alpha(int which, double alpha)=0
virtual void set_fft_window(const gr::filter::firdes::win_type win)=0
virtual void set_trigger_mode(trigger_mode mode, float level, int channel, const std::string &tag_key="")=0
virtual void enable_axis_labels(bool en=true)=0
virtual float fft_average() const =0
virtual std::string line_label(int which)=0
virtual void set_y_axis(double min, double max)=0
virtual void set_y_label(const std::string &label, const std::string &unit)=0
static sptr make(int fftsize, int wintype, double fc, double bw, const std::string &name, int nconnections=1, QWidget *parent=NULL)
Build a floating point PSD sink.
virtual void set_line_label(int which, const std::string &label)=0
virtual void set_line_width(int which, int width)=0
virtual int line_style(int which)=0
virtual void enable_control_panel(bool en=true)=0
virtual void set_line_style(int which, int style)=0
virtual std::string line_color(int which)=0
virtual void enable_grid(bool en=true)=0
virtual void set_line_marker(int which, int marker)=0
virtual void enable_max_hold(bool en)=0
QApplication * d_qApplication
Definition: freq_sink_f.h:198
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define QTGUI_API
Definition: gr-qtgui/include/gnuradio/qtgui/api.h:30
trigger_mode
Definition: gr-qtgui/include/gnuradio/qtgui/trigger_mode.h:29
float min(float a, float b)
Include this header to use the message passing features.
Definition: basic_block.h:45