diff --git a/src/sdr/_detection/_approximation.py b/src/sdr/_detection/_approximation.py index c74580ed5..c2fcb58b9 100644 --- a/src/sdr/_detection/_approximation.py +++ b/src/sdr/_detection/_approximation.py @@ -49,8 +49,10 @@ def albersheim(p_d: npt.ArrayLike, p_fa: npt.ArrayLike, n_nc: npt.ArrayLike = 1) detectors in minimal, so Albersheim's equation finds wide use. References: - - https://radarsp.weebly.com/uploads/2/1/4/7/21471216/albersheim_alternative_forms.pdf - - https://bpb-us-w2.wpmucdn.com/sites.gatech.edu/dist/5/462/files/2016/12/Noncoherent-Integration-Gain-Approximations.pdf + - `Mark Richards, Alternative Forms of Albersheim's Equation. + `_ + - `Mark Richards, Non-Coherent Gain and its Approximations. + `_ - https://www.mathworks.com/help/phased/ref/albersheim.html Examples: @@ -157,6 +159,10 @@ def peebles(p_d: npt.ArrayLike, p_fa: npt.ArrayLike, n_nc: npt.ArrayLike) -> npt Peebles' equation approximates the non-coherent integration gain using a square-law detector. + References: + - `Mark Richards, Non-Coherent Gain and its Approximations. + `_ + Examples: Compare the theoretical non-coherent gain for a square-law detector against the approximation from Peebles's equation. This comparison plots curves for various post-integration probabilities of detection. diff --git a/src/sdr/_farrow.py b/src/sdr/_farrow.py index c5e32fd28..a428e0a79 100644 --- a/src/sdr/_farrow.py +++ b/src/sdr/_farrow.py @@ -18,7 +18,8 @@ class FarrowResampler: References: - Michael Rice, *Digital Communications: A Discrete Time Approach*, Section 8.4.2. - - https://wirelesspi.com/fractional-delay-filters-using-the-farrow-structure/ + - `Qasim Chaudhari, Fractional Delay Filters Using the Farrow Structure. + `_ Examples: Create a sine wave with angular frequency $\omega = 2 \pi / 5.179$. Interpolate the signal by diff --git a/src/sdr/_modulation/_pulse_shapes.py b/src/sdr/_modulation/_pulse_shapes.py index baac66533..f6bbd4ebd 100644 --- a/src/sdr/_modulation/_pulse_shapes.py +++ b/src/sdr/_modulation/_pulse_shapes.py @@ -175,7 +175,8 @@ def gaussian( References: - https://www.mathworks.com/help/signal/ref/gaussdesign.html - - https://onlinelibrary.wiley.com/doi/pdf/10.1002/9780470041956.app2 + - `Appendix B: Gaussian Pulse-Shaping Filter. + `_ Examples: .. ipython:: python diff --git a/src/sdr/_sequence/_lfsr.py b/src/sdr/_sequence/_lfsr.py index 0a83e9508..ceb65e4f6 100644 --- a/src/sdr/_sequence/_lfsr.py +++ b/src/sdr/_sequence/_lfsr.py @@ -76,8 +76,8 @@ class FLFSR: $S = [y_{t+n-1}, y_{t+n-2}, \dots, y_{t+2}, y_{t+1}]$. References: - - Gardner, D. 2019. “Applications of the Galois Model LFSR in Cryptography”. - https://hdl.handle.net/2134/21932. + - `Gardner, D. 2019. “Applications of the Galois Model LFSR in Cryptography”. + `_ See Also: berlekamp_massey @@ -812,8 +812,8 @@ class GLFSR: In the Galois configuration, the shift register taps are $T = [c_0, c_1, \dots, c_{n-2}, c_{n-1}]$. References: - - Gardner, D. 2019. “Applications of the Galois Model LFSR in Cryptography”. - https://hdl.handle.net/2134/21932. + - `Gardner, D. 2019. “Applications of the Galois Model LFSR in Cryptography”. + `_ See Also: berlekamp_massey @@ -1493,10 +1493,12 @@ def berlekamp_massey(sequence, output="minimal"): minimal polynomial. References: - - Gardner, D. 2019. “Applications of the Galois Model LFSR in Cryptography”. https://hdl.handle.net/2134/21932. - - Sachs, J. Linear Feedback Shift Registers for the Uninitiated, Part VI: Sing Along with the - Berlekamp-Massey Algorithm. https://www.embeddedrelated.com/showarticle/1099.php - - https://crypto.stanford.edu/~mironov/cs359/massey.pdf + - `Gardner, D. 2019. “Applications of the Galois Model LFSR in Cryptography”. + `_ + - `Jason Sachs, Linear Feedback Shift Registers for the Uninitiated, Part VI: Sing Along with the + Berlekamp-Massey Algorithm. `_ + - `James Massey, Shift-Register Synthesis and BCH Decoding. + `_ Examples: The sequence below is a degree-4 linear recurrent sequence over $\mathrm{GF}(7)$. diff --git a/src/sdr/_synchronization/_agc.py b/src/sdr/_synchronization/_agc.py index 607cee801..c17add949 100644 --- a/src/sdr/_synchronization/_agc.py +++ b/src/sdr/_synchronization/_agc.py @@ -39,7 +39,8 @@ class AGC: References: - Michael Rice, *Digital Communications: A Discrete-Time Approach*, Section 9.5. - - https://wirelesspi.com/how-automatic-gain-control-agc-works/ + - `Qasim Chaudhari, How Automatic Gain Control (AGC) Works. + `_ Examples: Create an example received signal with two bursty signals surrounded by noise.