NetworkSim.simulation.tools.publication
.plot_delay¶
-
NetworkSim.simulation.tools.publication.
plot_delay
(simulator, delay='td', span='e', metrics=['mean'], analytical=True, semilog=True)[source]¶ Plot delay statistics of a ParallelSimulator.
- Parameters
simulator (ParallelSimulator) – The simulator used.
delay (str, optional) – The type of delay to be plotted, by default
td
, chosen from the following:- qd, queueing delay or queueing
The overall queueing delay.
- td, transfer delay or transfer
The transfer delay.
span (str, optional) – The time span of the delay statistics in the simulation, by default
extended
, chosen from the following:- overall or all
The entire duration of the simulation.
- final batch or fb
The statistics from the final batch when simulation converges.
- extended or e
The extended period of the simulation.
metrics (list, optional) – A list of the metric(s) of delay statistics, by default
mean
, chosen from the following:- mean
Mean delay statistics.
- min
Minimum delay statistics.
- max
Maximum delay statistics.
analytical (bool, optional) – If analytical results are plotted, by default True
semilog (bool, optional) – If to plot data on a semi-logarithmic scale
- Returns
fig – The figure plotted.
- Return type
Figure