1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* -*- c++ -*- */
/*
* Copyright 2007,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
// @WARNING@
#ifndef @GUARD_NAME@
#define @GUARD_NAME@
#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace blocks {
/*!
* \brief Detect the peak of a signal
* \ingroup peak_detectors_blk
*
* \details
* If a peak is detected, this block outputs a 1,
* or it outputs 0's.
*/
class BLOCKS_API @NAME@ : virtual public sync_block
{
public:
// gr::blocks::@NAME@::sptr
typedef boost::shared_ptr<@NAME@> sptr;
/*!
* Make a peak detector block.
*
* \param threshold_factor_rise The threshold factor determins
* when a peak has started. An average of the signal is
* calculated and when the value of the signal goes over
* threshold_factor_rise*average, we start looking for a
* peak.
* \param threshold_factor_fall The threshold factor determins
* when a peak has ended. An average of the signal is
* calculated and when the value of the signal goes
* bellow threshold_factor_fall*average, we stop looking
* for a peak.
* \param look_ahead The look-ahead value is used when the
* threshold is found to look if there another peak
* within this step range. If there is a larger value,
* we set that as the peak and look ahead again. This is
* continued until the highest point is found with This
* look-ahead range.
* \param alpha The gain value of a moving average filter
*/
static sptr make(float threshold_factor_rise = 0.25,
float threshold_factor_fall = 0.40,
int look_ahead = 10,
float alpha = 0.001);
/*! \brief Set the threshold factor value for the rise time
* \param thr new threshold factor
*/
virtual void set_threshold_factor_rise(float thr) = 0;
/*! \brief Set the threshold factor value for the fall time
* \param thr new threshold factor
*/
virtual void set_threshold_factor_fall(float thr) = 0;
/*! \brief Set the look-ahead factor
* \param look new look-ahead factor
*/
virtual void set_look_ahead(int look) = 0;
/*! \brief Set the running average alpha
* \param alpha new alpha for running average
*/
virtual void set_alpha(int alpha) = 0;
/*! \brief Get the threshold factor value for the rise time
* \return threshold factor
*/
virtual float threshold_factor_rise() = 0;
/*! \brief Get the threshold factor value for the fall time
* \return threshold factor
*/
virtual float threshold_factor_fall() = 0;
/*! \brief Get the look-ahead factor value
* \return look-ahead factor
*/
virtual int look_ahead() = 0;
/*! \brief Get the alpha value of the running average
* \return alpha
*/
virtual float alpha() = 0;
};
} /* namespace blocks */
} /* namespace gr */
#endif /* @GUARD_NAME@ */
|
