Noise Model

Inheritance diagram of hermespy.simulation.rf.noise.model.NoiseModel, hermespy.simulation.rf.noise.model.AWGN, hermespy.simulation.rf.noise.model.NoiseRealization, hermespy.simulation.rf.noise.model.AWGNRealization
class NoiseModel(seed=None)[source]

Bases: Serializable, RandomNode, Generic[NRT]

Noise modeling base class.

Parameters:

seed (int | None) – Random seed for initializating the pseud-random number generator.

add_noise(signal, power)[source]

Add noise to a signal model.

Parameters:
  • signal (TypeVar(ST, bound= Signal)) – The signal to which the noise should be added.

  • power (float) – Power of the added noise in Watt.

Return type:

TypeVar(ST, bound= Signal)

Returns: Signal model with added noise.

abstract realize(power)[source]

Realize the noise model.

Parameters:

power (float) – Power of the added noise in Watt.

Return type:

TypeVar(NRT, bound= NoiseRealization)

Returns: Noise model realization.

class AWGN(seed=None)[source]

Bases: NoiseModel[AWGNRealization]

Additive White Gaussian Noise.

Parameters:

seed (int | None) – Random seed for initializating the pseud-random number generator.

classmethod Deserialize(process)[source]

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:

AWGN

Returns:

The deserialized object.

realize(power)[source]

Realize the noise model.

Parameters:

power (float) – Power of the added noise in Watt.

Return type:

AWGNRealization

Returns: Noise model realization.

serialize(process)[source]

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 NoiseRealization(power, seed)[source]

Bases: RandomRealization

Realization of a noise model

Parameters:
  • power (float) – Power indicator of the noise model.

  • seed (int) – Seed for the random number generator.

classmethod Deserialize(process)[source]

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:

NoiseRealization

Returns:

The deserialized object.

abstract add_to(signal)[source]
Parameters:

signal (TypeVar(ST, bound= Signal)) – The signal to which the noise should be added.

Return type:

TypeVar(ST, bound= Signal)

Returns:

Signal model with added noise.

serialize(process)[source]

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

property power: float[source]

Power of the noise realization.

Returns: Power in Watt.

class AWGNRealization(power, seed)[source]

Bases: NoiseRealization

Realization of additive white Gaussian noise

Parameters:
  • power (float) – Power indicator of the noise model.

  • seed (int) – Seed for the random number generator.

add_to(signal)[source]
Parameters:

signal (TypeVar(ST, bound= Signal)) – The signal to which the noise should be added.

Return type:

TypeVar(ST, bound= Signal)

Returns:

Signal model with added noise.

class NRT[source]

Type of noise realization

alias of TypeVar(‘NRT’, bound=NoiseRealization)