summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/digital.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sphinx/source/digital.rst')
-rw-r--r--docs/sphinx/source/digital.rst116
1 files changed, 116 insertions, 0 deletions
diff --git a/docs/sphinx/source/digital.rst b/docs/sphinx/source/digital.rst
new file mode 100644
index 0000000000..e15c9166d9
--- /dev/null
+++ b/docs/sphinx/source/digital.rst
@@ -0,0 +1,116 @@
+gnuradio.digital
+================
+
+.. autoclass:: gnuradio.digital.constellation
+.. autoclass:: gnuradio.digital.lfsr
+.. autoclass:: gnuradio.digital.mpsk_snr_est
+.. autoclass:: gnuradio.digital.simple_framer
+.. autoclass:: gnuradio.digital.bpsk_mod
+.. autoclass:: gnuradio.digital.bpsk_demod
+.. autoclass:: gnuradio.digital.dbpsk_mod
+.. autoclass:: gnuradio.digital.dbpsk_demod
+.. autofunction:: gnuradio.digital.crc32
+.. autofunction:: gnuradio.digital.update_crc32
+.. autofunction:: gnuradio.digital.constellation_map_generator
+.. autoclass:: gnuradio.digital.cpm_mod
+.. autofunction:: gnuradio.digital.gen_and_append_crc32
+.. autofunction:: gnuradio.digital.check_crc32
+.. autoclass:: gnuradio.digital.generic_mod
+.. autoclass:: gnuradio.digital.generic_demod
+.. autoclass:: gnuradio.digital.gfsk_mod
+.. autoclass:: gnuradio.digital.gfsk_demod
+.. autoclass:: gnuradio.digital.gmsk_mod
+.. autoclass:: gnuradio.digital.gmsk_demod
+.. autofunction:: gnuradio.digital.type_1_mods
+.. autofunction:: gnuradio.digital.add_type_1_mod
+.. autofunction:: gnuradio.digital.type_1_demods
+.. autofunction:: gnuradio.digital.add_type_1_demod
+.. autofunction:: gnuradio.digital.type_1_constellations
+.. autofunction:: gnuradio.digital.add_type_1_constellation
+.. autofunction:: gnuradio.digital.extract_kwargs_from_options
+.. autofunction:: gnuradio.digital.extract_kwargs_from_options_for_class
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_packed_binary_string_to_1_0_string
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_1_0_string_to_packed_binary_string
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.is_1_0_string
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.string_to_hex_list
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.whiten
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.dewhiten
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_header
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_packet
+.. autofunction:: gnuradio.digital.ofdm_packet_utils.unmake_packet
+.. autoclass:: gnuradio.digital.ofdm_mod
+.. autoclass:: gnuradio.digital.ofdm_demod
+.. autoclass:: gnuradio.digital.ofdm_receiver
+.. autoclass:: gnuradio.digital.ofdm_sync_fixed
+.. autoclass:: gnuradio.digital.ofdm_sync_ml
+.. autoclass:: gnuradio.digital.ofdm_sync_pnac
+.. autoclass:: gnuradio.digital.ofdm_sync_pn
+.. autoclass:: gnuradio.digital.ofdm_tx
+.. autoclass:: gnuradio.digital.ofdm_rx
+.. autofunction:: gnuradio.digital.packet_utils.conv_packed_binary_string_to_1_0_string
+.. autofunction:: gnuradio.digital.packet_utils.conv_1_0_string_to_packed_binary_string
+.. autofunction:: gnuradio.digital.packet_utils.is_1_0_string
+.. autofunction:: gnuradio.digital.packet_utils.string_to_hex_list
+.. autofunction:: gnuradio.digital.packet_utils.whiten
+.. autofunction:: gnuradio.digital.packet_utils.dewhiten
+.. autofunction:: gnuradio.digital.packet_utils.make_header
+.. autofunction:: gnuradio.digital.packet_utils.make_packet
+.. autofunction:: gnuradio.digital.packet_utils.unmake_packet
+.. autoclass:: gnuradio.digital.mod_pkts
+.. autoclass:: gnuradio.digital.demod_pkts
+.. autofunction:: gnuradio.digital.psk_2_0x0
+.. autofunction:: gnuradio.digital.psk_2_0x1
+.. autofunction:: gnuradio.digital.sd_psk_2_0x0
+.. autofunction:: gnuradio.digital.sd_psk_2_0x1
+.. autofunction:: gnuradio.digital.psk_4_0x0_0_1
+.. autofunction:: gnuradio.digital.psk_4_0x1_0_1
+.. autofunction:: gnuradio.digital.psk_4_0x2_0_1
+.. autofunction:: gnuradio.digital.psk_4_0x3_0_1
+.. autofunction:: gnuradio.digital.psk_4_0x0_1_0
+.. autofunction:: gnuradio.digital.psk_4_0x1_1_0
+.. autofunction:: gnuradio.digital.psk_4_0x2_1_0
+.. autofunction:: gnuradio.digital.psk_4_0x3_1_0
+.. autofunction:: gnuradio.digital.sd_psk_4_0x0_0_1
+.. autofunction:: gnuradio.digital.sd_psk_4_0x1_0_1
+.. autofunction:: gnuradio.digital.sd_psk_4_0x2_0_1
+.. autofunction:: gnuradio.digital.sd_psk_4_0x3_0_1
+.. autofunction:: gnuradio.digital.sd_psk_4_0x0_1_0
+.. autofunction:: gnuradio.digital.sd_psk_4_0x1_1_0
+.. autofunction:: gnuradio.digital.sd_psk_4_0x2_1_0
+.. autofunction:: gnuradio.digital.sd_psk_4_0x3_1_0
+.. autofunction:: gnuradio.digital.psk_constellation
+.. autoclass:: gnuradio.digital.psk_mod
+.. autoclass:: gnuradio.digital.psk_demod
+.. autofunction:: gnuradio.digital.qam_16_0x0_0_1_2_3
+.. autofunction:: gnuradio.digital.qam_16_0x1_0_1_2_3
+.. autofunction:: gnuradio.digital.qam_16_0x2_0_1_2_3
+.. autofunction:: gnuradio.digital.qam_16_0x3_0_1_2_3
+.. autofunction:: gnuradio.digital.qam_16_0x0_1_0_2_3
+.. autofunction:: gnuradio.digital.qam_16_0x1_1_0_2_3
+.. autofunction:: gnuradio.digital.qam_16_0x2_1_0_2_3
+.. autofunction:: gnuradio.digital.qam_16_0x3_1_0_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x0_0_1_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x1_0_1_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x2_0_1_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x3_0_1_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x0_1_0_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x1_1_0_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x2_1_0_2_3
+.. autofunction:: gnuradio.digital.sd_qam_16_0x3_1_0_2_3
+.. autofunction:: gnuradio.digital.qam32_holeinside_constellation
+.. autofunction:: gnuradio.digital.make_differential_constellation
+.. autofunction:: gnuradio.digital.make_non_differential_constellation
+.. autofunction:: gnuradio.digital.qam_constellation
+.. autoclass:: gnuradio.digital.qam_mod
+.. autoclass:: gnuradio.digital.qam_demod
+.. autofunction:: gnuradio.digital.qpsk_constellation
+.. autoclass:: gnuradio.digital.qpsk_mod
+.. autoclass:: gnuradio.digital.qpsk_demod
+.. autofunction:: gnuradio.digital.dqpsk_constellation
+.. autoclass:: gnuradio.digital.dqpsk_mod
+.. autoclass:: gnuradio.digital.dqpsk_demod
+.. autofunction:: gnuradio.digital.soft_dec_table_generator
+.. autofunction:: gnuradio.digital.soft_dec_table
+.. autofunction:: gnuradio.digital.calc_soft_dec_from_table
+.. autofunction:: gnuradio.digital.calc_soft_dec
+.. autofunction:: gnuradio.digital.show_table