diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/doxygen/other/main_page.dox | 27 | ||||
-rw-r--r-- | docs/sphinx/source/blks2/blks.rst | 9 | ||||
-rw-r--r-- | docs/sphinx/source/blks2/index.rst | 25 | ||||
-rw-r--r-- | docs/sphinx/source/blks2/utilities.rst | 4 | ||||
-rw-r--r-- | docs/sphinx/source/gr/converter_blk.rst | 8 | ||||
-rw-r--r-- | docs/sphinx/source/gr/filter_design.rst | 7 | ||||
-rw-r--r-- | docs/sphinx/source/gr/index.rst | 73 | ||||
-rw-r--r-- | docs/sphinx/source/gr/math_blk.rst | 54 | ||||
-rw-r--r-- | docs/sphinx/source/gr/misc_blk.rst | 1 | ||||
-rw-r--r-- | docs/sphinx/source/gr/slicedice_blk.rst | 9 | ||||
-rw-r--r-- | docs/sphinx/source/index.rst | 6 |
11 files changed, 15 insertions, 208 deletions
diff --git a/docs/doxygen/other/main_page.dox b/docs/doxygen/other/main_page.dox index 681dea41c8..59ee96d7f9 100644 --- a/docs/doxygen/other/main_page.dox +++ b/docs/doxygen/other/main_page.dox @@ -201,7 +201,7 @@ buffer, which may be different than what was initially specified. It is possible to reconfigure the flowgraph at runtime. The reconfiguration is meant for changes in the flowgraph structure, not individual parameter settings of the blocks. For example, changing the -constant in a gr_add_const_cc block can be done while the flowgraph is +constant in a gr::blocks::add_const_cc block can be done while the flowgraph is running using the 'set_k(k)' method. Reconfiguration is done by locking the flowgraph, which stops it from @@ -209,21 +209,22 @@ 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 -analog::noise_source_c blocks and then replaces the gr_add_cc block with a -gr_sub_cc block to then subtract the sources. +gr::analog::noise_source_c blocks and then replaces the +gr::blocks::add_cc block with a gr::blocks::sub_cc block to then +subtract the sources. \code -from gnuradio import gr, analog +from gnuradio import gr, analog, blocks import time class mytb(gr.top_block): def __init__(self): gr.top_block.__init__(self) - 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.src0 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.src1 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.add = blocks.add_cc() + self.sub = blocks.sub_cc() self.head = gr.head(gr.sizeof_gr_complex, 1000000) self.snk = gr.file_sink(gr.sizeof_gr_complex, "output.32fc") @@ -268,17 +269,17 @@ The following example expands the previous example but sets and resets the max noutput_items both locally and globally. \code -from gnuradio import gr, analog +from gnuradio import gr, analog, blocks import time class mytb(gr.top_block): def __init__(self): gr.top_block.__init__(self) - 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.src0 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.src1 = analog.noise_source_c(analog.GR_GAUSSIAN, 1) + self.add = blocks.add_cc() + self.sub = blocks.sub_cc() self.head = gr.head(gr.sizeof_gr_complex, 1000000) self.snk = gr.file_sink(gr.sizeof_gr_complex, "output.32fc") diff --git a/docs/sphinx/source/blks2/blks.rst b/docs/sphinx/source/blks2/blks.rst deleted file mode 100644 index 6510169710..0000000000 --- a/docs/sphinx/source/blks2/blks.rst +++ /dev/null @@ -1,9 +0,0 @@ -gnuradio.blks2: Signal Processing Blocks -======================================== - -.. 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.stream_to_vector_decimator -.. autopyblock:: gnuradio.blks2.synthesis_filterbank diff --git a/docs/sphinx/source/blks2/index.rst b/docs/sphinx/source/blks2/index.rst deleted file mode 100644 index 7a911d001b..0000000000 --- a/docs/sphinx/source/blks2/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -gnuradio.blks2 -============== - -.. automodule:: gnuradio.blks2 - -Signal Processing Blocks ------------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blks2.rational_resampler_ccc - gnuradio.blks2.rational_resampler_ccf - gnuradio.blks2.rational_resampler_fff - gnuradio.blks2.analysis_filterbank - gnuradio.blks2.stream_to_vector_decimator - gnuradio.blks2.synthesis_filterbank - -Utility Functions ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blks2.design_filter diff --git a/docs/sphinx/source/blks2/utilities.rst b/docs/sphinx/source/blks2/utilities.rst deleted file mode 100644 index 3ce068fb41..0000000000 --- a/docs/sphinx/source/blks2/utilities.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.blks2: Utility Functions -================================= - -.. autoclass:: gnuradio.blks2.design_filter diff --git a/docs/sphinx/source/gr/converter_blk.rst b/docs/sphinx/source/gr/converter_blk.rst index 4ae469c2ac..98cfcfee9f 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.char_to_float .. autooldblock:: gnuradio.gr.complex_to_interleaved_short .. autooldblock:: gnuradio.gr.complex_to_float .. autooldblock:: gnuradio.gr.complex_to_real @@ -9,13 +8,6 @@ gnuradio.gr: Type Conversions .. 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.packed_to_unpacked_bb .. autooldblock:: gnuradio.gr.packed_to_unpacked_ii diff --git a/docs/sphinx/source/gr/filter_design.rst b/docs/sphinx/source/gr/filter_design.rst deleted file mode 100644 index 6ab23c50bf..0000000000 --- a/docs/sphinx/source/gr/filter_design.rst +++ /dev/null @@ -1,7 +0,0 @@ -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 index ec4671d545..6d09b861ef 100644 --- a/docs/sphinx/source/gr/index.rst +++ b/docs/sphinx/source/gr/index.rst @@ -114,62 +114,9 @@ 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 + Information Coding and Decoding ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -194,7 +141,6 @@ Type Conversions .. autosummary:: :nosignatures: - gnuradio.gr.char_to_float gnuradio.gr.complex_to_interleaved_short gnuradio.gr.complex_to_float gnuradio.gr.complex_to_real @@ -202,13 +148,6 @@ Type Conversions 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.packed_to_unpacked_bb gnuradio.gr.packed_to_unpacked_ii @@ -258,7 +197,6 @@ Miscellaneous Blocks 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 @@ -269,17 +207,8 @@ 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 --------------------- diff --git a/docs/sphinx/source/gr/math_blk.rst b/docs/sphinx/source/gr/math_blk.rst index 7b9437f995..208318def2 100644 --- a/docs/sphinx/source/gr/math_blk.rst +++ b/docs/sphinx/source/gr/math_blk.rst @@ -1,59 +1,5 @@ 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_blk.rst b/docs/sphinx/source/gr/misc_blk.rst index c69293056c..56bcb7fbde 100644 --- a/docs/sphinx/source/gr/misc_blk.rst +++ b/docs/sphinx/source/gr/misc_blk.rst @@ -6,7 +6,6 @@ gnuradio.gr: Miscellaneous Blocks .. 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/slicedice_blk.rst b/docs/sphinx/source/gr/slicedice_blk.rst index e845627aad..9ade1667d5 100644 --- a/docs/sphinx/source/gr/slicedice_blk.rst +++ b/docs/sphinx/source/gr/slicedice_blk.rst @@ -1,14 +1,5 @@ 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/index.rst b/docs/sphinx/source/index.rst index 38d859aafd..988b6554c5 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -11,13 +11,10 @@ Core Framework gnuradio.gr gnuradio.digital - gnuradio.blks2 gnuradio.audio gnuradio.trellis gnuradio.wavelet gnuradio.fft - gnuradio.window - gnuradio.optfir gnuradio.gr_unittest gnuradio.qtgui gnuradio.wxgui @@ -27,14 +24,11 @@ Core Framework gnuradio.gr <gr/index> gnuradio.digital <digital/index> - gnuradio.blks2 <blks2/index> gnuradio.audio <audio/index> gnuradio.gr_unittest <gr_unittest/index> - gnuradio.optfir <optfir/index> gnuradio.trellis <trellis/index> gnuradio.wavelet <wavelet> gnuradio.fft <fft> - gnuradio.window <window/index> gnuradio.qtgui <qtgui/index> gnuradio.wxgui <wxgui/index> |