openworld_radio_twin.antennas#

Antennas of a compiled scene: acquired from a source, selected, placed and recorded.

The Python loader, the web service and dataset generation all call scene_antennas(), so a scene’s antennas are the same wherever they are requested. Each result is also written into the scene directory under antennas/ as the record of what the scene’s transmitters were taken from; the compiled geometry does not change.

A Sionna run simulates one downlink channel: scene.frequency is its centre and scene.bandwidth its width. A channel is a downlink range an antenna registers, and an antenna transmits on it when it registers a downlink range that contains it, at its own power.

Functions

area_antennas(provider, latitude, longitude, ...)

Antennas inside a square on the map, completed with defaults but not placed.

as_channel(value)

A channel given as a range, a {"low_mhz", "high_mhz"} mapping or (low, high).

downlink_channels(antennas)

The distinct downlink and TDD ranges the antennas register, lowest first, each with the antennas that transmit on it.

load_antenna_source(path)

Read records written by write_antenna_source(), with the query that chose them and the channels of the scene's radio maps.

load_scene_antennas(directory, *[, ...])

scene_antennas() with a provider of its own when the caller has none.

scene_antennas(directory, provider, *[, ...])

Acquire, place and select the antennas inside a compiled scene, and record them.

select_antennas(result, *[, operator, radio])

Keep the antennas of one operator (PLMN or name) and radio technology.

select_channel(result, channel)

Keep the antennas that transmit on channel: those registering a downlink or TDD range that contains it, whatever operator or technology, at their own power.

summarize_antennas(antennas)

Operators, radios and downlink channels present among antennas.

transmitter_config(antenna, *, ...)

A placed antenna as a transmitter of a simulation request, with its provenance.

write_antenna_record(directory, result, query)

Write the selection into antennas/ and list it in scene_info.json.

write_antenna_source(path, result, query, ...)

Persist a dataset scene's selected source records, before any placement, with the channels its radio maps draw from.

Classes

SceneAntennas(result, operators, radios, ...)

Selected antennas of a scene or map area, with the operators and radios it holds; record is the file written into a compiled scene, None for a map area.

class openworld_radio_twin.antennas.SceneAntennas(result, operators, radios, defaults, record)[source]#

Bases: object

Selected antennas of a scene or map area, with the operators and radios it holds; record is the file written into a compiled scene, None for a map area.

result: AntennaQueryResult#
operators: list[AntennaOperator]#
radios: list[str]#
defaults: AntennaDefaults#
record: Path | None#
openworld_radio_twin.antennas.select_antennas(result, *, operator=None, radio=None)[source]#

Keep the antennas of one operator (PLMN or name) and radio technology.

Return type:

AntennaQueryResult

The distinct downlink and TDD ranges the antennas register, lowest first, each with the antennas that transmit on it.

Return type:

list[Channel]

openworld_radio_twin.antennas.summarize_antennas(antennas)[source]#

Operators, radios and downlink channels present among antennas.

Return type:

tuple[list[AntennaOperator], list[str], list[Channel]]

openworld_radio_twin.antennas.as_channel(value)[source]#

A channel given as a range, a {"low_mhz", "high_mhz"} mapping or (low, high).

Return type:

ChannelRange

openworld_radio_twin.antennas.select_channel(result, channel)[source]#

Keep the antennas that transmit on channel: those registering a downlink or TDD range that contains it, whatever operator or technology, at their own power. An antenna that registers no frequencies, as with OpenCelliD, is assumed to transmit on it and is counted in a warning.

Return type:

AntennaQueryResult

openworld_radio_twin.antennas.transmitter_config(antenna, *, frequency_ghz, antenna_pattern)[source]#

A placed antenna as a transmitter of a simulation request, with its provenance.

Return type:

TransmitterConfig

openworld_radio_twin.antennas.write_antenna_record(directory, result, query)[source]#

Write the selection into antennas/ and list it in scene_info.json.

Return type:

Path

openworld_radio_twin.antennas.write_antenna_source(path, result, query, channels)[source]#

Persist a dataset scene’s selected source records, before any placement, with the channels its radio maps draw from.

Return type:

None

openworld_radio_twin.antennas.load_antenna_source(path)[source]#

Read records written by write_antenna_source(), with the query that chose them and the channels of the scene’s radio maps.

Return type:

tuple[AntennaQueryResult, dict[str, object], list[ChannelRange]]

async openworld_radio_twin.antennas.scene_antennas(directory, provider, *, source='auto', operator=None, radio=None, channel=None, defaults=None)[source]#

Acquire, place and select the antennas inside a compiled scene, and record them.

Return type:

SceneAntennas

async openworld_radio_twin.antennas.area_antennas(provider, latitude, longitude, radius_m, *, source='auto', operator=None, radio=None, channel=None, defaults=None)[source]#

Antennas inside a square on the map, completed with defaults but not placed.

Placement needs the terrain and buildings of a compiled scene; this view needs neither, so the explorer can show a source’s antennas before a scene exists. Nothing is recorded.

Return type:

SceneAntennas

async openworld_radio_twin.antennas.load_scene_antennas(directory, *, settings=None, provider=None, **selection)[source]#

scene_antennas() with a provider of its own when the caller has none.

Return type:

SceneAntennas