diff options
| author | Ron Economos <w6rz@comcast.net> | 2020-12-18 07:01:49 -0800 |
|---|---|---|
| committer | mormj <34754695+mormj@users.noreply.github.com> | 2020-12-18 10:20:18 -0500 |
| commit | b681ea897e54fd245677a306b5e65f8d59a3e030 (patch) | |
| tree | 310c1ff5c42fa973d8fd0b9defb7eb4475453eed /gr-digital/include | |
| parent | 947800c52f2fcb2b149cfd2809148afcfdb8b79a (diff) | |
gr-digital: Document normalization parameter in constellation.h
Signed-off-by: Ron Economos <w6rz@comcast.net>
Diffstat (limited to 'gr-digital/include')
| -rw-r--r-- | gr-digital/include/gnuradio/digital/constellation.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/gr-digital/include/gnuradio/digital/constellation.h b/gr-digital/include/gnuradio/digital/constellation.h index ebe37088b7..d6d39353d8 100644 --- a/gr-digital/include/gnuradio/digital/constellation.h +++ b/gr-digital/include/gnuradio/digital/constellation.h @@ -289,6 +289,9 @@ public: * \param rotational_symmetry Number of rotations around unit circle that have the * same representation. \param dimensionality Number of z-axis dimensions to the * constellation \param n_sectors Number of sectors in the constellation. + * \param normalization Use AMPLITUDE_NORMALIZATION to normalize points to + * mean(abs(points))=1 (default), POWER_NORMALIZATION to normalize points + * to mean(abs(points)^2)=1 or NO_NORMALIZATION to keep the original amplitude. */ constellation_sector(std::vector<gr_complex> constell, std::vector<int> pre_diff_code, @@ -346,7 +349,9 @@ public: * in to. \param imag_sectors Number of sectors the imag axis is split in to. \param * width_real_sectors width of each real sector to calculate decision boundaries. * \param width_imag_sectors width of each imag sector to calculate decision - * boundaries. + * boundaries. \param normalization Use AMPLITUDE_NORMALIZATION to normalize points + * to mean(abs(points))=1 (default), POWER_NORMALIZATION to normalize points to + * mean(abs(points)^2)=1 or NO_NORMALIZATION to keep the original amplitude. */ static constellation_rect::sptr make(std::vector<gr_complex> constell, |