diff options
Diffstat (limited to 'docs')
23 files changed, 219 insertions, 295 deletions
diff --git a/docs/doxygen/other/ctrlport.dox b/docs/doxygen/other/ctrlport.dox new file mode 100644 index 0000000000..17f5f0d467 --- /dev/null +++ b/docs/doxygen/other/ctrlport.dox @@ -0,0 +1,38 @@ +/*! \page page_filter filter Signal Processing Blocks + +\section Introduction + +This is the gr-ctroport package. It is a tool to create distributed +contol applications for GNU Radio. It provides blocks that can be +connected to an output stream to plot the signal remotely. It also +provides an API that allows blocks to export variables that can be +set, monitored, and plotted remotely. + +The Python namespace is in gnuradio.ctrlport, which would be normally +imported as: + +\code + from gnuradio import ctrlport +\endcode + + +See the Doxygen documentation for details about the blocks available +in this package. A quick listing of the details can be found in Python +after importing by using: + +\code + help(ctrlport) +\endcode + +\section Dependencies + +ControlPort requires ZeroC's ICE and associated +libraries/headers/programs. ICE is generally installed into the +standard paths if using a software repo (like apt-get, yum, etc.). If +installed by hand, GNU Radio assumes ICE is installed into +/opt/Ice-3.4.2. If this is not the case, you can tell GNU Radio where +to find ICE by passing to cmake the following: + + -DICE_MANUAL_INSTALL_PATH=<your path here> + +*/ diff --git a/docs/doxygen/other/main_page.dox b/docs/doxygen/other/main_page.dox index abdc21b0c9..681dea41c8 100644 --- a/docs/doxygen/other/main_page.dox +++ b/docs/doxygen/other/main_page.dox @@ -68,7 +68,7 @@ done. A single source and sink are used with a FIR filter between them. \code - from gnuradio import gr, filter + from gnuradio import gr, filter, analog class my_topblock(gr.top_block): def __init__(self): @@ -77,7 +77,7 @@ them. amp = 1 taps = filter.firdes.low_pass(1, 1, 0.1, 0.01) - self.src = gr.noise_source_c(gr.GR_GAUSSIAN, amp) + self.src = analog.noise_source_c(gr.GR_GAUSSIAN, amp) self.flt = filter.fir_filter_ccf(1, taps) self.snk = gr.null_sink(gr.sizeof_gr_complex) @@ -209,19 +209,19 @@ running and processing data, performing the reconfiguration, and then restarting the graph by unlocking it. The following example code shows a graph that first adds two -gr_noise_source_c blocks and then replaces the gr_add_cc block with a +analog::noise_source_c blocks and then replaces the gr_add_cc block with a gr_sub_cc block to then subtract the sources. \code -from gnuradio import gr +from gnuradio import gr, analog import time class mytb(gr.top_block): def __init__(self): gr.top_block.__init__(self) - self.src0 = gr.noise_source_c(gr.GR_GAUSSIAN, 1) - self.src1 = gr.noise_source_c(gr.GR_GAUSSIAN, 1) + self.src0 = analog.noise_source_c(gr.GR_GAUSSIAN, 1) + self.src1 = analog.noise_source_c(gr.GR_GAUSSIAN, 1) self.add = gr.add_cc() self.sub = gr.sub_cc() self.head = gr.head(gr.sizeof_gr_complex, 1000000) @@ -268,15 +268,15 @@ The following example expands the previous example but sets and resets the max noutput_items both locally and globally. \code -from gnuradio import gr +from gnuradio import gr, analog import time class mytb(gr.top_block): def __init__(self): gr.top_block.__init__(self) - self.src0 = gr.noise_source_c(gr.GR_GAUSSIAN, 1) - self.src1 = gr.noise_source_c(gr.GR_GAUSSIAN, 1) + self.src0 = analog.noise_source_c(gr.GR_GAUSSIAN, 1) + self.src1 = analog.noise_source_c(gr.GR_GAUSSIAN, 1) self.add = gr.add_cc() self.sub = gr.sub_cc() self.head = gr.head(gr.sizeof_gr_complex, 1000000) diff --git a/docs/doxygen/other/pfb_intro.dox b/docs/doxygen/other/pfb_intro.dox index 01d08b0fad..504ae87b87 100644 --- a/docs/doxygen/other/pfb_intro.dox +++ b/docs/doxygen/other/pfb_intro.dox @@ -64,9 +64,9 @@ defined to use a sample rate of \p filter_size times the signal's sampling rate. A helpful wrapper for the arbitrary resampler is found in -<b>gnuradio-core/src/python/gnuradio/blks2impl/pfb_arb_resampler.py</b>, -which is exposed in Python as <b>blks2.pfb_arb_resampler_ccf</b> and -<b>blks2.pfb_arb_resampler_fff</b>. This block is set up so that the +<b>gr-filter/python/pfb.py</b>, +which is exposed in Python as <b>filter.pfb.arb_resampler_ccf</b> and +<b>filter.pfb.arb_resampler_fff</b>. This block is set up so that the user only needs to pass it the real number \p rate as the resampling rate. With just this information, this hierarchical block automatically creates a filter that fully passes the signal bandwidth @@ -91,6 +91,6 @@ channels. NOTE: you need the Scipy and Matplotlib Python modules installed to run this example. -\include gnuradio-core/src/examples/pfb/channelize.py +\include gr-filter/examples/channelize.py */ diff --git a/docs/exploring-gnuradio/dial_tone.py b/docs/exploring-gnuradio/dial_tone.py index cabfa0864d..ba43c43bfc 100755 --- a/docs/exploring-gnuradio/dial_tone.py +++ b/docs/exploring-gnuradio/dial_tone.py @@ -1,6 +1,6 @@ #!/usr/bin/env python # -# Copyright 2004,2007 Free Software Foundation, Inc. +# Copyright 2004,2007,2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # @@ -22,22 +22,23 @@ from gnuradio import gr from gnuradio import audio +from gnuradio import analog -def build_graph (): +def build_graph(): sampling_freq = 32000 ampl = 0.1 - tb = gr.top_block () - src0 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 350, ampl) - src1 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 440, ampl) - dst = audio.sink (sampling_freq) - tb.connect (src0, (dst, 0)) - tb.connect (src1, (dst, 1)) + tb = gr.top_block() + src0 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 350, ampl) + src1 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 440, ampl) + dst = audio.sink(sampling_freq) + tb.connect(src0, (dst, 0)) + tb.connect(src1, (dst, 1)) return tb if __name__ == '__main__': - tb = build_graph () - tb.start () - raw_input ('Press Enter to quit: ') - tb.stop () + tb = build_graph() + tb.start() + raw_input('Press Enter to quit: ') + tb.stop() diff --git a/docs/exploring-gnuradio/dial_tone_example.xml b/docs/exploring-gnuradio/dial_tone_example.xml index 14ea68039e..5d193df776 100644 --- a/docs/exploring-gnuradio/dial_tone_example.xml +++ b/docs/exploring-gnuradio/dial_tone_example.xml @@ -5,24 +5,25 @@ from gnuradio import gr from gnuradio import audio +from gnuradio import analog def build_graph (): sampling_freq = 48000 ampl = 0.1 - fg = gr.flow_graph () - src0 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 350, ampl) - src1 = gr.sig_source_f (sampling_freq, gr.GR_SIN_WAVE, 440, ampl) - dst = audio.sink (sampling_freq) - fg.connect ((src0, 0), (dst, 0)) - fg.connect ((src1, 0), (dst, 1)) + fg = gr.flow_graph() + src0 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 350, ampl) + src1 = analog.sig_source_f(sampling_freq, analog.GR_SIN_WAVE, 440, ampl) + dst = audio.sink(sampling_freq) + fg.connect((src0, 0), (dst, 0)) + fg.connect((src1, 0), (dst, 1)) return fg if __name__ == '__main__': - fg = build_graph () - fg.start () - raw_input ('Press Enter to quit: ') - fg.stop () + fg = build_graph() + fg.start() + raw_input('Press Enter to quit: ') + fg.stop() </programlisting> </example> diff --git a/docs/exploring-gnuradio/exploring-gnuradio.xml b/docs/exploring-gnuradio/exploring-gnuradio.xml index 286ca86095..5b70d4d0bf 100644 --- a/docs/exploring-gnuradio/exploring-gnuradio.xml +++ b/docs/exploring-gnuradio/exploring-gnuradio.xml @@ -180,7 +180,7 @@ right.</para> <para>We start by creating a flow graph to hold the blocks and connections between them. The two sine waves are generated by the -gr.sig_source_f calls. The f suffix indicates that the source produces +analog.sig_source_f calls. The f suffix indicates that the source produces floats. One sine wave is at 350 Hz, and the other is at 440 Hz. Together, they sound like the US dial tone.</para> diff --git a/docs/exploring-gnuradio/fm_demod.py b/docs/exploring-gnuradio/fm_demod.py index 0071fd751e..7b19cd826a 100755 --- a/docs/exploring-gnuradio/fm_demod.py +++ b/docs/exploring-gnuradio/fm_demod.py @@ -1,18 +1,19 @@ #!/usr/bin/env python from gnuradio import gr +from gnuradio import analog from gnuradio import audio from gnuradio import mc4020 import sys -def high_speed_adc (fg, input_rate): +def high_speed_adc(fg, input_rate): # return gr.file_source (gr.sizeof_short, "dummy.dat", False) - return mc4020.source (input_rate, mc4020.MCC_CH3_EN | mc4020.MCC_ALL_1V) + return mc4020.source(input_rate, mc4020.MCC_CH3_EN | mc4020.MCC_ALL_1V) # # return a gr.flow_graph # -def build_graph (freq1, freq2): +def build_graph(freq1, freq2): input_rate = 20e6 cfir_decimation = 125 audio_decimation = 5 @@ -20,35 +21,35 @@ def build_graph (freq1, freq2): quad_rate = input_rate / cfir_decimation audio_rate = quad_rate / audio_decimation - fg = gr.flow_graph () + fg = gr.flow_graph() # use high speed ADC as input source - src = high_speed_adc (fg, input_rate) + src = high_speed_adc(fg, input_rate) # compute FIR filter taps for channel selection channel_coeffs = \ - gr.firdes.low_pass (1.0, # gain - input_rate, # sampling rate - 250e3, # low pass cutoff freq - 8*100e3, # width of trans. band - gr.firdes.WIN_HAMMING) + filter.firdes.low_pass(1.0, # gain + input_rate, # sampling rate + 250e3, # low pass cutoff freq + 8*100e3, # width of trans. band + filter.firdes.WIN_HAMMING) # input: short; output: complex chan_filter1 = \ - gr.freq_xlating_fir_filter_scf (cfir_decimation, - channel_coeffs, - freq1, # 1st station freq - input_rate) + filter.freq_xlating_fir_filter_scf(cfir_decimation, + channel_coeffs, + freq1, # 1st station freq + input_rate) - (head1, tail1) = build_pipeline (fg, quad_rate, audio_decimation) + (head1, tail1) = build_pipeline(fg, quad_rate, audio_decimation) # sound card as final sink - audio_sink = audio.sink (int (audio_rate)) + audio_sink = audio.sink(int (audio_rate)) # now wire it all together - fg.connect (src, chan_filter1) - fg.connect (chan_filter1, head1) - fg.connect (tail1, (audio_sink, 0)) + fg.connect(src, chan_filter1) + fg.connect(chan_filter1, head1) + fg.connect(tail1, (audio_sink, 0)) # two stations at once? if freq2: @@ -57,20 +58,20 @@ def build_graph (freq1, freq2): # input: short; output: complex chan_filter2 = \ - gr.freq_xlating_fir_filter_scf (cfir_decimation, - channel_coeffs, - freq2, # 2nd station freq - input_rate) + filter.freq_xlating_fir_filter_scf(cfir_decimation, + channel_coeffs, + freq2, # 2nd station freq + input_rate) - (head2, tail2) = build_pipeline (fg, quad_rate, audio_decimation) + (head2, tail2) = build_pipeline(fg, quad_rate, audio_decimation) - fg.connect (src, chan_filter2) - fg.connect (chan_filter2, head2) - fg.connect (tail2, (audio_sink, 1)) + fg.connect(src, chan_filter2) + fg.connect(chan_filter2, head2) + fg.connect(tail2, (audio_sink, 1)) return fg -def build_pipeline (fg, quad_rate, audio_decimation): +def build_pipeline(fg, quad_rate, audio_decimation): '''Given a flow_graph, fg, construct a pipeline for demodulating a broadcast FM signal. The input is the downconverteed complex baseband @@ -84,67 +85,67 @@ def build_pipeline (fg, quad_rate, audio_decimation): volume = 1.0 # input: complex; output: float - fm_demod = gr.quadrature_demod_cf (volume*fm_demod_gain) + fm_demod = analog.quadrature_demod_cf(volume*fm_demod_gain) # compute FIR filter taps for audio filter width_of_transition_band = audio_rate / 32 - audio_coeffs = gr.firdes.low_pass (1.0, # gain - quad_rate, # sampling rate - audio_rate/2 - width_of_transition_band, - width_of_transition_band, - gr.firdes.WIN_HAMMING) + audio_coeffs = filter.firdes.low_pass(1.0, # gain + quad_rate, # sampling rate + audio_rate/2 - width_of_transition_band, + width_of_transition_band, + filter.firdes.WIN_HAMMING) # input: float; output: float - audio_filter = gr.fir_filter_fff (audio_decimation, audio_coeffs) + audio_filter = filter.fir_filter_fff(audio_decimation, audiocoeffs) - fg.connect (fm_demod, audio_filter) + fg.connect(fm_demod, audio_filter) return ((fm_demod, 0), (audio_filter, 0)) -def main (args): - nargs = len (args) +def main(args): + nargs = len(args) if nargs == 1: - freq1 = float (args[0]) * 1e6 + freq1 = float(args[0]) * 1e6 freq2 = None elif nargs == 2: - freq1 = float (args[0]) * 1e6 - freq2 = float (args[1]) * 1e6 + freq1 = float(args[0]) * 1e6 + freq2 = float(args[1]) * 1e6 else: - sys.stderr.write ('usage: fm_demod freq1 [freq2]\n') - sys.exit (1) + sys.stderr.write('usage: fm_demod freq1 [freq2]\n') + sys.exit(1) # connect to RF front end - rf_front_end = gr.microtune_4937_eval_board () - if not rf_front_end.board_present_p (): + rf_front_end = gr.microtune_4937_eval_board() + if not rf_front_end.board_present_p(): raise IOError, 'RF front end not found' # set front end gain - rf_front_end.set_AGC (300) - IF_freq = rf_front_end.get_output_freq () + rf_front_end.set_AGC(300) + IF_freq = rf_front_end.get_output_freq() IF_freq = 5.75e6 if not freq2: # one station - rf_front_end.set_RF_freq (freq1) - fg = build_graph (IF_freq, None) + rf_front_end.set_RF_freq(freq1) + fg = build_graph(IF_freq, None) else: # two stations - if abs (freq1 - freq2) > 5.5e6: + if abs(freq1 - freq2) > 5.5e6: raise IOError, 'freqs too far apart' target_freq = (freq1 + freq2) / 2 - actual_freq = rf_front_end.set_RF_freq (target_freq) + actual_freq = rf_front_end.set_RF_freq(target_freq) #actual_freq = target_freq - fg = build_graph (IF_freq + freq1 - actual_freq, - IF_freq + freq2 - actual_freq) + fg = build_graph(IF_freq + freq1 - actual_freq, + IF_freq + freq2 - actual_freq) - fg.start () # fork thread(s) and return - raw_input ('Press Enter to quit: ') - fg.stop () + fg.start() # fork thread(s) and return + raw_input('Press Enter to quit: ') + fg.stop() if __name__ == '__main__': - main (sys.argv[1:]) + main(sys.argv[1:]) diff --git a/docs/exploring-gnuradio/fm_demod_example.xml b/docs/exploring-gnuradio/fm_demod_example.xml index b417da0a81..05c2ee163b 100644 --- a/docs/exploring-gnuradio/fm_demod_example.xml +++ b/docs/exploring-gnuradio/fm_demod_example.xml @@ -4,6 +4,8 @@ #!/usr/bin/env python from gnuradio import gr +from gnuradio import filter +from gnuradio import analog from gnuradio import audio from gnuradio import mc4020 import sys @@ -30,28 +32,28 @@ def build_graph (freq1, freq2): # compute FIR filter taps for channel selection channel_coeffs = \ - gr.firdes.low_pass (1.0, # gain - input_rate, # sampling rate - 250e3, # low pass cutoff freq - 8*100e3, # width of trans. band - gr.firdes.WIN_HAMMING) + filter.firdes.low_pass(1.0, # gain + input_rate, # sampling rate + 250e3, # low pass cutoff freq + 8*100e3, # width of trans. band + filter.firdes.WIN_HAMMING) # input: short; output: complex chan_filter1 = \ - gr.freq_xlating_fir_filter_scf (cfir_decimation, - channel_coeffs, - freq1, # 1st station freq - input_rate) + filter.freq_xlating_fir_filter_scf(cfir_decimation, + channel_coeffs, + freq1, # 1st station freq + input_rate) - (head1, tail1) = build_pipeline (fg, quad_rate, audio_decimation) + (head1, tail1) = build_pipeline(fg, quad_rate, audio_decimation) # sound card as final sink - audio_sink = audio.sink (int (audio_rate)) + audio_sink = audio.sink(int (audio_rate)) # now wire it all together - fg.connect (src, chan_filter1) - fg.connect (chan_filter1, head1) - fg.connect (tail1, (audio_sink, 0)) + fg.connect(src, chan_filter1) + fg.connect(chan_filter1, head1) + fg.connect(tail1, (audio_sink, 0)) return fg @@ -69,20 +71,20 @@ def build_pipeline (fg, quad_rate, audio_decimation): volume = 1.0 # input: complex; output: float - fm_demod = gr.quadrature_demod_cf (volume*fm_demod_gain) + fm_demod = analog.quadrature_demod_cf(volume*fm_demod_gain) # compute FIR filter taps for audio filter width_of_transition_band = audio_rate / 32 - audio_coeffs = gr.firdes.low_pass (1.0, # gain - quad_rate, # sampling rate - audio_rate/2 - width_of_transition_band, - width_of_transition_band, - gr.firdes.WIN_HAMMING) + audio_coeffs = filter.firdes.low_pass(1.0, # gain + quad_rate, # sampling rate + audio_rate/2 - width_of_transition_band, + width_of_transition_band, + filter.firdes.WIN_HAMMING) # input: float; output: float - audio_filter = gr.fir_filter_fff (audio_decimation, audio_coeffs) + audio_filter = filter.fir_filter_fff(audio_decimation, audio_coeffs) - fg.connect (fm_demod, audio_filter) + fg.connect(fm_demod, audio_filter) return ((fm_demod, 0), (audio_filter, 0)) @@ -90,34 +92,34 @@ def main (args): nargs = len (args) if nargs == 1: # get station frequency from command line - freq1 = float (args[0]) * 1e6 + freq1 = float(args[0]) * 1e6 else: - sys.stderr.write ('usage: fm_demod freq\n') - sys.exit (1) + sys.stderr.write('usage: fm_demod freq\n') + sys.exit(1) # connect to RF front end - rf_front_end = gr.microtune_4937_eval_board () - if not rf_front_end.board_present_p (): + rf_front_end = gr.microtune_4937_eval_board() + if not rf_front_end.board_present_p(): raise IOError, 'RF front end not found' # set front end gain - rf_front_end.set_AGC (300) + rf_front_end.set_AGC(300) # determine the front end's "Intermediate Frequency" - IF_freq = rf_front_end.get_output_freq () # 5.75e6 + IF_freq = rf_front_end.get_output_freq() # 5.75e6 # Tell the front end to tune to freq1. # I.e., freq1 is translated down to the IF frequency - rf_front_end.set_RF_freq (freq1) + rf_front_end.set_RF_freq(freq1) # build the flow graph - fg = build_graph (IF_freq, None) + fg = build_graph(IF_freq, None) - fg.start () # fork thread(s) and return - raw_input ('Press Enter to quit: ') - fg.stop () + fg.start() # fork thread(s) and return + raw_input('Press Enter to quit: ') + fg.stop() if __name__ == '__main__': - main (sys.argv[1:]) + main(sys.argv[1:]) </programlisting> </example> diff --git a/docs/sphinx/source/blks2/blks.rst b/docs/sphinx/source/blks2/blks.rst index c28c7af0f8..6510169710 100644 --- a/docs/sphinx/source/blks2/blks.rst +++ b/docs/sphinx/source/blks2/blks.rst @@ -1,31 +1,9 @@ gnuradio.blks2: Signal Processing Blocks ======================================== -.. autopyblock:: gnuradio.blks2.am_demod_cf -.. autopyblock:: gnuradio.blks2.ctcss_gen_f -.. autopyblock:: gnuradio.blks2.demod_10k0a3e_cf -.. autopyblock:: gnuradio.blks2.demod_200kf3e_cf -.. autopyblock:: gnuradio.blks2.demod_20k0f3e_cf -.. autopyblock:: gnuradio.blks2.fm_demod_cf -.. autopyblock:: gnuradio.blks2.logpwrfft_c -.. autopyblock:: gnuradio.blks2.logpwrfft_f -.. autopyblock:: gnuradio.blks2.pfb_arb_resampler_ccf -.. autopyblock:: gnuradio.blks2.pfb_arb_resampler_fff -.. autopyblock:: gnuradio.blks2.pfb_channelizer_ccf -.. autopyblock:: gnuradio.blks2.pfb_decimator_ccf -.. autopyblock:: gnuradio.blks2.pfb_interpolator_ccf .. autopyblock:: gnuradio.blks2.rational_resampler_ccc .. autopyblock:: gnuradio.blks2.rational_resampler_ccf .. autopyblock:: gnuradio.blks2.rational_resampler_fff .. autopyblock:: gnuradio.blks2.analysis_filterbank -.. autopyblock:: gnuradio.blks2.fm_deemph -.. autopyblock:: gnuradio.blks2.fm_preemph -.. autopyblock:: gnuradio.blks2.nbfm_rx -.. autopyblock:: gnuradio.blks2.nbfm_tx .. autopyblock:: gnuradio.blks2.stream_to_vector_decimator -.. autopyblock:: gnuradio.blks2.standard_squelch .. autopyblock:: gnuradio.blks2.synthesis_filterbank -.. autopyblock:: gnuradio.blks2.wfm_rcv -.. autopyblock:: gnuradio.blks2.wfm_rcv_fmdet -.. autopyblock:: gnuradio.blks2.wfm_rcv_pll -.. autopyblock:: gnuradio.blks2.wfm_tx diff --git a/docs/sphinx/source/blks2/index.rst b/docs/sphinx/source/blks2/index.rst index 4df8e5a796..7a911d001b 100644 --- a/docs/sphinx/source/blks2/index.rst +++ b/docs/sphinx/source/blks2/index.rst @@ -8,35 +8,13 @@ Signal Processing Blocks .. autosummary:: :nosignatures: - - gnuradio.blks2.am_demod_cf - gnuradio.blks2.ctcss_gen_f - gnuradio.blks2.demod_10k0a3e_cf - gnuradio.blks2.demod_200kf3e_cf - gnuradio.blks2.demod_20k0f3e_cf - gnuradio.blks2.fm_demod_cf - gnuradio.blks2.logpwrfft_c - gnuradio.blks2.logpwrfft_f - gnuradio.blks2.pfb_arb_resampler_ccf - gnuradio.blks2.pfb_arb_resampler_fff - gnuradio.blks2.pfb_channelizer_ccf - gnuradio.blks2.pfb_decimator_ccf - gnuradio.blks2.pfb_interpolator_ccf + gnuradio.blks2.rational_resampler_ccc gnuradio.blks2.rational_resampler_ccf gnuradio.blks2.rational_resampler_fff gnuradio.blks2.analysis_filterbank - gnuradio.blks2.fm_deemph - gnuradio.blks2.fm_preemph - gnuradio.blks2.nbfm_rx - gnuradio.blks2.nbfm_tx gnuradio.blks2.stream_to_vector_decimator - gnuradio.blks2.standard_squelch gnuradio.blks2.synthesis_filterbank - gnuradio.blks2.wfm_rcv - gnuradio.blks2.wfm_rcv_fmdet - gnuradio.blks2.wfm_rcv_pll - gnuradio.blks2.wfm_tx Utility Functions ----------------- diff --git a/docs/sphinx/source/digital/blocks.rst b/docs/sphinx/source/digital/blocks.rst index 68ec8dad1c..32eb25608b 100644 --- a/docs/sphinx/source/digital/blocks.rst +++ b/docs/sphinx/source/digital/blocks.rst @@ -17,6 +17,25 @@ gnuradio.digital: Signal Processing Blocks .. autooldblock:: gnuradio.digital.gmskmod_bc .. autooldblock:: gnuradio.digital.probe_mpsk_snr_est_c .. autooldblock:: gnuradio.digital.cpmmod_bc +.. autooldblock:: gnuradio.digital.glfsr_source_b +.. autooldblock:: gnuradio.digital.glfsr_source_f +.. autooldblock:: gnuradio.digital.framer_sink_1 +.. autooldblock:: gnuradio.digital.framer_sink_1 +.. autooldblock:: gnuradio.digital.additive_scrambler_bb +.. autooldblock:: gnuradio.digital.descrambler_bb +.. autooldblock:: gnuradio.digital.diff_decoder_bb +.. autooldblock:: gnuradio.digital.diff_encoder_bb +.. autooldblock:: gnuradio.digital.map_bb +.. autooldblock:: gnuradio.digital.scrambler_bb +.. autooldblock:: gnuradio.digital.pn_correlator_cc +.. autooldblock:: gnuradio.digital.simple_framer +.. autooldblock:: gnuradio.digital.bytes_to_syms +.. autooldblock:: gnuradio.digital.chunks_to_symbols_bc +.. autooldblock:: gnuradio.digital.chunks_to_symbols_bf +.. autooldblock:: gnuradio.digital.chunks_to_symbols_ic +.. autooldblock:: gnuradio.digital.chunks_to_symbols_if +.. autooldblock:: gnuradio.digital.chunks_to_symbols_sc +.. autooldblock:: gnuradio.digital.chunks_to_symbols_sf .. autopyblock:: gnuradio.digital.generic_demod .. autopyblock:: gnuradio.digital.generic_mod .. autopyblock:: gnuradio.digital.bpsk.dbpsk_demod diff --git a/docs/sphinx/source/digital/index.rst b/docs/sphinx/source/digital/index.rst index da5227e455..14c84fe4bb 100644 --- a/docs/sphinx/source/digital/index.rst +++ b/docs/sphinx/source/digital/index.rst @@ -25,6 +25,24 @@ Signal Processing Blocks gnuradio.digital.gmskmod_bc gnuradio.digital.probe_mpsk_snr_est_c gnuradio.digital.cpmmod_bc + gnuradio.digital.glfsr_source_b + gnuradio.digital.glfsr_source_f + gnuradio.digital.framer_sink_1 + gnuradio.digital.additive_scrambler_bb + gnuradio.digital.descrambler_bb + gnuradio.digital.diff_decoder_bb + gnuradio.digital.diff_encoder_bb + gnuradio.digital.map_bb + gnuradio.digital.scrambler_bb + gnuradio.digital.pn_correlator_cc + gnuradio.digital.simple_framer + gnuradio.digital.bytes_to_syms + gnuradio.digital.chunks_to_symbols_bc + gnuradio.digital.chunks_to_symbols_bf + gnuradio.digital.chunks_to_symbols_ic + gnuradio.digital.chunks_to_symbols_if + gnuradio.digital.chunks_to_symbols_sc + gnuradio.digital.chunks_to_symbols_sf gnuradio.digital.generic_demod gnuradio.digital.generic_mod gnuradio.digital.bpsk.dbpsk_demod @@ -83,8 +101,6 @@ Modulation Utilties :nosignatures: gnuradio.digital.utils.gray_code.gray_code - gnuradio.digital.utils.mod_codes.GRAY_CODE - gnuradio.digital.utils.mod_codes.NO_CODE gnuradio.digital.modulation_utils.add_type_1_constellation gnuradio.digital.modulation_utils.add_type_1_demod gnuradio.digital.modulation_utils.add_type_1_mod @@ -92,6 +108,9 @@ Modulation Utilties gnuradio.digital.modulation_utils.type_1_demods gnuradio.digital.modulation_utils.type_1_mods +.. gnuradio.digital.utils.mod_codes.GRAY_CODE +.. gnuradio.digital.utils.mod_codes.NO_CODE + Packet Utilities ---------------- diff --git a/docs/sphinx/source/gr/coding_blk.rst b/docs/sphinx/source/gr/coding_blk.rst index e50b990bcd..da8cacf2b4 100644 --- a/docs/sphinx/source/gr/coding_blk.rst +++ b/docs/sphinx/source/gr/coding_blk.rst @@ -1,11 +1,5 @@ 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 index 790109a94f..4ae469c2ac 100644 --- a/docs/sphinx/source/gr/converter_blk.rst +++ b/docs/sphinx/source/gr/converter_blk.rst @@ -1,7 +1,6 @@ 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 @@ -18,12 +17,6 @@ gnuradio.gr: Type Conversions .. 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 diff --git a/docs/sphinx/source/gr/demodulation_blk.rst b/docs/sphinx/source/gr/demodulation_blk.rst deleted file mode 100644 index 4f800b642b..0000000000 --- a/docs/sphinx/source/gr/demodulation_blk.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.gr: Demodulation -========================= - -.. autooldblock:: gnuradio.gr.quadrature_demod_cf diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst index 3d32599f1d..ec4671d545 100644 --- a/docs/sphinx/source/gr/index.rst +++ b/docs/sphinx/source/gr/index.rst @@ -21,18 +21,8 @@ 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 @@ -53,12 +43,7 @@ Signal Sinks 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 @@ -186,38 +171,14 @@ Mathematics 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 ^^^^^^^^^^^^^^^ @@ -225,12 +186,7 @@ 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 ^^^^^^^^^^^^^^^^ @@ -238,7 +194,6 @@ 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 @@ -255,12 +210,6 @@ Type Conversions 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 @@ -274,18 +223,8 @@ 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 diff --git a/docs/sphinx/source/gr/level_blk.rst b/docs/sphinx/source/gr/level_blk.rst index d6c565c65d..0eacb67230 100644 --- a/docs/sphinx/source/gr/level_blk.rst +++ b/docs/sphinx/source/gr/level_blk.rst @@ -1,18 +1,9 @@ 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 diff --git a/docs/sphinx/source/gr/modulation_blk.rst b/docs/sphinx/source/gr/modulation_blk.rst deleted file mode 100644 index 1fff4614ca..0000000000 --- a/docs/sphinx/source/gr/modulation_blk.rst +++ /dev/null @@ -1,6 +0,0 @@ -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 index 7608ff09b0..5e396d895a 100644 --- a/docs/sphinx/source/gr/sink_blk.rst +++ b/docs/sphinx/source/gr/sink_blk.rst @@ -4,12 +4,7 @@ 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 diff --git a/docs/sphinx/source/gr/source_blk.rst b/docs/sphinx/source/gr/source_blk.rst index df873bcf74..8e9f67980c 100644 --- a/docs/sphinx/source/gr/source_blk.rst +++ b/docs/sphinx/source/gr/source_blk.rst @@ -1,18 +1,8 @@ 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 diff --git a/docs/sphinx/source/gr/sync_blk.rst b/docs/sphinx/source/gr/sync_blk.rst index be9f908f73..d5e3c3d7c5 100644 --- a/docs/sphinx/source/gr/sync_blk.rst +++ b/docs/sphinx/source/gr/sync_blk.rst @@ -1,9 +1,4 @@ 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/qtgui/index.rst b/docs/sphinx/source/qtgui/index.rst index 83bdedca89..c6311d381a 100644 --- a/docs/sphinx/source/qtgui/index.rst +++ b/docs/sphinx/source/qtgui/index.rst @@ -3,7 +3,7 @@ gnuradio.qtgui .. automodule:: gnuradio.qtgui -.. autooldblock:: gnuradio.qtgui.sink_c -.. autooldblock:: gnuradio.qtgui.sink_f -.. autooldblock:: gnuradio.qtgui.time_sink_c -.. autooldblock:: gnuradio.qtgui.time_sink_f +.. autoblock:: gnuradio.qtgui.sink_c +.. autoblock:: gnuradio.qtgui.sink_f +.. autoblock:: gnuradio.qtgui.time_sink_c +.. autoblock:: gnuradio.qtgui.time_sink_f diff --git a/docs/sphinx/source/wavelet.rst b/docs/sphinx/source/wavelet.rst index 5236c4dbb2..679bab70c0 100644 --- a/docs/sphinx/source/wavelet.rst +++ b/docs/sphinx/source/wavelet.rst @@ -3,6 +3,6 @@ gnuradio.wavelet .. automodule:: gnuradio.wavelet -.. autooldblock:: gnuradio.wavelet.squash_ff -.. autooldblock:: gnuradio.wavelet.wavelet_ff -.. autooldblock:: gnuradio.wavelet.wvps_ff +.. autoblock:: gnuradio.wavelet.squash_ff +.. autoblock:: gnuradio.wavelet.wavelet_ff +.. autoblock:: gnuradio.wavelet.wvps_ff |