diff options
| author | Ipsit <mmkipsit@gmail.com> | 2021-02-22 18:55:52 +0530 |
|---|---|---|
| committer | Martin Braun <martin@gnuradio.org> | 2021-03-10 11:05:40 +0100 |
| commit | 51fcd60d3f170ee992b960c4623797c945fadc0d (patch) | |
| tree | e8932299e77efa56ec4190e43fd0f83aacfd65f4 /gr-digital/include | |
| parent | 5895df85a887fbd2d8bb1d4751e95a686471d638 (diff) | |
digital: Fix documentation for corr_est 'threshold' paramter
Signed-off-by: Ipsit <mmkipsit@gmail.com>
Signed-off-by: Martin Braun <martin@gnuradio.org>
Diffstat (limited to 'gr-digital/include')
| -rw-r--r-- | gr-digital/include/gnuradio/digital/corr_est_cc.h | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/gr-digital/include/gnuradio/digital/corr_est_cc.h b/gr-digital/include/gnuradio/digital/corr_est_cc.h index 78acb4075e..b83a137b78 100644 --- a/gr-digital/include/gnuradio/digital/corr_est_cc.h +++ b/gr-digital/include/gnuradio/digital/corr_est_cc.h @@ -89,10 +89,22 @@ public: * \param sps Samples per symbol * \param mark_delay tag marking delay in samples after the * corr_start tag - * \param threshold Threshold of correlator, relative to a 100% - * correlation (1.0). Default is 0.9. + * \param threshold Threshold of correlator. + * The meaning of this parameter depends on the threshold + * method used. For DYNAMIC threshold method, this + * parameter is actually 1 - Probability of False + * Alarm (under some inaccurate assumptions). The + * code performs the check + * |r[k]|^2 + |r[k+1]|^2 <> -log(1-threshold)*2*E, + * where r[k] is the correlated incoming signal, + * and E is the average sample energy of the + * correlated signal. For ABSOLUTE threshold method, + * this parameter sets the threshold to a fraction + * of the maximum squared autocorrelation. The code + * performs the check |r[k]|^2 <> threshold * R^2, + * where R is the precomputed max autocorrelation + * of the given sync word. Default is 0.9 * \param threshold_method Method for computing threshold. - * */ static sptr make(const std::vector<gr_complex>& symbols, float sps, |