GNU Radio Manual and C++ API Reference
3.7.5
The Free & Open Software Radio Ecosystem
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Groups
Pages
freq_sink_c.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2012,2014 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_C_H
24
#define INCLUDED_QTGUI_FREQ_SINK_C_H
25
26
#ifdef ENABLE_PYTHON
27
#include <Python.h>
28
#endif
29
30
#include <
gnuradio/qtgui/api.h
>
31
#include <
gnuradio/sync_block.h
>
32
#include <qapplication.h>
33
#include <
gnuradio/filter/firdes.h
>
34
35
namespace
gr {
36
namespace
qtgui {
37
38
/*!
39
* \brief A graphical sink to display multiple signals in frequency.
40
* \ingroup instrumentation_blk
41
* \ingroup qtgui_blk
42
*
43
* \details
44
* This is a QT-based graphical sink the takes set of a complex
45
* streams and plots the PSD. Each signal is plotted with a
46
* different color, and the \a set_title and \a set_color
47
* functions can be used to change the lable and color for a given
48
* input number.
49
*
50
* Message Ports:
51
*
52
* - freq (input):
53
* Receives a PMT pair: (intern("freq"), double(frequency).
54
* This is used to retune the center frequency of the
55
* display's x-axis.
56
*
57
* - freq (output):
58
* Produces a PMT pair with (intern("freq"), double(frequency).
59
* When a user double-clicks on the display, the block
60
* produces and emits a message containing the frequency of
61
* where on the x-axis the user clicked. This value can be
62
* used by other blocks to update their frequency setting.
63
*
64
* To perform click-to-tune behavior, this output 'freq'
65
* port can be redirected to this block's input 'freq' port
66
* to catch the message and update the center frequency of
67
* the display.
68
*/
69
class
QTGUI_API
freq_sink_c
:
virtual
public
sync_block
70
{
71
public
:
72
// gr::qtgui::freq_sink_c::sptr
73
typedef
boost::shared_ptr<freq_sink_c>
sptr
;
74
75
/*!
76
* \brief Build a complex PSD sink.
77
*
78
* \param fftsize size of the FFT to compute and display
79
* \param wintype type of window to apply (see gnuradio/filter/firdes.h)
80
* \param fc center frequency of signal (use for x-axis labels)
81
* \param bw bandwidth of signal (used to set x-axis labels)
82
* \param name title for the plot
83
* \param nconnections number of signals connected to sink
84
* \param parent a QWidget parent object, if any
85
*/
86
static
sptr
make(
int
fftsize,
int
wintype,
87
double
fc,
double
bw,
88
const
std::string &name,
89
int
nconnections=1,
90
QWidget *parent=NULL);
91
92
virtual
void
exec_() = 0;
93
virtual
QWidget* qwidget() = 0;
94
95
#ifdef ENABLE_PYTHON
96
virtual
PyObject* pyqwidget() = 0;
97
#else
98
virtual
void
* pyqwidget() = 0;
99
#endif
100
101
virtual
void
set_fft_size(
const
int
fftsize) = 0;
102
virtual
int
fft_size()
const
= 0;
103
virtual
void
set_fft_average(
const
float
fftavg) = 0;
104
virtual
float
fft_average()
const
= 0;
105
virtual
void
set_fft_window(
const
gr::filter::firdes::win_type
win) = 0;
106
virtual
gr::filter::firdes::win_type
fft_window() = 0;
107
108
virtual
void
set_frequency_range(
const
double
centerfreq,
const
double
bandwidth) = 0;
109
virtual
void
set_y_axis(
double
min
,
double
max) = 0;
110
111
virtual
void
set_update_time(
double
t) = 0;
112
113
virtual
void
set_title(
const
std::string &title) = 0;
114
virtual
void
set_line_label(
int
which,
const
std::string &label) = 0;
115
virtual
void
set_line_color(
int
which,
const
std::string &color) = 0;
116
virtual
void
set_line_width(
int
which,
int
width) = 0;
117
virtual
void
set_line_style(
int
which,
int
style) = 0;
118
virtual
void
set_line_marker(
int
which,
int
marker) = 0;
119
virtual
void
set_line_alpha(
int
which,
double
alpha) = 0;
120
121
virtual
std::string title() = 0;
122
virtual
std::string line_label(
int
which) = 0;
123
virtual
std::string line_color(
int
which) = 0;
124
virtual
int
line_width(
int
which) = 0;
125
virtual
int
line_style(
int
which) = 0;
126
virtual
int
line_marker(
int
which) = 0;
127
virtual
double
line_alpha(
int
which) = 0;
128
129
virtual
void
set_size(
int
width,
int
height) = 0;
130
131
virtual
void
enable_menu(
bool
en=
true
) = 0;
132
virtual
void
enable_grid(
bool
en=
true
) = 0;
133
virtual
void
enable_autoscale(
bool
en=
true
) = 0;
134
virtual
void
clear_max_hold() = 0;
135
virtual
void
clear_min_hold() = 0;
136
virtual
void
reset() = 0;
137
138
QApplication *
d_qApplication
;
139
};
140
141
}
/* namespace qtgui */
142
}
/* namespace gr */
143
144
#endif
/* INCLUDED_QTGUI_FREQ_SINK_C_H */
gr-qtgui
include
gnuradio
qtgui
freq_sink_c.h
Generated on Fri Oct 3 2014 00:33:50 for GNU Radio Manual and C++ API Reference by
1.8.1.2