Communication Evaluator

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

class CommunicationEvaluator(transmitting_modem, receiving_modem, confidence=1.0, tolerance=0.0, min_num_samples=1024, plot_scale='log', tick_format=ValueType.LIN, plot_surface=True)

Bases: ScalarEvaluator, Serializable

Base class for evaluating communication processes between two modems.

Parameters:

• transmitting_modem (TransmittingModem) – Communication modem transmitting information.

• receiving_modem (ReceivingModem) – Communication modem receiving information.

• confidence (float) – Required confidence level for the given tolerance between zero and one.

• tolerance (float) – Acceptable non-negative bound around the mean value of the estimated scalar performance indicator.

• min_num_samples (int) – Minimum number of samples required to compute the confidence bound.

• plot_scale (str) – Scale of the plot. Can be 'linear' or 'log'.

• tick_format (ValueType) – Tick format of the plot.

• plot_surface (bool) – Enable surface plotting for two-dimensional grids. Enabled by default.

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:

CommunicationEvaluator

Returns:

The deserialized object.

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

property receiving_modem: ReceivingModem

Communication modem receiving information.

property transmitting_modem: TransmittingModem

Communication modem transmitting information.

class ErrorEvaluation(evaluation)

Bases: EvaluationTemplate[ndarray, StemVisualization], ABC

Base class for error evaluations between two modems exchanging information.

Parameters:

evaluation (TypeVar(ET, bound= object)) – The represented evaluation.