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

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

Loading...
Searching...
No Matches
eye_sink_c.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2020 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#ifndef INCLUDED_QTGUI_EYE_SINK_C_H
11#define INCLUDED_QTGUI_EYE_SINK_C_H
12
13#include <gnuradio/qtgui/api.h>
14#include <gnuradio/qtgui/trigger_mode.h>
15#include <gnuradio/sync_block.h>
16#include <qapplication.h>
17
18namespace gr {
19namespace qtgui {
20
21/*!
22 * \brief A graphical sink to display signals eye patterns.
23 * \ingroup qtgui
24 *
25 * \details
26 * This is a QT-based graphical sink which takes a set of a complex
27 * streams and plots them as an eye pattern. For each signal, both
28 * the signal's I and Q eye patterns are plotted. Eye patterns are
29 * 2 symbol's time long. Symbol rate must be an integer multiple of
30 * the sample rate to obtain the eye pattern.
31 *
32 * Trigger occurs at the beginning of each stream used to plot the
33 * eye pattern; whilst a real eye diagram would be triggered with
34 * a (recovered) symbol clock. For these reasons, triggering of
35 * noisy and/or unsynchronized signals may lead to incorrect eye
36 * pattern.
37 *
38 * The sink supports plotting streaming complex data or
39 * messages. The message port is named "in". The two modes cannot
40 * be used simultaneously, and \p nconnections should be set to 0
41 * when using the message mode. GRC handles this issue by
42 * providing the "Complex Message" type that removes the streaming
43 * port(s).
44 *
45 * This sink can plot messages that contain either uniform vectors
46 * of complex 32 values (pmt::is_c32vector) or PDUs where the data
47 * is a uniform vector of complex 32 values.
48 */
49 class QTGUI_API eye_sink_c : virtual public gr::sync_block
50{
51public:
52 // gr::qtgui::eye_sink_c::sptr
53 typedef std::shared_ptr<eye_sink_c> sptr;
54
55 /*!
56 * \brief Build complex eye sink
57 *
58 * \param size number of points to plot at once
59 * \param samp_rate sample rate (used to set x-axis labels)
60 * \param nconnections number of signals connected to sink
61 * \param parent a QWidget parent object, if any
62 */
63 static sptr make(int size,
64 double samp_rate,
65 unsigned int nconnections = 1,
66 QWidget* parent = NULL);
67
68 virtual void exec_() = 0;
69 virtual QWidget* qwidget() = 0;
70
71 virtual void set_y_axis(double min, double max) = 0;
72 virtual void set_y_label(const std::string& label, const std::string& unit = "") = 0;
73 virtual void set_update_time(double t) = 0;
74 virtual void set_samp_per_symbol(unsigned int sps) = 0;
75 virtual void set_line_label(unsigned int which, const std::string& label) = 0;
76 virtual void set_line_color(unsigned int which, const std::string& color) = 0;
77 virtual void set_line_width(unsigned int which, int width) = 0;
78 virtual void set_line_style(unsigned int which, int style) = 0;
79 virtual void set_line_marker(unsigned int which, int marker) = 0;
80 virtual void set_nsamps(const int newsize) = 0;
81 virtual void set_samp_rate(const double samp_rate) = 0;
82 virtual void set_line_alpha(unsigned int which, double alpha) = 0;
83
84 /*!
85 * Set up a trigger for the sink to know when to start
86 * plotting. Useful to isolate events and avoid noise.
87 *
88 * The trigger modes are Free, Auto, Normal, and Tag (see
89 * gr::qtgui::trigger_mode). The first three are like a normal
90 * oscope trigger function. Free means free running with no
91 * trigger, auto will trigger if the trigger event is seen, but
92 * will still plot otherwise, and normal will hold until the
93 * trigger event is observed. The Tag trigger mode allows us to
94 * trigger off a specific stream tag. The tag trigger is based
95 * only on the name of the tag, so when a tag of the given name
96 * is seen, the trigger is activated.
97 *
98 * In auto and normal mode, we look for the slope of the of the
99 * signal. Given a gr::qtgui::trigger_slope as either Positive
100 * or Negative, if the value between two samples moves in the
101 * given direction (x[1] > x[0] for Positive or x[1] < x[0] for
102 * Negative), then the trigger is activated.
103 *
104 * With the complex eye sink, each input has two eye patterns
105 * drawn for the real and imaginary parts of the signal. When
106 * selecting the \p channel value, channel 0 is the real signal
107 * and channel 1 is the imaginary signal. For more than 1 input
108 * stream, channel 2i is the real part of the ith input and
109 * channel (2i+1) is the imaginary part of the ith input
110 * channel.
111 *
112 * The \p delay value is specified in time based off the sample
113 * rate. If the sample rate of the block is set to 1, the delay
114 * is then also the sample number offset. This is the offset
115 * from the left-hand y-axis of the plot. It delays the signal
116 * to show the trigger event at the given delay along with some
117 * portion of the signal before the event. The delay must be
118 * within 0 - t_max where t_max is the maximum amount of time
119 * displayed on the eye pattern equal to 2 symbol time.
120 *
121 * \param mode The trigger_mode: free, auto, normal, or tag.
122 * \param slope The trigger_slope: positive or negative. Only
123 * used for auto and normal modes.
124 * \param level The magnitude of the trigger even for auto or normal modes.
125 * \param delay The delay (in units of time) for where the trigger happens.
126 * \param channel Which input channel to use for the trigger events.
127 * \param tag_key The name (as a string) of the tag to trigger off
128 * of if using the tag mode.
129 */
130 virtual void set_trigger_mode(gr::qtgui::trigger_mode mode,
131 gr::qtgui::trigger_slope slope,
132 float level,
133 float delay,
134 int channel,
135 const std::string& tag_key = "") = 0;
136
137 virtual std::string title() = 0;
138 virtual std::string line_label(unsigned int which) = 0;
139 virtual std::string line_color(unsigned int which) = 0;
140 virtual int line_width(unsigned int which) = 0;
141 virtual int line_style(unsigned int which) = 0;
142 virtual int line_marker(unsigned int which) = 0;
143 virtual double line_alpha(unsigned int which) = 0;
144
145 virtual void set_size(int width, int height) = 0;
146
147 virtual void enable_menu(bool en = true) = 0;
148 virtual void enable_grid(bool en = true) = 0;
149 virtual void enable_autoscale(bool en = true) = 0;
150 virtual void
151 enable_stem_plot(bool en = true) = 0; // Used by parent class, do not remove
152 virtual void
153 enable_semilogx(bool en = true) = 0; // Used by parent class, do not remove
154 virtual void
155 enable_semilogy(bool en = true) = 0; // Used by parent class, do not remove
156 virtual void enable_control_panel(bool en = true) = 0;
157 virtual void enable_tags(unsigned int which, bool en) = 0;
158 virtual void enable_tags(bool en) = 0;
159 virtual void enable_axis_labels(bool en = true) = 0;
160 virtual void disable_legend() = 0;
161
162 virtual int nsamps() const = 0;
163 virtual void reset() = 0;
164
165 QApplication* d_qApplication;
166};
167
168} // namespace qtgui
169} // namespace gr
170
171#endif /* INCLUDED_QTGUI_EYE_SINK_C_H */
gr::basic_block::color
vcolor color() const
Definition basic_block.h:122
gr::qtgui::eye_sink_c
A graphical sink to display signals eye patterns.
Definition eye_sink_c.h:50
gr::qtgui::eye_sink_c::enable_autoscale
virtual void enable_autoscale(bool en=true)=0
gr::qtgui::eye_sink_c::enable_semilogx
virtual void enable_semilogx(bool en=true)=0
gr::qtgui::eye_sink_c::set_line_color
virtual void set_line_color(unsigned int which, const std::string &color)=0
gr::qtgui::eye_sink_c::enable_control_panel
virtual void enable_control_panel(bool en=true)=0
gr::qtgui::eye_sink_c::disable_legend
virtual void disable_legend()=0
gr::qtgui::eye_sink_c::set_samp_per_symbol
virtual void set_samp_per_symbol(unsigned int sps)=0
gr::qtgui::eye_sink_c::make
static sptr make(int size, double samp_rate, unsigned int nconnections=1, QWidget *parent=NULL)
Build complex eye sink.
gr::qtgui::eye_sink_c::enable_stem_plot
virtual void enable_stem_plot(bool en=true)=0
gr::qtgui::eye_sink_c::set_line_alpha
virtual void set_line_alpha(unsigned int which, double alpha)=0
gr::qtgui::eye_sink_c::sptr
std::shared_ptr< eye_sink_c > sptr
Definition eye_sink_c.h:53
gr::qtgui::eye_sink_c::enable_tags
virtual void enable_tags(bool en)=0
gr::qtgui::eye_sink_c::set_line_label
virtual void set_line_label(unsigned int which, const std::string &label)=0
gr::qtgui::eye_sink_c::enable_axis_labels
virtual void enable_axis_labels(bool en=true)=0
gr::qtgui::eye_sink_c::set_line_width
virtual void set_line_width(unsigned int which, int width)=0
gr::qtgui::eye_sink_c::set_trigger_mode
virtual void set_trigger_mode(gr::qtgui::trigger_mode mode, gr::qtgui::trigger_slope slope, float level, float delay, int channel, const std::string &tag_key="")=0
gr::qtgui::eye_sink_c::line_style
virtual int line_style(unsigned int which)=0
gr::qtgui::eye_sink_c::set_line_style
virtual void set_line_style(unsigned int which, int style)=0
gr::qtgui::eye_sink_c::line_label
virtual std::string line_label(unsigned int which)=0
gr::qtgui::eye_sink_c::line_color
virtual std::string line_color(unsigned int which)=0
gr::qtgui::eye_sink_c::set_y_label
virtual void set_y_label(const std::string &label, const std::string &unit="")=0
gr::qtgui::eye_sink_c::enable_grid
virtual void enable_grid(bool en=true)=0
gr::qtgui::eye_sink_c::set_size
virtual void set_size(int width, int height)=0
gr::qtgui::eye_sink_c::line_width
virtual int line_width(unsigned int which)=0
gr::qtgui::eye_sink_c::d_qApplication
QApplication * d_qApplication
Definition eye_sink_c.h:165
gr::qtgui::eye_sink_c::enable_semilogy
virtual void enable_semilogy(bool en=true)=0
gr::qtgui::eye_sink_c::enable_tags
virtual void enable_tags(unsigned int which, bool en)=0
gr::qtgui::eye_sink_c::set_nsamps
virtual void set_nsamps(const int newsize)=0
gr::qtgui::eye_sink_c::qwidget
virtual QWidget * qwidget()=0
gr::qtgui::eye_sink_c::set_y_axis
virtual void set_y_axis(double min, double max)=0
gr::qtgui::eye_sink_c::exec_
virtual void exec_()=0
gr::qtgui::eye_sink_c::set_samp_rate
virtual void set_samp_rate(const double samp_rate)=0
gr::qtgui::eye_sink_c::enable_menu
virtual void enable_menu(bool en=true)=0
gr::qtgui::eye_sink_c::line_marker
virtual int line_marker(unsigned int which)=0
gr::qtgui::eye_sink_c::set_line_marker
virtual void set_line_marker(unsigned int which, int marker)=0
gr::qtgui::eye_sink_c::line_alpha
virtual double line_alpha(unsigned int which)=0
gr::qtgui::eye_sink_c::set_update_time
virtual void set_update_time(double t)=0
gr::qtgui::eye_sink_c::reset
virtual void reset()=0
gr::qtgui::eye_sink_c::nsamps
virtual int nsamps() const =0
gr::qtgui::eye_sink_c::title
virtual std::string title()=0
gr::sync_block
synchronous 1:1 input to output with history
Definition sync_block.h:26
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::qtgui::trigger_slope
trigger_slope
Definition trigger_mode.h:24
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h
trigger_mode.h