Loading...
Searching...
No Matches
freq_sink_f.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2012,2014-2015 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_QTGUI_FREQ_SINK_F_H
#define INCLUDED_QTGUI_FREQ_SINK_F_H
#include <gnuradio/fft/window.h>
#include <gnuradio/qtgui/api.h>
#include <gnuradio/qtgui/trigger_mode.h>
#include <gnuradio/sync_block.h>
#include <qapplication.h>
namespace gr {
namespace qtgui {
/*!
* \brief A graphical sink to display multiple signals in frequency.
* \ingroup instrumentation_blk
* \ingroup qtgui_blk
*
* \details
* This is a QT-based graphical sink the takes set of a floating
* point streams and plots the PSD. Each signal is plotted with a
* different color, and the \a set_title and \a set_color
* functions can be used to change the label and color for a given
* input number.
*
* The sink supports plotting streaming float data or
* messages. The message port is named "in". The two modes cannot
* be used simultaneously, and \p nconnections should be set to 0
* when using the message mode. GRC handles this issue by
* providing the "Float Message" type that removes the streaming
* port(s).
*
* This sink can plot messages that contain either uniform vectors
* of float 32 values (pmt::is_f32vector) or PDUs where the data
* is a uniform vector of float 32 values.
*
* Message Ports:
*
* - freq (input):
* Receives a PMT pair: (intern("freq"), double(frequency)).
* This is used to retune the center frequency of the
* display's x-axis.
*
* - bw (input):
* Receives a PMT pair: (intern("bw"), double(bandwidth)).
* This is used to programmatically change the bandwidth of
* of the display's x-axis.
*
* - freq (output):
* Produces a PMT pair with (intern("freq"), double(frequency)).
* When a user double-clicks on the display, the block
* produces and emits a message containing the frequency of
* where on the x-axis the user clicked. This value can be
* used by other blocks to update their frequency setting.
*
* To perform click-to-tune behavior, this output 'freq'
* port can be redirected to this block's input 'freq' port
* to catch the message and update the center frequency of
* the display.
*/
class QTGUI_API freq_sink_f : virtual public sync_block
{
public:
// gr::qtgui::freq_sink_f::sptr
typedef std::shared_ptr<freq_sink_f> sptr;
/*!
* \brief Build a floating point PSD sink.
*
* \param fftsize size of the FFT to compute and display. If using
* the PDU message port to plot samples, the length of
* each PDU must be a multiple of the FFT size.
* \param wintype type of window to apply (see gr::fft::window::win_type).
* By setting bit 16 to one, this block will normalize the window
* before applying it. This allows switching between windows without
* sacrificing signal power due to tapering, but it will also
* amplify some samples. See also set_fft_window_normalized().
* \param fc center frequency of signal (use for x-axis labels)
* \param bw bandwidth of signal (used to set x-axis labels)
* \param name title for the plot
* \param nconnections number of signals to be connected to the
* sink. The PDU message port is always available for a
* connection, and this value must be set to 0 if only
* the PDU message port is being used.
* \param parent a QWidget parent object, if any
*/
static sptr make(int fftsize,
int wintype,
double fc,
double bw,
const std::string& name,
int nconnections = 1,
QWidget* parent = NULL);
virtual void exec_() = 0;
virtual QWidget* qwidget() = 0;
virtual void set_fft_size(const int fftsize) = 0;
virtual int fft_size() const = 0;
virtual void set_fft_average(const float fftavg) = 0;
virtual float fft_average() const = 0;
virtual void set_fft_window(const gr::fft::window::win_type win) = 0;
virtual gr::fft::window::win_type fft_window() = 0;
//! If true, normalize window to unit power
virtual void set_fft_window_normalized(const bool enable) = 0;
virtual void set_frequency_range(const double centerfreq, const double bandwidth) = 0;
virtual void set_y_axis(double min, double max) = 0;
virtual void set_update_time(double t) = 0;
virtual void set_title(const std::string& title) = 0;
virtual void set_y_label(const std::string& label, const std::string& unit) = 0;
virtual void set_line_label(unsigned int which, const std::string& label) = 0;
virtual void set_line_color(unsigned int which, const std::string& color) = 0;
virtual void set_line_width(unsigned int which, int width) = 0;
virtual void set_line_style(unsigned int which, int style) = 0;
virtual void set_line_marker(unsigned int which, int marker) = 0;
virtual void set_line_alpha(unsigned int which, double alpha) = 0;
/*!
* Pass "true" to this function to only show the positive half
* of the spectrum. By default, this plotter shows the full
* spectrum (positive and negative halves).
*/
virtual void set_plot_pos_half(bool half) = 0;
/*!
* Set up a trigger for the sink to know when to start
* plotting. Useful to isolate events and avoid noise.
*
* The trigger modes are Free, Auto, Normal, and Tag (see
* gr::qtgui::trigger_mode). The first three are like a normal
* trigger function. Free means free running with no trigger,
* auto will trigger if the trigger event is seen, but will
* still plot otherwise, and normal will hold until the trigger
* event is observed. The Tag trigger mode allows us to trigger
* off a specific stream tag. The tag trigger is based only on
* the name of the tag, so when a tag of the given name is seen,
* the trigger is activated.
*
* In auto and normal mode, we look to see if the magnitude of
* the any FFT point is over the set level.
*
* \param mode The trigger_mode: free, auto, normal, or tag.
* \param level The magnitude of the trigger even for auto or normal modes.
* \param channel Which input channel to use for the trigger events.
* \param tag_key The name (as a string) of the tag to trigger off
* of if using the tag mode.
*/
virtual void set_trigger_mode(trigger_mode mode,
float level,
int channel,
const std::string& tag_key = "") = 0;
virtual std::string title() = 0;
virtual std::string line_label(unsigned int which) = 0;
virtual std::string line_color(unsigned int which) = 0;
virtual int line_width(unsigned int which) = 0;
virtual int line_style(unsigned int which) = 0;
virtual int line_marker(unsigned int which) = 0;
virtual double line_alpha(unsigned int which) = 0;
virtual void set_size(int width, int height) = 0;
virtual void enable_menu(bool en = true) = 0;
virtual void enable_grid(bool en = true) = 0;
virtual void enable_autoscale(bool en = true) = 0;
virtual void enable_control_panel(bool en = true) = 0;
virtual void enable_max_hold(bool en) = 0;
virtual void enable_min_hold(bool en) = 0;
virtual void clear_max_hold() = 0;
virtual void clear_min_hold() = 0;
virtual void disable_legend() = 0;
virtual void reset() = 0;
virtual void enable_axis_labels(bool en = true) = 0;
QApplication* d_qApplication;
};
} /* namespace qtgui */
} /* namespace gr */
#endif /* INCLUDED_QTGUI_FREQ_SINK_F_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_f
A graphical sink to display multiple signals in frequency.
Definition freq_sink_f.h:71
gr::qtgui::freq_sink_f::line_style
virtual int line_style(unsigned int which)=0
gr::qtgui::freq_sink_f::disable_legend
virtual void disable_legend()=0
gr::qtgui::freq_sink_f::set_plot_pos_half
virtual void set_plot_pos_half(bool half)=0
gr::qtgui::freq_sink_f::set_fft_size
virtual void set_fft_size(const int fftsize)=0
gr::qtgui::freq_sink_f::line_alpha
virtual double line_alpha(unsigned int which)=0
gr::qtgui::freq_sink_f::enable_min_hold
virtual void enable_min_hold(bool en)=0
gr::qtgui::freq_sink_f::set_update_time
virtual void set_update_time(double t)=0
gr::qtgui::freq_sink_f::enable_menu
virtual void enable_menu(bool en=true)=0
gr::qtgui::freq_sink_f::fft_window
virtual gr::fft::window::win_type fft_window()=0
gr::qtgui::freq_sink_f::reset
virtual void reset()=0
gr::qtgui::freq_sink_f::clear_min_hold
virtual void clear_min_hold()=0
gr::qtgui::freq_sink_f::exec_
virtual void exec_()=0
gr::qtgui::freq_sink_f::fft_size
virtual int fft_size() const =0
gr::qtgui::freq_sink_f::enable_autoscale
virtual void enable_autoscale(bool en=true)=0
gr::qtgui::freq_sink_f::title
virtual std::string title()=0
gr::qtgui::freq_sink_f::set_fft_average
virtual void set_fft_average(const float fftavg)=0
gr::qtgui::freq_sink_f::set_size
virtual void set_size(int width, int height)=0
gr::qtgui::freq_sink_f::clear_max_hold
virtual void clear_max_hold()=0
gr::qtgui::freq_sink_f::set_fft_window
virtual void set_fft_window(const gr::fft::window::win_type win)=0
gr::qtgui::freq_sink_f::set_frequency_range
virtual void set_frequency_range(const double centerfreq, const double bandwidth)=0
gr::qtgui::freq_sink_f::qwidget
virtual QWidget * qwidget()=0
gr::qtgui::freq_sink_f::set_title
virtual void set_title(const std::string &title)=0
gr::qtgui::freq_sink_f::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_f::enable_axis_labels
virtual void enable_axis_labels(bool en=true)=0
gr::qtgui::freq_sink_f::set_line_alpha
virtual void set_line_alpha(unsigned int which, double alpha)=0
gr::qtgui::freq_sink_f::fft_average
virtual float fft_average() const =0
gr::qtgui::freq_sink_f::set_line_width
virtual void set_line_width(unsigned int which, int width)=0
gr::qtgui::freq_sink_f::set_line_label
virtual void set_line_label(unsigned int which, const std::string &label)=0
gr::qtgui::freq_sink_f::set_y_axis
virtual void set_y_axis(double min, double max)=0
gr::qtgui::freq_sink_f::set_line_style
virtual void set_line_style(unsigned int which, int style)=0
gr::qtgui::freq_sink_f::set_y_label
virtual void set_y_label(const std::string &label, const std::string &unit)=0
gr::qtgui::freq_sink_f::sptr
std::shared_ptr< freq_sink_f > sptr
Definition freq_sink_f.h:74
gr::qtgui::freq_sink_f::make
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.
gr::qtgui::freq_sink_f::enable_control_panel
virtual void enable_control_panel(bool en=true)=0
gr::qtgui::freq_sink_f::line_label
virtual std::string line_label(unsigned int which)=0
gr::qtgui::freq_sink_f::set_line_color
virtual void set_line_color(unsigned int which, const std::string &color)=0
gr::qtgui::freq_sink_f::line_marker
virtual int line_marker(unsigned int which)=0
gr::qtgui::freq_sink_f::set_line_marker
virtual void set_line_marker(unsigned int which, int marker)=0
gr::qtgui::freq_sink_f::enable_grid
virtual void enable_grid(bool en=true)=0
gr::qtgui::freq_sink_f::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_f::line_color
virtual std::string line_color(unsigned int which)=0
gr::qtgui::freq_sink_f::line_width
virtual int line_width(unsigned int which)=0
gr::qtgui::freq_sink_f::enable_max_hold
virtual void enable_max_hold(bool en)=0
gr::qtgui::freq_sink_f::d_qApplication
QApplication * d_qApplication
Definition freq_sink_f.h:187
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