Skip to main content

SensorUplinkScenario

Communication scenarios · Implementation: mlsysim/engine/scenario_definitions/communication.py.

Construct this scenario with keyword inputs. The fields below show the types and defaults declared by this class.

streams raw video streams against a shared link, and the event records that replace them.

Notes

Equation: Use the dimensional products, ratios, or selection rules documented on the calculated properties below.

Assumptions: Raw video streams have equal shape and frame rate; event payload size and rate are supplied separately.

Excludes: The model does not claim that event-only data preserve all raw-video information or detection quality.

References

Derivation: the calculated properties below state their defining arithmetic and units. They are scenario accounting or input-selection rules, not independently measured relationships.

Examples

>>> from mlsysim import Scenarios
>>> case = Scenarios.FactoryCameras1080p
>>> str(case.stream_rate)
'186624000.0 B/s'

Attributes

Name Description
bytes_per_pixel
event_bandwidth Uplink rate when sending only the stated event records. Equation: event_size * | | [event_rate](#mlsysim.engine.scenario_types.SensorUplinkScenario.event_rate) | | | [event_reduction](#mlsysim.engine.scenario_types.SensorUplinkScenario.event_reduction) | Raw video rate divided by event-record rate. Equation:total_rate / event_bandwidth. | | [event_size](#mlsysim.engine.scenario_types.SensorUplinkScenario.event_size) | | | [frame_height](#mlsysim.engine.scenario_types.SensorUplinkScenario.frame_height) | | | [frame_rate](#mlsysim.engine.scenario_types.SensorUplinkScenario.frame_rate) | | | [frame_width](#mlsysim.engine.scenario_types.SensorUplinkScenario.frame_width) | | | [link_bandwidth](#mlsysim.engine.scenario_types.SensorUplinkScenario.link_bandwidth) | | | [link_shortfall](#mlsysim.engine.scenario_types.SensorUplinkScenario.link_shortfall) | Required raw-stream bandwidth relative to link capacity. Equation:total_rate /
stream_rate Raw byte rate of one uncompressed video stream. Equation: width times height times bytes
streams
total_rate Aggregate raw video uplink rate. Equation: streams * stream_rate. Units: bytes/s;

frame_width

Type: int.

Declared default: required.

frame_height

Type: int.

Declared default: required.

bytes_per_pixel

Type: Quantity.

Declared default: required.

frame_rate

Type: Quantity.

Declared default: required.

streams

Type: int.

Declared default: required.

event_size

Type: Quantity.

Declared default: required.

event_rate

Type: Quantity.

Declared default: required.

stream_rate

engine.scenario_types.SensorUplinkScenario.stream_rate

Raw byte rate of one uncompressed video stream. Equation: width times height times bytes per pixel times frame rate. Units: bytes/s; protocol framing and compression are excluded.

total_rate

engine.scenario_types.SensorUplinkScenario.total_rate

Aggregate raw video uplink rate. Equation: streams * stream_rate. Units: bytes/s; all streams operate continuously at the stated frame rate.

event_bandwidth

engine.scenario_types.SensorUplinkScenario.event_bandwidth

Uplink rate when sending only the stated event records. Equation: event_size * event_rate. Units: bytes/s; event detection quality and additional metadata are excluded.

event_reduction

engine.scenario_types.SensorUplinkScenario.event_reduction

Raw video rate divided by event-record rate. Equation: total_rate / event_bandwidth. Units: dimensionless; the two representations need not preserve equal information.

Back to top