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
waterfall_sink_f.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_WATERFALL_SINK_F_H
24
#define INCLUDED_QTGUI_WATERFALL_SINK_F_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 on a
40
* waterfall (spectrogram) plot.
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 a waterfall (spectrogram) plot.
47
*
48
* Note that unlike the other qtgui sinks, this one does not
49
* support multiple input streams. We have yet to figure out a
50
* good way to display multiple, independent signals on this kind
51
* of a plot. If there are any suggestions or examples of this, we
52
* would love to see them. Otherwise, to display multiple signals
53
* here, it's probably best to sum the signals together and
54
* connect that here.
55
*
56
* Message Ports:
57
*
58
* - freq (input):
59
* Receives a PMT pair: (intern("freq"), double(frequency).
60
* This is used to retune the center frequency of the
61
* display's x-axis.
62
*
63
* - freq (output):
64
* Produces a PMT pair with (intern("freq"), double(frequency).
65
* When a user double-clicks on the display, the block
66
* produces and emits a message containing the frequency of
67
* where on the x-axis the user clicked. This value can be
68
* used by other blocks to update their frequency setting.
69
*
70
* To perform click-to-tune behavior, this output 'freq'
71
* port can be redirected to this block's input 'freq' port
72
* to catch the message and update the center frequency of
73
* the display.
74
*/
75
class
QTGUI_API
waterfall_sink_f
:
virtual
public
sync_block
76
{
77
public
:
78
// gr::qtgui::waterfall_sink_f::sptr
79
typedef
boost::shared_ptr<waterfall_sink_f>
sptr
;
80
81
/*!
82
* \brief Build a floating point waterfall sink.
83
*
84
* \param size size of the FFT to compute and display
85
* \param wintype type of window to apply (see gnuradio/filter/firdes.h)
86
* \param fc center frequency of signal (use for x-axis labels)
87
* \param bw bandwidth of signal (used to set x-axis labels)
88
* \param name title for the plot
89
* \param nconnections number of signals to be connected to the sink
90
* \param parent a QWidget parent object, if any
91
*/
92
static
sptr
make(
int
size,
int
wintype,
93
double
fc,
double
bw,
94
const
std::string &name,
95
int
nconnections=1,
96
QWidget *parent=NULL);
97
98
virtual
void
exec_() = 0;
99
virtual
QWidget* qwidget() = 0;
100
101
#ifdef ENABLE_PYTHON
102
virtual
PyObject* pyqwidget() = 0;
103
#else
104
virtual
void
* pyqwidget() = 0;
105
#endif
106
107
virtual
void
clear_data() = 0;
108
109
virtual
void
set_fft_size(
const
int
fftsize) = 0;
110
virtual
int
fft_size()
const
= 0;
111
virtual
void
set_fft_average(
const
float
fftavg) = 0;
112
virtual
float
fft_average()
const
= 0;
113
virtual
void
set_fft_window(
const
gr::filter::firdes::win_type
win) = 0;
114
virtual
gr::filter::firdes::win_type
fft_window() = 0;
115
116
virtual
void
set_frequency_range(
const
double
centerfreq,
117
const
double
bandwidth) = 0;
118
virtual
void
set_intensity_range(
const
double
min
,
119
const
double
max) = 0;
120
121
virtual
void
set_update_time(
double
t) = 0;
122
virtual
void
set_title(
const
std::string &title) = 0;
123
virtual
void
set_line_label(
int
which,
const
std::string &line) = 0;
124
virtual
void
set_line_alpha(
int
which,
double
alpha) = 0;
125
virtual
void
set_color_map(
int
which,
const
int
color) = 0;
126
127
virtual
std::string title() = 0;
128
virtual
std::string line_label(
int
which) = 0;
129
virtual
double
line_alpha(
int
which) = 0;
130
virtual
int
color_map(
int
which) = 0;
131
132
virtual
void
set_size(
int
width,
int
height) = 0;
133
134
virtual
void
auto_scale() = 0;
135
virtual
double
min_intensity(
int
which) = 0;
136
virtual
double
max_intensity(
int
which) = 0;
137
138
virtual
void
enable_menu(
bool
en=
true
) = 0;
139
virtual
void
enable_grid(
bool
en=
true
) = 0;
140
141
QApplication *
d_qApplication
;
142
};
143
144
}
/* namespace qtgui */
145
}
/* namespace gr */
146
147
#endif
/* INCLUDED_QTGUI_WATERFALL_SINK_F_H */
gr-qtgui
include
gnuradio
qtgui
waterfall_sink_f.h
Generated on Fri Oct 3 2014 00:33:51 for GNU Radio Manual and C++ API Reference by
1.8.1.2