openworld_radio_twin.models#
Classes
|
Values placement uses where a source gives none. |
|
One radiating antenna as a source records it; one Sionna |
|
An operator present in a scene; |
|
Antennas from one source inside a compiled scene, or inside a square on the map. |
|
Selected antennas, with the operators, radios and channels present before selection. |
|
|
|
|
|
Source-resolved triangle shell, before scene placement. |
|
Solver-coordinate native shells, with no visual offset or vertical scaling. |
|
A downlink or TDD range an antenna of the scene registers. |
|
A downlink channel to simulate: |
|
|
|
|
|
One distinct range an antenna registers, with its link direction. |
|
|
|
|
|
One registered frequency range with the source's system label, e.g. "LTE 1800". |
|
A frequency range in MHz, kept to 1 kHz. |
|
|
|
|
|
|
|
|
|
Explicit scene origin; the compiled square is centred here rather than on the first TX. |
|
Geometry inputs of a compiled scene, keyed like |
|
A compiled, cached scene as the browser displays it. |
|
|
|
|
|
|
|
Runtime and geometry controls for the built-in Sionna RT adapter. |
|
|
|
|
|
|
|
The antenna record a transmitter was taken from, and where each value came from. |
- class openworld_radio_twin.models.EngineName(value)[source]#
-
- preview = 'preview'#
- sionna = 'sionna'#
- class openworld_radio_twin.models.Coordinate(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.TransmitterSource(**data)[source]#
Bases:
BaseModelThe antenna record a transmitter was taken from, and where each value came from.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.TransmitterConfig(**data)[source]#
Bases:
BaseModel-
position:
Coordinate#
-
source:
TransmitterSource|None#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
position:
- class openworld_radio_twin.models.SionnaEngineConfig(**data)[source]#
Bases:
BaseModelRuntime and geometry controls for the built-in Sionna RT adapter.
- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.SceneRequest(**data)[source]#
Bases:
BaseModelGeometry inputs of a compiled scene, keyed like
openworld_radio_twin.rt.load_scene.- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.SceneCenter(**data)[source]#
Bases:
BaseModelExplicit scene origin; the compiled square is centred here rather than on the first TX.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.SimulationRequest(**data)[source]#
Bases:
BaseModel-
transmitters:
list[TransmitterConfig]#
-
scene_center:
SceneCenter|None#
- property include_surface_materials: bool#
Return whether semantic surface classes are required by this request.
Classes are assigned on the ground grid whether that grid follows the DEM or is a flat plane; only the uniform profile omits them.
- property include_environment_grid: bool#
Return whether a gridded ground (DEM or flat) must be acquired for this request.
The planar preview engine ignores materials, so a flat scene only needs the environment grid when Sionna evaluates it.
- property reference_transmitter: TransmitterConfig#
First TX; it sets the shared antenna preset and, without
scene_center, the origin.
- property scene_origin: SceneCenter#
Local ENU origin and coverage-grid centre of the compiled scene.
- property scene_request: SceneRequest#
Geometry of the compiled scene this simulation runs in.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
transmitters:
- class openworld_radio_twin.models.BuildingGeometry(**data)[source]#
Bases:
BaseModelSource-resolved triangle shell, before scene placement.
Horizontal coordinates use
crs; vertex Z andground_elevation_muse the explicitly named vertical datum, never implicit WGS84 heights.- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.BuildingFeature(**data)[source]#
Bases:
BaseModel-
geometry:
BuildingGeometry|None#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
geometry:
- class openworld_radio_twin.models.FrequencyRange(**data)[source]#
Bases:
BaseModelA frequency range in MHz, kept to 1 kHz.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.FrequencyBand(**data)[source]#
Bases:
FrequencyRangeOne registered frequency range with the source’s system label, e.g. “LTE 1800”.
linkis set when the source itself states the direction, as a register of transmitters does; otherwise the 3GPP bands classify the range.- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.Emission(**data)[source]#
Bases:
FrequencyRangeOne distinct range an antenna registers, with its link direction.
Systems registered on the same range, such as LTE and NR sharing a block, form one emission.
linkcomes from the 3GPP operating bands, seeopenworld_radio_twin.spectrum.- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.ChannelRange(**data)[source]#
Bases:
FrequencyRangeA downlink channel to simulate:
centre_hzis Sionna’sscene.frequencyandbandwidth_hzitsscene.bandwidth.- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.Channel(**data)[source]#
Bases:
ChannelRangeA downlink or TDD range an antenna of the scene registers.
antenna_count,operatorsandlabelsdescribe the antennas that transmit on it: those registering a downlink or TDD range that contains it. A channel of network sharing lists both operators.sionna_supportedtells whether its centre lies insideSIONNA_FREQUENCY_RANGE_GHZ.- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.AntennaFeature(**data)[source]#
Bases:
BaseModelOne radiating antenna as a source records it; one Sionna
Transmitteronce placed.A value the source does not give stays
Noneuntil placement fills it fromAntennaDefaults.basisnames where each value came from:source,derived(computed from source data, such as a centroid),defaultoradjusted(moved by a placement rule).positionandorientationare the Sionna scene coordinates and rotation angles, set by placement in a compiled scene.-
bands:
list[FrequencyBand]#
- property operator_id: str#
the PLMN, else the operator name.
- Type:
The value the operator selection matches
- property emissions: list[Emission]#
The antenna’s distinct registered ranges, each with its link direction.
- transmits_on(channel)[source]#
Whether a downlink or TDD range the antenna registers contains
channel.- Return type:
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
bands:
- class openworld_radio_twin.models.AntennaDefaults(**data)[source]#
Bases:
BaseModelValues placement uses where a source gives none.
Where Sionna RT defines a default, it is used: 44 dBm transmit power (
sionna.rt.constants.DEFAULT_TRANSMIT_POWER_DBM) and the zero orientation, whose boresight points east (compass azimuth 90 degrees) and is horizontal (no downtilt). Sionna has no default height; 25 m above ground is the existing OWRT transmitter default.sectorsexpands a site without a direction into one antenna per azimuth, androof_clearance_mis how far above a roof an antenna inside a building is raised.- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.GridMapping(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.RadioLayer(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.CoverageGrid(**data)[source]#
Bases:
BaseModel-
grid_mapping:
GridMapping#
-
layers:
dict[str,RadioLayer]#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
grid_mapping:
- class openworld_radio_twin.models.NativeBuildingMesh(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.BuildingGeometryContext(**data)[source]#
Bases:
BaseModelSolver-coordinate native shells, with no visual offset or vertical scaling.
-
meshes:
list[NativeBuildingMesh]#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
meshes:
- class openworld_radio_twin.models.SimulationResponse(**data)[source]#
Bases:
BaseModel-
coverage:
CoverageGrid#
-
buildings:
list[BuildingFeature]#
-
building_geometry:
BuildingGeometryContext|None#
- environment: EnvironmentContext | None#
- scene: SceneResponse | None#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
coverage:
- class openworld_radio_twin.models.SceneBounds(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.SceneResponse(**data)[source]#
Bases:
BaseModelA compiled, cached scene as the browser displays it.
scene_idis the cache directory name shared withopenworld_radio_twin.rt.load_scenefor the same geometry inputs; the buildings and environment are read from that directory.-
specification:
SceneRequest#
-
bounds:
SceneBounds#
-
buildings:
list[BuildingFeature]#
-
building_geometry:
BuildingGeometryContext|None#
- environment: EnvironmentContext | None#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
specification:
- class openworld_radio_twin.models.TerrainContext(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.SurfaceContext(**data)[source]#
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.EnvironmentContext(**data)[source]#
Bases:
BaseModel-
terrain:
TerrainContext#
-
surfaces:
SurfaceContext#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
terrain:
- class openworld_radio_twin.models.BuildingContextResponse(**data)[source]#
Bases:
BaseModel-
buildings:
list[BuildingFeature]#
-
building_geometry:
BuildingGeometryContext|None#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
buildings:
- class openworld_radio_twin.models.AntennaOperator(**data)[source]#
Bases:
BaseModelAn operator present in a scene;
idis the value the operator filter takes.- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class openworld_radio_twin.models.AntennaRequest(**data)[source]#
Bases:
BaseModelAntennas from one source inside a compiled scene, or inside a square on the map.
With
scene_idthe antennas are placed in that scene as Sionna transmitters. Withlatitude,longitudeandradius_minstead, they are completed with defaults but not placed, for viewing before a scene is compiled.channelkeeps the antennas that transmit on it; an antenna that registers no frequencies, as with OpenCelliD, is assumed to and counted in a warning.- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
channel:
ChannelRange|None#
-
defaults:
AntennaDefaults#
- class openworld_radio_twin.models.AntennaResponse(**data)[source]#
Bases:
BaseModelSelected antennas, with the operators, radios and channels present before selection.
scene_idis set when the antennas are placed in a compiled scene andNonefor an area on the map, wherepositionstays unset.channelis the selected channel.-
antennas:
list[AntennaFeature]#
-
operators:
list[AntennaOperator]#
-
channel:
ChannelRange|None#
-
defaults:
AntennaDefaults#
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
-
antennas: