jgaeddert / liquid-dsp

digital signal processing library for software-defined radios
http://liquidsdr.org
MIT License
1.83k stars 429 forks source link

Documentaion Finite Impulse Response Hilbert Transform (firhilb) typo #157

Open ashley-b opened 5 years ago

ashley-b commented 5 years ago

http://liquidsdr.org/doc/firhilb/ documentation seams to wrong near the bottom for firhilbf_interp_execute

executes the transform as a decimator

probably should be

executes the transform as a interpolator

firhilbf_decim_execute(q,*x,*y) executes the transform as a decimator, converting a 2-sample input array x→ of real values into a single complex output value y
.
firhilbf_interp_execute(q,x,*y) executes the transform as a decimator, converting a single complex input sample x
into a two real-valued samples stored in the 

                                                              ^^^^^
                                                            interpolator
jgaeddert commented 5 years ago

Good catch. I’m in the process of overhauling the documentation, but catching mistakes like this are very useful. Thanks!

JayKickliter commented 5 years ago

I’m in the process of overhauling the documentation

I'm sure other's have told you before, but Liquid has the nicest API docs I've ever seen.

luzpaz commented 5 months ago

Is this still relevant ?