openworld_radio_twin.radio_map_index#

The Parquet index of a dataset or package: one row per complete radio map.

The index is derived from the scene and radio map records and is rebuilt from them; it is never read by generation or resume. Its footer metadata records the dataset format and the manifest’s index_revision it was built for, so a reader can refuse an index that a later run has made stale.

Functions

index_table(dataset_directory, scenes, revision)

The index of the given scenes and complete radio map records, in their order.

read_index(root)

Read the index of a generated dataset or of a package, refusing a stale one.

write_index(directory, table)

Write index.parquet in directory through a temporary file and return its path.

openworld_radio_twin.radio_map_index.index_table(dataset_directory, scenes, revision, splits=None, archives=None, source_manifest_sha256=None)[source]#

The index of the given scenes and complete radio map records, in their order.

splits and archives map scene names to their split and archive path in a package; outside a package both columns are null. A package also records the SHA-256 checksum of the dataset manifest it snapshots, source_manifest_sha256, in the footer. Scene-level values not in the plan come from each scene’s scene_info.json.

Return type:

Table

openworld_radio_twin.radio_map_index.write_index(directory, table)[source]#

Write index.parquet in directory through a temporary file and return its path.

Return type:

Path

openworld_radio_twin.radio_map_index.read_index(root)[source]#

Read the index of a generated dataset or of a package, refusing a stale one.

The index is stale when its recorded index_revision is not the manifest’s: a run is writing the dataset, or one stopped before it could rebuild the index. Once no run is active, owrt dataset index DATASET rebuilds the index of a generated dataset; packaging writes the index of a package.

Return type:

Table