diff options
| author | Thomas Habets <habets@google.com> | 2020-12-12 13:51:32 +0000 |
|---|---|---|
| committer | Martin Braun <martin@gnuradio.org> | 2020-12-18 01:08:51 -0800 |
| commit | 1dbaa3bf7292c544d45925580493064641054929 (patch) | |
| tree | 9652b769f325ca345ecc59d4b7ff93057375a109 /gr-digital/include | |
| parent | 82966ede701dbe188af078386677946c0624313d (diff) | |
gr-digital: Update docs for MPSK SNR Estimator
Diffstat (limited to 'gr-digital/include')
| -rw-r--r-- | gr-digital/include/gnuradio/digital/mpsk_snr_est_cc.h | 5 | ||||
| -rw-r--r-- | gr-digital/include/gnuradio/digital/probe_mpsk_snr_est_c.h | 5 |
2 files changed, 8 insertions, 2 deletions
diff --git a/gr-digital/include/gnuradio/digital/mpsk_snr_est_cc.h b/gr-digital/include/gnuradio/digital/mpsk_snr_est_cc.h index 61d24cee44..731d9ac473 100644 --- a/gr-digital/include/gnuradio/digital/mpsk_snr_est_cc.h +++ b/gr-digital/include/gnuradio/digital/mpsk_snr_est_cc.h @@ -36,6 +36,8 @@ namespace digital { * designed and proven theoretically under AWGN conditions; some * amount of error should be assumed and/or estimated for real * channel conditions. + * + * The estimator is normally placed before clock recovery. */ class DIGITAL_API mpsk_snr_est_cc : virtual public sync_block { @@ -50,7 +52,8 @@ public: * \param tag_nsamples: after this many samples, a tag containing * the SNR (key='snr') will be sent * \param alpha: the update rate of internal running average - * calculations + * calculations. Needs to be between 0 and 1, where higher value + * adjusts faster to new data. */ static sptr make(snr_est_type_t type, int tag_nsamples = 10000, double alpha = 0.001); diff --git a/gr-digital/include/gnuradio/digital/probe_mpsk_snr_est_c.h b/gr-digital/include/gnuradio/digital/probe_mpsk_snr_est_c.h index c56ffc2771..5443112a35 100644 --- a/gr-digital/include/gnuradio/digital/probe_mpsk_snr_est_c.h +++ b/gr-digital/include/gnuradio/digital/probe_mpsk_snr_est_c.h @@ -43,6 +43,8 @@ namespace digital { * * Some calibration is required to convert dBx of the signal and * noise power estimates to real measurements, such as dBm. + * + * The estimator is normally placed before clock recovery. */ class DIGITAL_API probe_mpsk_snr_est_c : virtual public sync_block { @@ -59,7 +61,8 @@ public: * \param msg_nsamples: [not implemented yet] after this many * samples, a message containing the SNR (key='snr') will be sent * \param alpha: the update rate of internal running average - * calculations. + * calculations. Needs to be between 0 and 1, where higher value + * adjusts faster to new data. */ static sptr make(snr_est_type_t type, int msg_nsamples = 10000, double alpha = 0.001); |