diff options
author | Manoj Gudi | 2013-10-07 20:19:55 +0530 |
---|---|---|
committer | Manoj Gudi | 2013-10-07 20:20:35 +0530 |
commit | 1826d0763c8595997f5f4af1fdb0354e9c0998ad (patch) | |
tree | acbd852cd5a1bf17241b1038b5e37a0e72e64612 /docs/sphinx/source/gr | |
parent | 452defdb4a78e9e826740ddf4b9673e926c568a4 (diff) | |
parent | 24b640997ba7fee0c725e65f401f5cbebdab8d08 (diff) | |
download | gnuradio-1826d0763c8595997f5f4af1fdb0354e9c0998ad.tar.gz gnuradio-1826d0763c8595997f5f4af1fdb0354e9c0998ad.tar.bz2 gnuradio-1826d0763c8595997f5f4af1fdb0354e9c0998ad.zip |
README change
Diffstat (limited to 'docs/sphinx/source/gr')
-rw-r--r-- | docs/sphinx/source/gr/coding_blk.rst | 11 | ||||
-rw-r--r-- | docs/sphinx/source/gr/converter_blk.rst | 32 | ||||
-rw-r--r-- | docs/sphinx/source/gr/demodulation_blk.rst | 4 | ||||
-rw-r--r-- | docs/sphinx/source/gr/dft_blk.rst | 6 | ||||
-rw-r--r-- | docs/sphinx/source/gr/filter_blk.rst | 46 | ||||
-rw-r--r-- | docs/sphinx/source/gr/filter_design.rst | 7 | ||||
-rw-r--r-- | docs/sphinx/source/gr/index.rst | 380 | ||||
-rw-r--r-- | docs/sphinx/source/gr/internal.rst | 7 | ||||
-rw-r--r-- | docs/sphinx/source/gr/level_blk.rst | 26 | ||||
-rw-r--r-- | docs/sphinx/source/gr/math_blk.rst | 59 | ||||
-rw-r--r-- | docs/sphinx/source/gr/misc.rst | 12 | ||||
-rw-r--r-- | docs/sphinx/source/gr/misc_blk.rst | 12 | ||||
-rw-r--r-- | docs/sphinx/source/gr/modulation_blk.rst | 6 | ||||
-rw-r--r-- | docs/sphinx/source/gr/sink_blk.rst | 25 | ||||
-rw-r--r-- | docs/sphinx/source/gr/slicedice_blk.rst | 14 | ||||
-rw-r--r-- | docs/sphinx/source/gr/source_blk.rst | 26 | ||||
-rw-r--r-- | docs/sphinx/source/gr/sync_blk.rst | 9 | ||||
-rw-r--r-- | docs/sphinx/source/gr/top_block.rst | 7 |
18 files changed, 689 insertions, 0 deletions
diff --git a/docs/sphinx/source/gr/coding_blk.rst b/docs/sphinx/source/gr/coding_blk.rst new file mode 100644 index 000000000..e50b990bc --- /dev/null +++ b/docs/sphinx/source/gr/coding_blk.rst @@ -0,0 +1,11 @@ +gnuradio.gr: Information Coding and Decoding +============================================ + +.. autooldblock:: gnuradio.gr.additive_scrambler_bb +.. autooldblock:: gnuradio.gr.descrambler_bb +.. autooldblock:: gnuradio.gr.diff_decoder_bb +.. autooldblock:: gnuradio.gr.diff_encoder_bb +.. autooldblock:: gnuradio.gr.fake_channel_encoder_pp +.. autooldblock:: gnuradio.gr.fake_channel_decoder_pp +.. autooldblock:: gnuradio.gr.map_bb +.. autooldblock:: gnuradio.gr.scrambler_bb diff --git a/docs/sphinx/source/gr/converter_blk.rst b/docs/sphinx/source/gr/converter_blk.rst new file mode 100644 index 000000000..790109a94 --- /dev/null +++ b/docs/sphinx/source/gr/converter_blk.rst @@ -0,0 +1,32 @@ +gnuradio.gr: Type Conversions +============================= + +.. autooldblock:: gnuradio.gr.bytes_to_syms +.. autooldblock:: gnuradio.gr.char_to_float +.. autooldblock:: gnuradio.gr.complex_to_interleaved_short +.. autooldblock:: gnuradio.gr.complex_to_float +.. autooldblock:: gnuradio.gr.complex_to_real +.. autooldblock:: gnuradio.gr.complex_to_imag +.. autooldblock:: gnuradio.gr.complex_to_mag +.. autooldblock:: gnuradio.gr.complex_to_mag_squared +.. autooldblock:: gnuradio.gr.complex_to_arg +.. autooldblock:: gnuradio.gr.float_to_char +.. autooldblock:: gnuradio.gr.float_to_complex +.. autooldblock:: gnuradio.gr.float_to_short +.. autooldblock:: gnuradio.gr.float_to_uchar +.. autooldblock:: gnuradio.gr.interleaved_short_to_complex +.. autooldblock:: gnuradio.gr.short_to_float +.. autooldblock:: gnuradio.gr.uchar_to_float +.. autooldblock:: gnuradio.gr.unpack_k_bits_bb +.. autooldblock:: gnuradio.gr.chunks_to_symbols_bc +.. autooldblock:: gnuradio.gr.chunks_to_symbols_bf +.. autooldblock:: gnuradio.gr.chunks_to_symbols_ic +.. autooldblock:: gnuradio.gr.chunks_to_symbols_if +.. autooldblock:: gnuradio.gr.chunks_to_symbols_sc +.. autooldblock:: gnuradio.gr.chunks_to_symbols_sf +.. autooldblock:: gnuradio.gr.packed_to_unpacked_bb +.. autooldblock:: gnuradio.gr.packed_to_unpacked_ii +.. autooldblock:: gnuradio.gr.packed_to_unpacked_ss +.. autooldblock:: gnuradio.gr.unpacked_to_packed_bb +.. autooldblock:: gnuradio.gr.unpacked_to_packed_ii +.. autooldblock:: gnuradio.gr.unpacked_to_packed_ss diff --git a/docs/sphinx/source/gr/demodulation_blk.rst b/docs/sphinx/source/gr/demodulation_blk.rst new file mode 100644 index 000000000..4f800b642 --- /dev/null +++ b/docs/sphinx/source/gr/demodulation_blk.rst @@ -0,0 +1,4 @@ +gnuradio.gr: Demodulation +========================= + +.. autooldblock:: gnuradio.gr.quadrature_demod_cf diff --git a/docs/sphinx/source/gr/dft_blk.rst b/docs/sphinx/source/gr/dft_blk.rst new file mode 100644 index 000000000..4ac1d2e62 --- /dev/null +++ b/docs/sphinx/source/gr/dft_blk.rst @@ -0,0 +1,6 @@ +gnuradio.gr: Fourier Transform +============================== + +.. autooldblock:: gnuradio.gr.goertzel_fc +.. autooldblock:: gnuradio.gr.fft_vcc +.. autooldblock:: gnuradio.gr.fft_vfc diff --git a/docs/sphinx/source/gr/filter_blk.rst b/docs/sphinx/source/gr/filter_blk.rst new file mode 100644 index 000000000..a73ddda2a --- /dev/null +++ b/docs/sphinx/source/gr/filter_blk.rst @@ -0,0 +1,46 @@ +gnuradio.gr: Filters +==================== + +.. autooldblock:: gnuradio.gr.fft_filter_ccc +.. autooldblock:: gnuradio.gr.fft_filter_fff +.. autooldblock:: gnuradio.gr.filter_delay_fc +.. autooldblock:: gnuradio.gr.fir_filter_ccc +.. autooldblock:: gnuradio.gr.fir_filter_ccf +.. autooldblock:: gnuradio.gr.fir_filter_fcc +.. autooldblock:: gnuradio.gr.fir_filter_fff +.. autooldblock:: gnuradio.gr.fir_filter_fsf +.. autooldblock:: gnuradio.gr.fir_filter_scc +.. autooldblock:: gnuradio.gr.fractional_interpolator_cc +.. autooldblock:: gnuradio.gr.fractional_interpolator_ff +.. autooldblock:: gnuradio.gr.freq_xlating_fir_filter_ccc +.. autooldblock:: gnuradio.gr.freq_xlating_fir_filter_ccf +.. autooldblock:: gnuradio.gr.freq_xlating_fir_filter_fcc +.. autooldblock:: gnuradio.gr.freq_xlating_fir_filter_fcf +.. autooldblock:: gnuradio.gr.freq_xlating_fir_filter_scc +.. autooldblock:: gnuradio.gr.freq_xlating_fir_filter_scf +.. autooldblock:: gnuradio.gr.hilbert_fc +.. autooldblock:: gnuradio.gr.iir_filter_ffd +.. autooldblock:: gnuradio.gr.interp_fir_filter_ccc +.. autooldblock:: gnuradio.gr.interp_fir_filter_ccf +.. autooldblock:: gnuradio.gr.interp_fir_filter_fcc +.. autooldblock:: gnuradio.gr.interp_fir_filter_fff +.. autooldblock:: gnuradio.gr.interp_fir_filter_fsf +.. autooldblock:: gnuradio.gr.interp_fir_filter_scc +.. autooldblock:: gnuradio.gr.rational_resampler_base_ccc +.. autooldblock:: gnuradio.gr.rational_resampler_base_ccf +.. autooldblock:: gnuradio.gr.rational_resampler_base_fcc +.. autooldblock:: gnuradio.gr.rational_resampler_base_fff +.. autooldblock:: gnuradio.gr.rational_resampler_base_fsf +.. autooldblock:: gnuradio.gr.rational_resampler_base_scc +.. autooldblock:: gnuradio.gr.single_pole_iir_filter_cc +.. autooldblock:: gnuradio.gr.single_pole_iir_filter_ff +.. autooldblock:: gnuradio.gr.moving_average_cc +.. autooldblock:: gnuradio.gr.moving_average_ff +.. autooldblock:: gnuradio.gr.moving_average_ii +.. autooldblock:: gnuradio.gr.moving_average_ss +.. autooldblock:: gnuradio.gr.pfb_arb_resampler_ccf +.. autooldblock:: gnuradio.gr.pfb_channelizer_ccf +.. autooldblock:: gnuradio.gr.pfb_clock_sync_ccf +.. autooldblock:: gnuradio.gr.pfb_clock_sync_fff +.. autooldblock:: gnuradio.gr.pfb_decimator_ccf +.. autooldblock:: gnuradio.gr.pfb_interpolator_ccf diff --git a/docs/sphinx/source/gr/filter_design.rst b/docs/sphinx/source/gr/filter_design.rst new file mode 100644 index 000000000..6ab23c50b --- /dev/null +++ b/docs/sphinx/source/gr/filter_design.rst @@ -0,0 +1,7 @@ +gnuradio.gr: Digital Filter Design +================================== + +.. autoclass:: gnuradio.gr.firdes + :members: + +.. autofunction:: gnuradio.gr.remez diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst new file mode 100644 index 000000000..3d32599f1 --- /dev/null +++ b/docs/sphinx/source/gr/index.rst @@ -0,0 +1,380 @@ +gnuradio.gr +=========== + +.. automodule:: gnuradio.gr + +Signal Processing Blocks +------------------------ + +Top Block and Hierarchical Block Base Classes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.top_block + gnuradio.gr.hier_block2 + +Signal Sources +^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.glfsr_source_b + gnuradio.gr.glfsr_source_f + gnuradio.gr.lfsr_32k_source_s + gnuradio.gr.null_source + gnuradio.gr.noise_source_c + gnuradio.gr.noise_source_f + gnuradio.gr.noise_source_i + gnuradio.gr.noise_source_s + gnuradio.gr.sig_source_c + gnuradio.gr.sig_source_f + gnuradio.gr.sig_source_i + gnuradio.gr.sig_source_s + gnuradio.gr.vector_source_b + gnuradio.gr.vector_source_c + gnuradio.gr.vector_source_f + gnuradio.gr.vector_source_i + gnuradio.gr.vector_source_s + gnuradio.gr.file_descriptor_source + gnuradio.gr.file_source + gnuradio.gr.message_source + gnuradio.gr.udp_source + gnuradio.gr.wavfile_source + +Signal Sinks +^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.bin_statistics_f + gnuradio.gr.check_counting_s + gnuradio.gr.check_lfsr_32k_s + gnuradio.gr.framer_sink_1 + gnuradio.gr.null_sink + gnuradio.gr.packet_sink + gnuradio.gr.probe_avg_mag_sqrd_c + gnuradio.gr.probe_avg_mag_sqrd_cf + gnuradio.gr.probe_avg_mag_sqrd_f + gnuradio.gr.probe_signal_f + gnuradio.gr.vector_sink_b + gnuradio.gr.vector_sink_c + gnuradio.gr.vector_sink_f + gnuradio.gr.vector_sink_i + gnuradio.gr.vector_sink_s + gnuradio.gr.file_descriptor_sink + gnuradio.gr.file_sink + gnuradio.gr.histo_sink_f + gnuradio.gr.message_sink + gnuradio.gr.oscope_sink_f + gnuradio.gr.udp_sink + gnuradio.gr.wavfile_sink + +Filters +^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.fft_filter_ccc + gnuradio.gr.fft_filter_fff + gnuradio.gr.filter_delay_fc + gnuradio.gr.fir_filter_ccc + gnuradio.gr.fir_filter_ccf + gnuradio.gr.fir_filter_fcc + gnuradio.gr.fir_filter_fff + gnuradio.gr.fir_filter_fsf + gnuradio.gr.fir_filter_scc + gnuradio.gr.fractional_interpolator_cc + gnuradio.gr.fractional_interpolator_ff + gnuradio.gr.freq_xlating_fir_filter_ccc + gnuradio.gr.freq_xlating_fir_filter_ccf + gnuradio.gr.freq_xlating_fir_filter_fcc + gnuradio.gr.freq_xlating_fir_filter_fcf + gnuradio.gr.freq_xlating_fir_filter_scc + gnuradio.gr.freq_xlating_fir_filter_scf + gnuradio.gr.hilbert_fc + gnuradio.gr.iir_filter_ffd + gnuradio.gr.interp_fir_filter_ccc + gnuradio.gr.interp_fir_filter_ccf + gnuradio.gr.interp_fir_filter_fcc + gnuradio.gr.interp_fir_filter_fff + gnuradio.gr.interp_fir_filter_fsf + gnuradio.gr.interp_fir_filter_scc + gnuradio.gr.rational_resampler_base_ccc + gnuradio.gr.rational_resampler_base_ccf + gnuradio.gr.rational_resampler_base_fcc + gnuradio.gr.rational_resampler_base_fff + gnuradio.gr.rational_resampler_base_fsf + gnuradio.gr.rational_resampler_base_scc + gnuradio.gr.single_pole_iir_filter_cc + gnuradio.gr.single_pole_iir_filter_ff + gnuradio.gr.moving_average_cc + gnuradio.gr.moving_average_ff + gnuradio.gr.moving_average_ii + gnuradio.gr.moving_average_ss + gnuradio.gr.pfb_arb_resampler_ccf + gnuradio.gr.pfb_channelizer_ccf + gnuradio.gr.pfb_clock_sync_ccf + gnuradio.gr.pfb_clock_sync_fff + gnuradio.gr.pfb_decimator_ccf + gnuradio.gr.pfb_interpolator_ccf + +Mathematics +^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.conjugate_cc + gnuradio.gr.nlog10_ff + gnuradio.gr.rms_cf + gnuradio.gr.rms_ff + gnuradio.gr.add_cc + gnuradio.gr.add_const_cc + gnuradio.gr.add_const_ff + gnuradio.gr.add_const_ii + gnuradio.gr.add_const_sf + gnuradio.gr.add_const_ss + gnuradio.gr.add_const_vcc + gnuradio.gr.add_const_vff + gnuradio.gr.add_const_vii + gnuradio.gr.add_const_vss + gnuradio.gr.add_ff + gnuradio.gr.add_ii + gnuradio.gr.add_ss + gnuradio.gr.and_bb + gnuradio.gr.and_const_bb + gnuradio.gr.and_const_ii + gnuradio.gr.and_const_ss + gnuradio.gr.and_ii + gnuradio.gr.and_ss + gnuradio.gr.divide_cc + gnuradio.gr.divide_ff + gnuradio.gr.divide_ii + gnuradio.gr.divide_ss + gnuradio.gr.integrate_cc + gnuradio.gr.integrate_ff + gnuradio.gr.integrate_ii + gnuradio.gr.integrate_ss + gnuradio.gr.multiply_cc + gnuradio.gr.multiply_const_cc + gnuradio.gr.multiply_const_ff + gnuradio.gr.multiply_const_ii + gnuradio.gr.multiply_const_ss + gnuradio.gr.multiply_const_vcc + gnuradio.gr.multiply_const_vff + gnuradio.gr.multiply_const_vii + gnuradio.gr.multiply_const_vss + gnuradio.gr.multiply_ff + gnuradio.gr.multiply_ii + gnuradio.gr.multiply_ss + gnuradio.gr.not_bb + gnuradio.gr.not_ii + gnuradio.gr.not_ss + gnuradio.gr.or_bb + gnuradio.gr.or_ii + gnuradio.gr.or_ss + gnuradio.gr.sub_cc + gnuradio.gr.sub_ff + gnuradio.gr.sub_ii + gnuradio.gr.sub_ss + gnuradio.gr.xor_bb + gnuradio.gr.xor_ii + gnuradio.gr.xor_ss + +Modulation +^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.cpfsk_bc + gnuradio.gr.frequency_modulator_fc + gnuradio.gr.phase_modulator_fc + +Demodulation +^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.quadrature_demod_cf + +Information Coding and Decoding +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.additive_scrambler_bb + gnuradio.gr.descrambler_bb + gnuradio.gr.diff_decoder_bb + gnuradio.gr.diff_encoder_bb + gnuradio.gr.fake_channel_encoder_pp + gnuradio.gr.fake_channel_decoder_pp + gnuradio.gr.map_bb + gnuradio.gr.scrambler_bb + +Synchronization +^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.pll_carriertracking_cc + gnuradio.gr.pll_freqdet_cf + gnuradio.gr.pll_refout_cc + gnuradio.gr.pn_correlator_cc + gnuradio.gr.simple_correlator + gnuradio.gr.simple_framer + +Type Conversions +^^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.bytes_to_syms + gnuradio.gr.char_to_float + gnuradio.gr.complex_to_interleaved_short + gnuradio.gr.complex_to_float + gnuradio.gr.complex_to_real + gnuradio.gr.complex_to_imag + gnuradio.gr.complex_to_mag + gnuradio.gr.complex_to_mag_squared + gnuradio.gr.complex_to_arg + gnuradio.gr.float_to_char + gnuradio.gr.float_to_complex + gnuradio.gr.float_to_short + gnuradio.gr.float_to_uchar + gnuradio.gr.interleaved_short_to_complex + gnuradio.gr.short_to_float + gnuradio.gr.uchar_to_float + gnuradio.gr.unpack_k_bits_bb + gnuradio.gr.chunks_to_symbols_bc + gnuradio.gr.chunks_to_symbols_bf + gnuradio.gr.chunks_to_symbols_ic + gnuradio.gr.chunks_to_symbols_if + gnuradio.gr.chunks_to_symbols_sc + gnuradio.gr.chunks_to_symbols_sf + gnuradio.gr.packed_to_unpacked_bb + gnuradio.gr.packed_to_unpacked_ii + gnuradio.gr.packed_to_unpacked_ss + gnuradio.gr.unpacked_to_packed_bb + gnuradio.gr.unpacked_to_packed_ii + gnuradio.gr.unpacked_to_packed_ss + +Signal Level Control (AGC) +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.agc2_cc + gnuradio.gr.agc2_ff + gnuradio.gr.agc_cc + gnuradio.gr.agc_ff + gnuradio.gr.ctcss_squelch_ff + gnuradio.gr.dpll_bb + gnuradio.gr.feedforward_agc_cc + gnuradio.gr.peak_detector2_fb + gnuradio.gr.pwr_squelch_cc + gnuradio.gr.pwr_squelch_ff + gnuradio.gr.regenerate_bb + gnuradio.gr.simple_squelch_cc + gnuradio.gr.mute_cc + gnuradio.gr.mute_ff + gnuradio.gr.mute_ii + gnuradio.gr.mute_ss + gnuradio.gr.peak_detector_fb + gnuradio.gr.peak_detector_ib + gnuradio.gr.peak_detector_sb + gnuradio.gr.sample_and_hold_bb + gnuradio.gr.sample_and_hold_ff + gnuradio.gr.sample_and_hold_ii + gnuradio.gr.sample_and_hold_ss + +Fourier Transform +^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.goertzel_fc + gnuradio.gr.fft_vcc + gnuradio.gr.fft_vfc + +Miscellaneous Blocks +^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.copy + gnuradio.gr.delay + gnuradio.gr.kludge_copy + gnuradio.gr.nop + gnuradio.gr.pa_2x2_phase_combiner + gnuradio.gr.repeat + gnuradio.gr.threshold_ff + gnuradio.gr.throttle + gnuradio.gr.channel_model + +Slicing and Dicing Streams +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :nosignatures: + + gnuradio.gr.deinterleave + gnuradio.gr.head + gnuradio.gr.interleave + gnuradio.gr.keep_one_in_n + gnuradio.gr.skiphead + gnuradio.gr.stream_to_streams + gnuradio.gr.stream_to_vector + gnuradio.gr.streams_to_stream + gnuradio.gr.streams_to_vector + gnuradio.gr.vector_to_stream + gnuradio.gr.vector_to_streams + +Digital Filter Design +--------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.gr.firdes + gnuradio.gr.remez + +Miscellaneous +------------- + +.. autosummary:: + :nosignatures: + + gnuradio.gr.feval_dd + gnuradio.gr.feval_cc + gnuradio.gr.feval_ll + gnuradio.gr.feval + gnuradio.gr.prefs + gnuradio.gr.test + gnuradio.gr.message + gnuradio.gr.msg_queue + gnuradio.gr.enable_realtime_scheduling + +Implementation Details +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.gr.block_detail + gnuradio.gr.buffer + gnuradio.gr.dispatcher + gnuradio.gr.single_threaded_scheduler + diff --git a/docs/sphinx/source/gr/internal.rst b/docs/sphinx/source/gr/internal.rst new file mode 100644 index 000000000..4948b38d4 --- /dev/null +++ b/docs/sphinx/source/gr/internal.rst @@ -0,0 +1,7 @@ +gnuradio.gr: Implementation Details +=================================== + +.. autofunction:: gnuradio.gr.block_detail +.. autofunction:: gnuradio.gr.buffer +.. autofunction:: gnuradio.gr.dispatcher +.. autofunction:: gnuradio.gr.single_threaded_scheduler diff --git a/docs/sphinx/source/gr/level_blk.rst b/docs/sphinx/source/gr/level_blk.rst new file mode 100644 index 000000000..d6c565c65 --- /dev/null +++ b/docs/sphinx/source/gr/level_blk.rst @@ -0,0 +1,26 @@ +gnuradio.gr: Signal Level Control (AGC) +======================================= + +.. autooldblock:: gnuradio.gr.agc2_cc +.. autooldblock:: gnuradio.gr.agc2_ff +.. autooldblock:: gnuradio.gr.agc_cc +.. autooldblock:: gnuradio.gr.agc_ff +.. autooldblock:: gnuradio.gr.ctcss_squelch_ff +.. autooldblock:: gnuradio.gr.dpll_bb +.. autooldblock:: gnuradio.gr.feedforward_agc_cc +.. autooldblock:: gnuradio.gr.peak_detector2_fb +.. autooldblock:: gnuradio.gr.pwr_squelch_cc +.. autooldblock:: gnuradio.gr.pwr_squelch_ff +.. autooldblock:: gnuradio.gr.regenerate_bb +.. autooldblock:: gnuradio.gr.simple_squelch_cc +.. autooldblock:: gnuradio.gr.mute_cc +.. autooldblock:: gnuradio.gr.mute_ff +.. autooldblock:: gnuradio.gr.mute_ii +.. autooldblock:: gnuradio.gr.mute_ss +.. autooldblock:: gnuradio.gr.peak_detector_fb +.. autooldblock:: gnuradio.gr.peak_detector_ib +.. autooldblock:: gnuradio.gr.peak_detector_sb +.. autooldblock:: gnuradio.gr.sample_and_hold_bb +.. autooldblock:: gnuradio.gr.sample_and_hold_ff +.. autooldblock:: gnuradio.gr.sample_and_hold_ii +.. autooldblock:: gnuradio.gr.sample_and_hold_ss diff --git a/docs/sphinx/source/gr/math_blk.rst b/docs/sphinx/source/gr/math_blk.rst new file mode 100644 index 000000000..7b9437f99 --- /dev/null +++ b/docs/sphinx/source/gr/math_blk.rst @@ -0,0 +1,59 @@ +gnuradio.gr: Mathematics +======================== + +.. autooldblock:: gnuradio.gr.conjugate_cc +.. autooldblock:: gnuradio.gr.nlog10_ff +.. autooldblock:: gnuradio.gr.rms_cf +.. autooldblock:: gnuradio.gr.rms_ff +.. autooldblock:: gnuradio.gr.add_cc +.. autooldblock:: gnuradio.gr.add_const_cc +.. autooldblock:: gnuradio.gr.add_const_ff +.. autooldblock:: gnuradio.gr.add_const_ii +.. autooldblock:: gnuradio.gr.add_const_sf +.. autooldblock:: gnuradio.gr.add_const_ss +.. autooldblock:: gnuradio.gr.add_const_vcc +.. autooldblock:: gnuradio.gr.add_const_vff +.. autooldblock:: gnuradio.gr.add_const_vii +.. autooldblock:: gnuradio.gr.add_const_vss +.. autooldblock:: gnuradio.gr.add_ff +.. autooldblock:: gnuradio.gr.add_ii +.. autooldblock:: gnuradio.gr.add_ss +.. autooldblock:: gnuradio.gr.and_bb +.. autooldblock:: gnuradio.gr.and_const_bb +.. autooldblock:: gnuradio.gr.and_const_ii +.. autooldblock:: gnuradio.gr.and_const_ss +.. autooldblock:: gnuradio.gr.and_ii +.. autooldblock:: gnuradio.gr.and_ss +.. autooldblock:: gnuradio.gr.divide_cc +.. autooldblock:: gnuradio.gr.divide_ff +.. autooldblock:: gnuradio.gr.divide_ii +.. autooldblock:: gnuradio.gr.divide_ss +.. autooldblock:: gnuradio.gr.integrate_cc +.. autooldblock:: gnuradio.gr.integrate_ff +.. autooldblock:: gnuradio.gr.integrate_ii +.. autooldblock:: gnuradio.gr.integrate_ss +.. autooldblock:: gnuradio.gr.multiply_cc +.. autooldblock:: gnuradio.gr.multiply_const_cc +.. autooldblock:: gnuradio.gr.multiply_const_ff +.. autooldblock:: gnuradio.gr.multiply_const_ii +.. autooldblock:: gnuradio.gr.multiply_const_ss +.. autooldblock:: gnuradio.gr.multiply_const_vcc +.. autooldblock:: gnuradio.gr.multiply_const_vff +.. autooldblock:: gnuradio.gr.multiply_const_vii +.. autooldblock:: gnuradio.gr.multiply_const_vss +.. autooldblock:: gnuradio.gr.multiply_ff +.. autooldblock:: gnuradio.gr.multiply_ii +.. autooldblock:: gnuradio.gr.multiply_ss +.. autooldblock:: gnuradio.gr.not_bb +.. autooldblock:: gnuradio.gr.not_ii +.. autooldblock:: gnuradio.gr.not_ss +.. autooldblock:: gnuradio.gr.or_bb +.. autooldblock:: gnuradio.gr.or_ii +.. autooldblock:: gnuradio.gr.or_ss +.. autooldblock:: gnuradio.gr.sub_cc +.. autooldblock:: gnuradio.gr.sub_ff +.. autooldblock:: gnuradio.gr.sub_ii +.. autooldblock:: gnuradio.gr.sub_ss +.. autooldblock:: gnuradio.gr.xor_bb +.. autooldblock:: gnuradio.gr.xor_ii +.. autooldblock:: gnuradio.gr.xor_ss diff --git a/docs/sphinx/source/gr/misc.rst b/docs/sphinx/source/gr/misc.rst new file mode 100644 index 000000000..b0a3f3ba1 --- /dev/null +++ b/docs/sphinx/source/gr/misc.rst @@ -0,0 +1,12 @@ +gnuradio.gr: Miscellaneous +========================== + +.. autofunction:: gnuradio.gr.feval_dd +.. autofunction:: gnuradio.gr.feval_cc +.. autofunction:: gnuradio.gr.feval_ll +.. autofunction:: gnuradio.gr.feval +.. autofunction:: gnuradio.gr.prefs +.. autofunction:: gnuradio.gr.test +.. autofunction:: gnuradio.gr.message +.. autofunction:: gnuradio.gr.msg_queue +.. autofunction:: gnuradio.gr.enable_realtime_scheduling diff --git a/docs/sphinx/source/gr/misc_blk.rst b/docs/sphinx/source/gr/misc_blk.rst new file mode 100644 index 000000000..c69293056 --- /dev/null +++ b/docs/sphinx/source/gr/misc_blk.rst @@ -0,0 +1,12 @@ +gnuradio.gr: Miscellaneous Blocks +================================= + +.. autooldblock:: gnuradio.gr.copy +.. autooldblock:: gnuradio.gr.delay +.. autooldblock:: gnuradio.gr.kludge_copy +.. autooldblock:: gnuradio.gr.nop +.. autooldblock:: gnuradio.gr.pa_2x2_phase_combiner +.. autooldblock:: gnuradio.gr.repeat +.. autooldblock:: gnuradio.gr.threshold_ff +.. autooldblock:: gnuradio.gr.throttle +.. autooldblock:: gnuradio.gr.channel_model diff --git a/docs/sphinx/source/gr/modulation_blk.rst b/docs/sphinx/source/gr/modulation_blk.rst new file mode 100644 index 000000000..1fff4614c --- /dev/null +++ b/docs/sphinx/source/gr/modulation_blk.rst @@ -0,0 +1,6 @@ +gnuradio.gr: Modulation +======================= + +.. autooldblock:: gnuradio.gr.cpfsk_bc +.. autooldblock:: gnuradio.gr.frequency_modulator_fc +.. autooldblock:: gnuradio.gr.phase_modulator_fc diff --git a/docs/sphinx/source/gr/sink_blk.rst b/docs/sphinx/source/gr/sink_blk.rst new file mode 100644 index 000000000..7608ff09b --- /dev/null +++ b/docs/sphinx/source/gr/sink_blk.rst @@ -0,0 +1,25 @@ +gnuradio.gr: Signal Sinks +========================= + +.. autooldblock:: gnuradio.gr.bin_statistics_f +.. autooldblock:: gnuradio.gr.check_counting_s +.. autooldblock:: gnuradio.gr.check_lfsr_32k_s +.. autooldblock:: gnuradio.gr.framer_sink_1 +.. autooldblock:: gnuradio.gr.null_sink +.. autooldblock:: gnuradio.gr.packet_sink +.. autooldblock:: gnuradio.gr.probe_avg_mag_sqrd_c +.. autooldblock:: gnuradio.gr.probe_avg_mag_sqrd_cf +.. autooldblock:: gnuradio.gr.probe_avg_mag_sqrd_f +.. autooldblock:: gnuradio.gr.probe_signal_f +.. autooldblock:: gnuradio.gr.vector_sink_b +.. autooldblock:: gnuradio.gr.vector_sink_c +.. autooldblock:: gnuradio.gr.vector_sink_f +.. autooldblock:: gnuradio.gr.vector_sink_i +.. autooldblock:: gnuradio.gr.vector_sink_s +.. autooldblock:: gnuradio.gr.file_descriptor_sink +.. autooldblock:: gnuradio.gr.file_sink +.. autooldblock:: gnuradio.gr.histo_sink_f +.. autooldblock:: gnuradio.gr.message_sink +.. autooldblock:: gnuradio.gr.oscope_sink_f +.. autooldblock:: gnuradio.gr.udp_sink +.. autooldblock:: gnuradio.gr.wavfile_sink diff --git a/docs/sphinx/source/gr/slicedice_blk.rst b/docs/sphinx/source/gr/slicedice_blk.rst new file mode 100644 index 000000000..e845627aa --- /dev/null +++ b/docs/sphinx/source/gr/slicedice_blk.rst @@ -0,0 +1,14 @@ +gnuradio.gr: Slicing and Dicing Streams +======================================= + +.. autooldblock:: gnuradio.gr.deinterleave +.. autooldblock:: gnuradio.gr.head +.. autooldblock:: gnuradio.gr.interleave +.. autooldblock:: gnuradio.gr.keep_one_in_n +.. autooldblock:: gnuradio.gr.skiphead +.. autooldblock:: gnuradio.gr.stream_to_streams +.. autooldblock:: gnuradio.gr.stream_to_vector +.. autooldblock:: gnuradio.gr.streams_to_stream +.. autooldblock:: gnuradio.gr.streams_to_vector +.. autooldblock:: gnuradio.gr.vector_to_stream +.. autooldblock:: gnuradio.gr.vector_to_streams diff --git a/docs/sphinx/source/gr/source_blk.rst b/docs/sphinx/source/gr/source_blk.rst new file mode 100644 index 000000000..df873bcf7 --- /dev/null +++ b/docs/sphinx/source/gr/source_blk.rst @@ -0,0 +1,26 @@ +gnuradio.gr: Signal Sources +=========================== + +.. autooldblock:: gnuradio.gr.glfsr_source_b +.. autooldblock:: gnuradio.gr.glfsr_source_f +.. autooldblock:: gnuradio.gr.lfsr_32k_source_s +.. autooldblock:: gnuradio.gr.null_source +.. autooldblock:: gnuradio.gr.noise_source_c +.. autooldblock:: gnuradio.gr.noise_source_f +.. autooldblock:: gnuradio.gr.noise_source_i +.. autooldblock:: gnuradio.gr.noise_source_s +.. autooldblock:: gnuradio.gr.sig_source_c +.. autooldblock:: gnuradio.gr.sig_source_f +.. autooldblock:: gnuradio.gr.sig_source_i +.. autooldblock:: gnuradio.gr.sig_source_s +.. autooldblock:: gnuradio.gr.vector_source_b +.. autooldblock:: gnuradio.gr.vector_source_c +.. autooldblock:: gnuradio.gr.vector_source_f +.. autooldblock:: gnuradio.gr.vector_source_i +.. autooldblock:: gnuradio.gr.vector_source_s +.. autooldblock:: gnuradio.gr.file_descriptor_source +.. autooldblock:: gnuradio.gr.file_source +.. autooldblock:: gnuradio.gr.message_source +.. autooldblock:: gnuradio.gr.udp_source +.. autooldblock:: gnuradio.gr.wavfile_source + diff --git a/docs/sphinx/source/gr/sync_blk.rst b/docs/sphinx/source/gr/sync_blk.rst new file mode 100644 index 000000000..be9f908f7 --- /dev/null +++ b/docs/sphinx/source/gr/sync_blk.rst @@ -0,0 +1,9 @@ +gnuradio.gr: Synchronization +============================ + +.. autooldblock:: gnuradio.gr.pll_carriertracking_cc +.. autooldblock:: gnuradio.gr.pll_freqdet_cf +.. autooldblock:: gnuradio.gr.pll_refout_cc +.. autooldblock:: gnuradio.gr.pn_correlator_cc +.. autooldblock:: gnuradio.gr.simple_correlator +.. autooldblock:: gnuradio.gr.simple_framer diff --git a/docs/sphinx/source/gr/top_block.rst b/docs/sphinx/source/gr/top_block.rst new file mode 100644 index 000000000..3d4e9ef3d --- /dev/null +++ b/docs/sphinx/source/gr/top_block.rst @@ -0,0 +1,7 @@ +gnuradio.gr: Top Block and Hierarchical Block Base Classes +========================================================== + +.. autoclass:: gnuradio.gr.top_block + +.. autoclass:: gnuradio.gr.hier_block2 + |