Bit Sources

Bit sources represent, as the title suggest, a source of (hard) communication bits to be transmitted over a modem. They are one of the default configuration parameters of a TransmittingModem.

Every bit source implementation is expected to inherit from the BitsSource base class, which in turn represents a random node. There are currently two basic types of bit sources available:

• RandomBitsSource instances implement a random stream of bits

• StreamBitsSource instances implement a deterministic stream of bits

class BitsSource(seed=None)

Bases: RandomNode, Serializable

Base Class for Arbitrary Streams of Communication Bits.

Inheriting classes are required to implement the generate_bits() routine.

Parameters:

seed (int | None) – Seed used to initialize the pseudo-random number generator.

abstract generate_bits(num_bits)

Generate a new sequence of bits.

Parameters:

num_bits (int) – Number of bits to be generated.

Return type:

ndarray

Returns: A numpy vector of num_bits generated bits.

class RandomBitsSource(seed=None)

Bases: BitsSource

Bit stream generator for pseudo-random sequences of bits.

Parameters:

seed (int | None) – Seed used to initialize the pseudo-random number generator.

classmethod Deserialize(process)

Deserialize an object’s state.

Objects cannot be deserialized directly, instead a Factory must be instructed to carry out the deserialization process.

Parameters:

process (DeserializationProcess) – The current stage of the deserialization process. This object is generated by the Factory and provides an interface to deserialization methods supporting multiple backends.

Return type:

RandomBitsSource

Returns:

The deserialized object.

generate_bits(num_bits)

Generate a new sequence of bits.

Parameters:

num_bits (int) – Number of bits to be generated.

Return type:

ndarray

Returns: A numpy vector of num_bits generated bits.

serialize(process)

Serialize this object’s state.

Objects cannot be serialized directly, instead a Factory must be instructed to carry out the serialization process.

Parameters:

process (SerializationProcess) – The current stage of the serialization process. This object is generated by the Factory and provides an interface to serialization methods supporting multiple backends.

Return type:

None

class StreamBitsSource(path)

Bases: BitsSource, Serializable

Bit-stream generator mapping representing file system streams as bit sources.

Parameters:

path (str) – Path to the stream bits source.

classmethod Deserialize(process)

Deserialize an object’s state.

Objects cannot be deserialized directly, instead a Factory must be instructed to carry out the deserialization process.

Parameters:

process (DeserializationProcess) – The current stage of the deserialization process. This object is generated by the Factory and provides an interface to deserialization methods supporting multiple backends.

Return type:

StreamBitsSource

Returns:

The deserialized object.

generate_bits(num_bits)

Generate a new sequence of bits.

Parameters:

num_bits (int) – Number of bits to be generated.

Return type:

ndarray

Returns: A numpy vector of num_bits generated bits.

serialize(process)

Serialize this object’s state.

Objects cannot be serialized directly, instead a Factory must be instructed to carry out the serialization process.

Parameters:

process (SerializationProcess) – The current stage of the serialization process. This object is generated by the Factory and provides an interface to serialization methods supporting multiple backends.

Return type:

None