diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-04-26 16:21:51 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-04-26 16:21:51 -0700 |
| commit | f944aaa241f8cb2f2e13f96e1f59d7a0e9b4e43b (patch) | |
| tree | a8f51fe579d652d9e6065fb4439f3dc799cb1823 /docs/sphinx | |
| parent | 009d47a2b6decdf2b434f517a7a14ba2a865f9ac (diff) | |
sphinx: Added sphinx source for gr-filter.
Diffstat (limited to 'docs/sphinx')
| -rw-r--r-- | docs/sphinx/source/filter/channelizers_blk.rst | 7 | ||||
| -rw-r--r-- | docs/sphinx/source/filter/filter_blk.rst | 15 | ||||
| -rw-r--r-- | docs/sphinx/source/filter/filter_design.rst | 4 | ||||
| -rw-r--r-- | docs/sphinx/source/filter/index.rst | 55 | ||||
| -rw-r--r-- | docs/sphinx/source/filter/resamplers_blk.rst | 9 | ||||
| -rw-r--r-- | docs/sphinx/source/index.rst | 2 |
6 files changed, 92 insertions, 0 deletions
diff --git a/docs/sphinx/source/filter/channelizers_blk.rst b/docs/sphinx/source/filter/channelizers_blk.rst new file mode 100644 index 0000000000..920be42882 --- /dev/null +++ b/docs/sphinx/source/filter/channelizers_blk.rst @@ -0,0 +1,7 @@ +gnuradio.filter: Channelizers +============================= + +.. autoblock:: gnuradio.filter.pfb_channelizer_ccf +.. autoblock:: gnuradio.filter.pfb_decimator_ccf +.. autoblock:: gnuradio.filter.pfb_interpolator_ccf +.. autoblock:: gnuradio.filter.pfb_synthesizer_ccf
\ No newline at end of file diff --git a/docs/sphinx/source/filter/filter_blk.rst b/docs/sphinx/source/filter/filter_blk.rst new file mode 100644 index 0000000000..4fa3c8b058 --- /dev/null +++ b/docs/sphinx/source/filter/filter_blk.rst @@ -0,0 +1,15 @@ +gnuradio.filter: Filters +======================== + +.. autoblock:: gnuradio.filter.adaptive_fir_ccc +.. autoblock:: gnuradio.filter.adaptive_fir_ccf +.. autoblock:: gnuradio.filter.dc_blocker_cc +.. autoblock:: gnuradio.filter.dc_blocker_ff +.. autoblock:: gnuradio.filter.fft_filter_fff +.. autoblock:: gnuradio.filter.fft_filter_ccc +.. autoblock:: gnuradio.filter.filter_delay_fc +.. autoblock:: gnuradio.filter.hilbert_fc +.. autoblock:: gnuradio.filter.iir_filter_ffd +.. autoblock:: gnuradio.filter.polyphase_filterbank +.. autoblock:: gnuradio.filter.single_pole_iir_filter_cc +.. autoblock:: gnuradio.filter.single_pole_iir_filter_ff diff --git a/docs/sphinx/source/filter/filter_design.rst b/docs/sphinx/source/filter/filter_design.rst new file mode 100644 index 0000000000..ad1cd252da --- /dev/null +++ b/docs/sphinx/source/filter/filter_design.rst @@ -0,0 +1,4 @@ +gnuradio.filter: Digital Filter Design +====================================== + +.. autoblock:: gnuradio.filter.firdes
\ No newline at end of file diff --git a/docs/sphinx/source/filter/index.rst b/docs/sphinx/source/filter/index.rst new file mode 100644 index 0000000000..1b8649bd72 --- /dev/null +++ b/docs/sphinx/source/filter/index.rst @@ -0,0 +1,55 @@ +gnuradio.filter +=============== + +.. automodule:: gnuradio.filter + +Channelizers +------------ + +.. autosummary:: + :nosignatures: + + gnuradio.filter.pfb_channelizer_ccf + gnuradio.filter.pfb_decimator_ccf + gnuradio.filter.pfb_interpolator_ccf + gnuradio.filter.pfb_synthesizer_ccf + +Filters +------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.adaptive_fir_ccc + gnuradio.filter.adaptive_fir_ccf + gnuradio.filter.dc_blocker_cc + gnuradio.filter.dc_blocker_ff + gnuradio.filter.fft_filter_fff + gnuradio.filter.fft_filter_ccc + gnuradio.filter.filter_delay_fc + gnuradio.filter.hilbert_fc + gnuradio.filter.iir_filter_ffd + gnuradio.filter.polyphase_filterbank + gnuradio.filter.single_pole_iir_filter_cc + gnuradio.filter.single_pole_iir_filter_ff + +Resamplers +---------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.fractional_interpolator_cc + gnuradio.filter.fractional_interpolator_ff + gnuradio.filter.fractional_resampler_cc + gnuradio.filter.fractional_resampler_ff + gnuradio.filter.pfb_arb_resampler_ccf + gnuradio.filter.pfb_arb_resampler_fff + +Digital Filter Design +--------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.firdes diff --git a/docs/sphinx/source/filter/resamplers_blk.rst b/docs/sphinx/source/filter/resamplers_blk.rst new file mode 100644 index 0000000000..348888659d --- /dev/null +++ b/docs/sphinx/source/filter/resamplers_blk.rst @@ -0,0 +1,9 @@ +gnuradio.filter: Resamplers +=========================== + +.. autoblock:: gnuradio.filter.fractional_interpolator_cc +.. autoblock:: gnuradio.filter.fractional_interpolator_ff +.. autoblock:: gnuradio.filter.fractional_resampler_cc +.. autoblock:: gnuradio.filter.fractional_resampler_ff +.. autoblock:: gnuradio.filter.pfb_arb_resampler_ccf +.. autoblock:: gnuradio.filter.pfb_arb_resampler_fff
\ No newline at end of file diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index bb27d1a22e..3bec9acecf 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -17,6 +17,7 @@ Core Framework gnuradio.channels gnuradio.comedi gnuradio.fec + gnuradio.filter gnuradio.trellis gnuradio.wavelet gnuradio.fft @@ -35,6 +36,7 @@ Core Framework gnuradio.channels <channels> gnuradio.comedi <comedi> gnuradio.fec <fec> + gnuradio.filter <filter> gnuradio.gr_unittest <gr_unittest/index> gnuradio.trellis <trellis/index> gnuradio.wavelet <wavelet> |