diff options
| author | arualok22 <arualok22@gmail.com> | 2020-02-02 17:57:34 +0530 |
|---|---|---|
| committer | Marcus Müller <marcus@hostalia.de> | 2020-02-09 19:32:54 +0100 |
| commit | 467357fa5655fcfc0be6d37dca5d0a881c62c68c (patch) | |
| tree | f44bfc814412a0d031296108cc1b32a3ffd72e1f | |
| parent | bbbcdf97e04c1f1284de230310705ee3b62634b5 (diff) | |
docs: GRC documentation for rational resampler
| -rw-r--r-- | gr-filter/grc/filter_rational_resampler_xxx.block.yml | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/gr-filter/grc/filter_rational_resampler_xxx.block.yml b/gr-filter/grc/filter_rational_resampler_xxx.block.yml index 738a78c80b..bf11b7a251 100644 --- a/gr-filter/grc/filter_rational_resampler_xxx.block.yml +++ b/gr-filter/grc/filter_rational_resampler_xxx.block.yml @@ -59,4 +59,24 @@ templates: callbacks: - set_taps(${taps}) +documentation: |- + This is a rational resampling polyphase FIR filter. + + Either taps or fractional_bw may be specified, but not both. + + If neither is specified, a reasonable default, 0.4, is used as the fractional_bw. + + Parameters: + Interpolation + Interpolation factor (integer > 0) + + Decimation + Decimation factor (integer > 0) + + Taps (R) + Optional filter coefficients (sequence) + + Fractional BW + Fractional bandwidth in (0, 0.5), measured at final freq (use 0.4) (float) + file_format: 1 |