openworld_radio_twin.batch#
Functions
|
|
Each planned scene with the records of its complete radio maps, in plan order. |
|
|
Hold the dataset lock exclusively, refusing while anyone else holds it. |
|
|
|
The radio map's request: its channel, and the scene's antennas that transmit on it, placed under the radio map's defaults. |
|
The channels a scene's radio maps draw from: the listed ones, each with at least one antenna on it, else every downlink channel of the scene's antennas that the engine supports. |
|
|
|
Rebuild |
Classes
|
Transmitters taken from an antenna source instead of sampled positions. |
|
|
|
What each radio map writes besides its record and its packed path gain. |
|
|
|
|
|
|
|
A planned radio map. |
|
|
|
|
|
|
|
A radio map's draws for transmitters taken from the scene's antennas. |
- class openworld_radio_twin.batch.FloatRange(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.batch.IntegerRange(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.batch.BatchOutputSpec(**data)[source]#
Bases:
BaseModelWhat each radio map writes besides its record and its packed path gain.
previewsadds the PNG previews, rendered from the solver’s in-memory arrays, for inspection; packages leave them out.- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.batch.BatchRadioMapSpace(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
engine:
EngineName#
-
transmitter_count:
IntegerRange#
-
frequency_ghz:
FloatRange#
-
power_dbm:
FloatRange#
-
altitude_m:
FloatRange#
-
offset_radius_m:
FloatRange#
-
azimuth_deg:
FloatRange#
-
downtilt_deg:
FloatRange#
- class openworld_radio_twin.batch.BatchAntennaSelection(**data)[source]#
Bases:
BaseModelTransmitters taken from an antenna source instead of sampled positions.
Each radio map simulates one downlink channel with every selected antenna inside the scene that transmits on it.
channelslists the channels radio maps draw from; empty means every downlink channel the scene’s antennas register that the engine supports. A source without frequencies, such as OpenCelliD, needs the channels listed. Values the source records (position, and height or azimuth where given) are kept; the radio map samples the others from its ranges: height, azimuth, downtilt and power, as well as the pattern. The carrier frequency and noise bandwidth come from the channel; each antenna keeps its own power.- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
channels:
list[ChannelRange]#
- class openworld_radio_twin.batch.BatchSceneSpec(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
antennas:
BatchAntennaSelection|None#
-
radio_maps:
BatchRadioMapSpace#
- class openworld_radio_twin.batch.BatchDatasetRequest(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
output:
BatchOutputSpec#
-
scenes:
list[BatchSceneSpec]#
- class openworld_radio_twin.batch.RegisteredDraw(**data)[source]#
Bases:
BaseModelA radio map’s draws for transmitters taken from the scene’s antennas.
The scene’s channels, and so their number, are known only once its antennas are acquired, after planning. A random radio map therefore stores
channel_draw, a uniform number in [0, 1) that picks one; a fixed radio map storeschannel_indexand takes them in turn.defaultsholds the sampled values for what the source does not record;requestholds the radio map’s request fields other than the transmitters, carrier and bandwidth.-
defaults:
AntennaDefaults#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
defaults:
- class openworld_radio_twin.batch.ExpandedRadioMap(**data)[source]#
Bases:
BaseModelA planned radio map. One taking its transmitters from antennas starts with only its draws; generation adds the request once the scene’s antennas are placed.
-
request:
SimulationRequest|None#
-
registered:
RegisteredDraw|None#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
request:
- class openworld_radio_twin.batch.PlannedScene(**data)[source]#
Bases:
BaseModel-
specification:
BatchSceneSpec#
-
radio_maps:
list[ExpandedRadioMap]#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
specification:
- class openworld_radio_twin.batch.BatchPlan(**data)[source]#
Bases:
BaseModel-
scenes:
list[PlannedScene]#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
scenes:
- openworld_radio_twin.batch.scene_channels(selection, antennas, engine)[source]#
The channels a scene’s radio maps draw from: the listed ones, each with at least one antenna on it, else every downlink channel of the scene’s antennas that the engine supports.
- Return type:
- openworld_radio_twin.batch.registered_radio_map(radio_map, antennas, assets, channels)[source]#
The radio map’s request: its channel, and the scene’s antennas that transmit on it, placed under the radio map’s defaults.
- Return type:
- openworld_radio_twin.batch.completed_radio_map_records(dataset_directory, plan, output)[source]#
Each planned scene with the records of its complete radio maps, in plan order.
A radio map is complete by the check resume uses; a record generated from another request than the plan’s raises.
- Return type:
list[tuple[PlannedScene,list[dict]]]
- openworld_radio_twin.batch.write_dataset_index(dataset_directory, plan, output, revision)[source]#
Rebuild
index.parquetof a dataset for the manifest’sindex_revision.- Return type: