Communication Evaluator¶

Communication evaluators are the common base class of all evaluators estimating performance metrics of communication systems.

class CommunicationEvaluator(transmitting_modem, receiving_modem, plot_surface=True)[source]¶

Base class for evaluating communication processes between two modems.

Parameters:

transmitting_modem (TransmittingModem) – Communication modem transmitting information.
receiving_modem (ReceivingModem) – Communication modem receiving information.
plot_surface (bool) – Plot the surface of the evaluation result in two-dimensional grids. Defaults to True.

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:: CommunicationEvaluator
Returns:: The deserialized object.

generate_result(grid, artifacts)[source]¶

Generates an evaluation result from the artifacts collected over the whole simulation grid.

Parameters:

grid (Sequence[GridDimension]) – The Simulation grid.
artifacts (ndarray) – Numpy object array whose dimensions represent grid dimensions.

Return type:

ScalarEvaluationResult

Returns: The evaluation result.

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 receiving_modem: ReceivingModem¶: Communication modem receiving information.

property transmitting_modem: TransmittingModem¶: Communication modem transmitting information.

class ErrorEvaluation(evaluation)[source]¶

Base class for error evaluations between two modems exchanging information.