Communication
This module provides functionalities to transmit information in form of bits over a wireless link.
classDiagram
PilotWaveformGenerator <|-- OFDMWaveform
Serializable <|-- FMCWWaveform
Transmission <|-- CommunicationTransmission
Serializable <|-- FrameElement
IdealChannelEstimation <|-- OFDMIdealChannelEstimation
Serializable <|-- RootRaisedCosineWaveform
Serializable <|-- CorrelationSynchronization
TransmittingModem <|-- DuplexModem
FrameSection <|-- FrameGuardSection
WaveformGenerator <|-- PilotWaveformGenerator
CommunicationEvaluator <|-- FrameErrorEvaluator
SerializableEnum <|-- PrefixType
PilotSymbolSequence <|-- CustomPilotSymbolSequence
Serializable <|-- BitErrorEvaluator
BitsSource <|-- StreamBitsSource
RandomNode <|-- BaseModem
Serializable <|-- PilotSection
CorrelationSynchronization <|-- OFDMCorrelationSynchronization
SingleCarrierChannelEstimation <|-- SingleCarrierLeastSquaresChannelEstimation
SerializableEnum <|-- ElementType
OFDMSynchronization <|-- SchmidlCoxSynchronization
FrameSection <|-- FrameSymbolSection
Serializable <|-- SimplexLink
SingleCarrierChannelEqualization <|-- SingleCarrierMinimumMeanSquareChannelEqualization
Transmitter <|-- TransmittingModem
FilteredSingleCarrierWaveform <|-- RectangularWaveform
TransmittingModem <|-- SimplexLink
ChannelEqualization <|-- ZeroForcingChannelEqualization
Synchronization <|-- ChirpFSKSynchronization
IdealChannelEstimation <|-- SingleCarrierIdealChannelEstimation
ZeroForcingChannelEqualization <|-- SingleCarrierZeroForcingChannelEqualization
CommunicationEvaluator <|-- BlockErrorEvaluator
RolledOffSingleCarrierWaveform <|-- RaisedCosineWaveform
Serializable <|-- ChirpFSKWaveform
Serializable <|-- ThroughputEvaluator
ConfigurablePilotWaveform <|-- FilteredSingleCarrierWaveform
PilotSection <|-- SchmidlCoxPilotSection
Serializable <|-- FrameErrorEvaluator
Receiver <|-- ReceivingModem
Serializable <|-- OFDMLeastSquaresChannelEstimation
CorrelationSynchronization <|-- SingleCarrierCorrelationSynchronization
FrameSection <|-- PilotSection
SerializableEnum <|-- ReferencePosition
Synchronization <|-- CorrelationSynchronization
Serializable <|-- TransmittingModem
PilotWaveformGenerator <|-- ConfigurablePilotWaveform
Transmission <|-- CommunicationTransmissionFrame
Symbols <|-- StatedSymbols
HDFSerializable <|-- Symbols
Serializable <|-- ReceivingModem
Serializable <|-- OFDMIdealChannelEstimation
RolledOffSingleCarrierWaveform <|-- RootRaisedCosineWaveform
Serializable <|-- BlockErrorEvaluator
Serializable <|-- Synchronization
OFDMChannelEqualization <|-- OFDMMinimumMeanSquareChannelEqualization
FilteredSingleCarrierWaveform <|-- FMCWWaveform
Serializable <|-- ChannelEstimation
Serializable <|-- RandomBitsSource
ChannelEstimation <|-- IdealChannelEstimation
ReceivingModem <|-- DuplexModem
FrameErrorEvaluator <|-- ThroughputEvaluator
Serializable <|-- ChannelEqualization
ChannelEstimation <|-- OFDMLeastSquaresChannelEstimation
Serializable <|-- RaisedCosineWaveform
PilotSymbolSequence <|-- UniformPilotSymbolSequence
Serializable <|-- FrameGuardSection
CorrelationSynchronization <|-- ChirpFSKCorrelationSynchronization
PilotWaveformGenerator <|-- ChirpFSKWaveform
CustomPilotSymbolSequence <|-- MappedPilotSymbolSequence
Reception <|-- CommunicationReception
CommunicationEvaluator <|-- BitErrorEvaluator
Serializable <|-- ChirpFSKSynchronization
Serializable <|-- OFDMWaveform
ZeroForcingChannelEqualization <|-- OFDMZeroForcingChannelEqualization
BitsSource <|-- RandomBitsSource
Serializable <|-- FrameResource
Serializable <|-- RectangularWaveform
Serializable <|-- SingleCarrierIdealChannelEstimation
BaseModem <|-- TransmittingModem
ReceivingModem <|-- SimplexLink
Serializable <|-- ChirpFSKCorrelationSynchronization
Serializable <|-- FrameSymbolSection
BaseModem <|-- ReceivingModem
ChannelEqualization <|-- OFDMChannelEqualization
Serializable <|-- ZeroForcingChannelEqualization
Serializable <|-- StreamBitsSource
It consists of the base configuration classes for communication modems
- Modem
CommunicationTransmissionFrame
CommunicationTransmissionFrame.signal
CommunicationTransmissionFrame.bits
CommunicationTransmissionFrame.encoded_bits
CommunicationTransmissionFrame.symbols
CommunicationTransmissionFrame.encoded_symbols
CommunicationTransmissionFrame.timestamp
CommunicationTransmissionFrame.from_HDF()
CommunicationTransmissionFrame.to_HDF()
CommunicationTransmission
CommunicationReceptionFrame
CommunicationReceptionFrame.signal
CommunicationReceptionFrame.decoded_signal
CommunicationReceptionFrame.symbols
CommunicationReceptionFrame.decoded_symbols
CommunicationReceptionFrame.timestamp
CommunicationReceptionFrame.equalized_symbols
CommunicationReceptionFrame.encoded_bits
CommunicationReceptionFrame.decoded_bits
CommunicationReceptionFrame.csi
CommunicationReceptionFrame.from_HDF()
CommunicationReceptionFrame.to_HDF()
CommunicationReception
BaseModem
BaseModem.transmitting_device
BaseModem.receiving_device
BaseModem.num_transmit_streams
BaseModem.num_receive_streams
BaseModem.encoder_manager
BaseModem.waveform_generator
BaseModem.precoding
BaseModem.num_data_bits_per_frame
BaseModem.frame_duration
BaseModem.sampling_rate
BaseModem.noise_power()
BaseModem.csi
TransmittingModem
ReceivingModem
DuplexModem
SimplexLink
- Bit Source
BitsSource
RandomBitsSource
StreamBitsSource
- Communication Symbols
SymbolType
Symbol
Symbols
StatedSymbols
- Communication Waveform Base
Synchronization
ChannelEstimation
IdealChannelEstimation
ChannelEqualization
ZeroForcingChannelEqualization
WaveformGenerator
WaveformGenerator.symbol_type
WaveformGenerator.samples_in_frame
WaveformGenerator.oversampling_factor
WaveformGenerator.modulation_order
WaveformGenerator.bits_per_symbol
WaveformGenerator.bits_per_frame
WaveformGenerator.symbols_per_frame
WaveformGenerator.frame_duration
WaveformGenerator.bit_energy
WaveformGenerator.symbol_energy
WaveformGenerator.power
WaveformGenerator.map()
WaveformGenerator.unmap()
WaveformGenerator.modulate()
WaveformGenerator.demodulate()
WaveformGenerator.estimate_channel()
WaveformGenerator.equalize_symbols()
WaveformGenerator.bandwidth
WaveformGenerator.data_rate
WaveformGenerator.modem
WaveformGenerator.synchronization
WaveformGenerator.channel_estimation
WaveformGenerator.channel_equalization
WaveformGenerator.sampling_rate
WaveformGenerator.symbol_precoding_support
PilotWaveformGenerator
PilotSymbolSequence
UniformPilotSymbolSequence
CustomPilotSymbolSequence
MappedPilotSymbolSequence
ConfigurablePilotWaveform
- Communication Evaluators
CommunicationEvaluator
BitErrorArtifact
BitErrorEvaluation
BitErrorEvaluator
BlockErrorArtifact
BlockErrorEvaluation
BlockErrorEvaluator
FrameErrorArtifact
FrameErrorEvaluation
FrameErrorEvaluator
ThroughputArtifact
ThroughputEvaluation
ThroughputEvaluator
as well as multiple communication waveform implementations
- Filtered Single Carrier Waveforms
FilteredSingleCarrierWaveform
FilteredSingleCarrierWaveform.symbol_rate
FilteredSingleCarrierWaveform.num_preamble_symbols
FilteredSingleCarrierWaveform.num_postamble_symbols
FilteredSingleCarrierWaveform.modulation_order
FilteredSingleCarrierWaveform.pilot_signal
FilteredSingleCarrierWaveform.map()
FilteredSingleCarrierWaveform.unmap()
FilteredSingleCarrierWaveform.modulate()
FilteredSingleCarrierWaveform.demodulate()
FilteredSingleCarrierWaveform.num_pilot_samples
FilteredSingleCarrierWaveform.num_guard_samples
FilteredSingleCarrierWaveform.guard_interval
FilteredSingleCarrierWaveform.pilot_rate
FilteredSingleCarrierWaveform.num_data_symbols
FilteredSingleCarrierWaveform.samples_in_frame
FilteredSingleCarrierWaveform.bits_per_frame
FilteredSingleCarrierWaveform.symbols_per_frame
FilteredSingleCarrierWaveform.bit_energy
FilteredSingleCarrierWaveform.symbol_energy
FilteredSingleCarrierWaveform.power
FilteredSingleCarrierWaveform.sampling_rate
FilteredSingleCarrierWaveform.plot_filter_correlation()
FilteredSingleCarrierWaveform.plot_filter()
SingleCarrierSynchronization
SingleCarrierCorrelationSynchronization
SingleCarrierChannelEstimation
SingleCarrierIdealChannelEstimation
SingleCarrierLeastSquaresChannelEstimation
SingleCarrierChannelEqualization
SingleCarrierZeroForcingChannelEqualization
SingleCarrierMinimumMeanSquareChannelEqualization
RolledOffSingleCarrierWaveform
RootRaisedCosineWaveform
RaisedCosineWaveform
RectangularWaveform
FMCWWaveform
- Chirp Frequency Shift Keying
ChirpFSKWaveform
ChirpFSKWaveform.yaml_tag
ChirpFSKWaveform.symbol_type
ChirpFSKWaveform.frame_duration
ChirpFSKWaveform.chirp_duration
ChirpFSKWaveform.chirp_bandwidth
ChirpFSKWaveform.freq_difference
ChirpFSKWaveform.num_pilot_chirps
ChirpFSKWaveform.num_data_chirps
ChirpFSKWaveform.guard_interval
ChirpFSKWaveform.bits_per_symbol
ChirpFSKWaveform.bits_per_frame
ChirpFSKWaveform.symbols_per_frame
ChirpFSKWaveform.samples_in_chirp
ChirpFSKWaveform.chirps_in_frame
ChirpFSKWaveform.chirp_time
ChirpFSKWaveform.samples_in_frame
ChirpFSKWaveform.symbol_energy
ChirpFSKWaveform.bit_energy
ChirpFSKWaveform.map()
ChirpFSKWaveform.modulate()
ChirpFSKWaveform.demodulate()
ChirpFSKWaveform.unmap()
ChirpFSKWaveform.bandwidth
ChirpFSKWaveform.power
ChirpFSKWaveform.modulation_order
ChirpFSKWaveform.symbol_precoding_support
ChirpFSKWaveform.sampling_rate
ChirpFSKWaveform.pilot_signal
ChirpFSKSynchronization
ChirpFSKCorrelationSynchronization
- Orthogonal Frequency Division Multiplexing
ElementType
PrefixType
FrameElement
FrameResource
FrameSection
FrameSection.frame
FrameSection.num_repetitions
FrameSection.num_symbols
FrameSection.num_references
FrameSection.num_words
FrameSection.num_subcarriers
FrameSection.resource_mask
FrameSection.num_samples
FrameSection.place_symbols()
FrameSection.pick_symbols()
FrameSection.modulate()
FrameSection.demodulate()
FrameSymbolSection
FrameSymbolSection.yaml_tag
FrameSymbolSection.pattern
FrameSymbolSection.num_symbols
FrameSymbolSection.num_references
FrameSymbolSection.num_words
FrameSymbolSection.num_subcarriers
FrameSymbolSection.modulate()
FrameSymbolSection.demodulate()
FrameSymbolSection.resource_mask
FrameSymbolSection.num_samples
FrameGuardSection
OFDMWaveform
OFDMWaveform.yaml_tag
OFDMWaveform.dc_suppression
OFDMWaveform.resources
OFDMWaveform.structure
OFDMWaveform.modulation_order
OFDMWaveform.add_resource()
OFDMWaveform.add_section()
OFDMWaveform.pilot_section
OFDMWaveform.pilot_signal
OFDMWaveform.subcarrier_spacing
OFDMWaveform.symbols_per_frame
OFDMWaveform.words_per_frame
OFDMWaveform.references_per_frame
OFDMWaveform.frame_duration
OFDMWaveform.samples_in_frame
OFDMWaveform.map()
OFDMWaveform.unmap()
OFDMWaveform.modulate()
OFDMWaveform.demodulate()
OFDMWaveform.bandwidth
OFDMWaveform.reference_based_channel_estimation()
OFDMWaveform.bits_per_frame
OFDMWaveform.bit_energy
OFDMWaveform.symbol_energy
OFDMWaveform.power
OFDMWaveform.num_subcarriers
OFDMWaveform.sampling_rate
PilotSection
SchmidlCoxPilotSection
OFDMSynchronization
OFDMCorrelationSynchronization
SchmidlCoxSynchronization
ReferencePosition
OFDMIdealChannelEstimation
OFDMLeastSquaresChannelEstimation
OFDMChannelEqualization
OFDMZeroForcingChannelEqualization
OFDMMinimumMeanSquareChannelEqualization
- Correlation-Based Waveform Synchronization
PGT
CorrelationSynchronization