Scene2Wave / metadata /json_schema.json
mfzheng's picture
Upload Scene2Wave release metadata
30d138d verified
Raw
History Blame Contribute Delete
19.1 kB
{
"$defs": {
"alignmentIndex": {
"additionalProperties": false,
"properties": {
"alignment": {
"additionalProperties": {
"type": "string"
},
"required": [
"camera_to_csi",
"geometry_frame_clock",
"lidar_to_csi",
"radar_to_csi",
"sensor_to_geometry"
],
"type": "object"
},
"carla_accel": {
"additionalProperties": true,
"type": "object"
},
"geometry": {
"additionalProperties": false,
"properties": {
"frame_count": {
"minimum": 1,
"type": "integer"
},
"frames": {
"items": {
"$ref": "#/$defs/geometryFrame"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"frame_count",
"frames"
],
"type": "object"
},
"scenario": {
"type": "string"
},
"schema_version": {
"const": 1
},
"streams": {
"items": {
"$ref": "#/$defs/sensorStream"
},
"minItems": 1,
"type": "array"
},
"time_bases": {
"additionalProperties": false,
"properties": {
"csi_rate_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"geometry_rate_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"rates_by_modality_hz": {
"additionalProperties": {
"items": {
"exclusiveMinimum": 0,
"type": "number"
},
"type": "array"
},
"type": "object"
},
"sensor_rate_hz": {
"exclusiveMinimum": 0,
"type": "number"
}
},
"required": [
"csi_rate_hz",
"geometry_rate_hz",
"rates_by_modality_hz",
"sensor_rate_hz"
],
"type": "object"
}
},
"required": [
"schema_version",
"scenario",
"time_bases",
"geometry",
"streams",
"alignment"
],
"type": "object"
},
"countMap": {
"additionalProperties": {
"minimum": 0,
"type": "integer"
},
"type": "object"
},
"datasetInfo": {
"additionalProperties": false,
"properties": {
"created_at_utc": {
"format": "date-time",
"type": "string"
},
"data_file_count": {
"minimum": 1,
"type": "integer"
},
"data_size_bytes": {
"minimum": 1,
"type": "integer"
},
"dataset_name": {
"const": "scene2wave_dataset"
},
"dataset_version": {
"type": "string"
},
"distributions": {
"additionalProperties": false,
"properties": {
"profile": {
"$ref": "#/$defs/countMap"
},
"state": {
"$ref": "#/$defs/countMap"
},
"town": {
"$ref": "#/$defs/countMap"
}
},
"required": [
"town",
"state",
"profile"
],
"type": "object"
},
"excluded": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"formal_samples": {
"minimum": 1,
"type": "integer"
},
"included_modalities": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"self_contained": {
"const": true
},
"source_code_revision": {
"type": [
"string",
"null"
]
},
"source_experiment": {
"type": "string"
},
"source_manifest_sha256": {
"pattern": "^[0-9a-f]{64}$",
"type": "string"
}
},
"required": [
"dataset_name",
"dataset_version",
"created_at_utc",
"formal_samples",
"data_file_count",
"data_size_bytes",
"distributions",
"included_modalities",
"excluded",
"self_contained"
],
"type": "object"
},
"geometryFrame": {
"additionalProperties": false,
"properties": {
"frame_id": {
"type": "integer"
},
"geometry_index": {
"minimum": 0,
"type": "integer"
},
"time_s": {
"minimum": 0,
"type": "number"
}
},
"required": [
"frame_id",
"geometry_index",
"time_s"
],
"type": "object"
},
"observedFrame": {
"additionalProperties": false,
"properties": {
"frame_id": {
"type": "integer"
},
"geometry_index": {
"minimum": 0,
"type": "integer"
},
"nearest_geometry_frame_id": {
"type": "integer"
},
"policy": {
"type": "string"
},
"relative_path": {
"type": "string"
},
"time_s": {
"minimum": 0,
"type": "number"
}
},
"required": [
"frame_id",
"geometry_index",
"nearest_geometry_frame_id",
"policy",
"relative_path",
"time_s"
],
"type": "object"
},
"plannedSample": {
"additionalProperties": false,
"properties": {
"frame_id": {
"type": "integer"
},
"geometry_index": {
"minimum": 0,
"type": "integer"
},
"policy": {
"type": "string"
},
"sample_index": {
"minimum": 0,
"type": "integer"
},
"target_time_s": {
"minimum": 0,
"type": "number"
}
},
"required": [
"frame_id",
"geometry_index",
"policy",
"sample_index",
"target_time_s"
],
"type": "object"
},
"radarDetection": {
"additionalProperties": false,
"properties": {
"altitude": {
"description": "Vertical detection angle in radians.",
"type": "number"
},
"azimuth": {
"description": "Horizontal detection angle in radians.",
"type": "number"
},
"depth": {
"description": "Range in metres.",
"minimum": 0,
"type": "number"
},
"velocity": {
"description": "Relative radial velocity in m/s.",
"type": "number"
}
},
"required": [
"velocity",
"azimuth",
"altitude",
"depth"
],
"type": "object"
},
"radarFrame": {
"items": {
"$ref": "#/$defs/radarDetection"
},
"type": "array"
},
"sampleIndexRecord": {
"additionalProperties": false,
"properties": {
"archive_bytes": {
"minimum": 1,
"type": "integer"
},
"archive_path": {
"pattern": "^data/main_training/.+\\.tar$",
"type": "string"
},
"archive_sha256": {
"pattern": "^[0-9a-f]{64}$",
"type": "string"
},
"bandwidth_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"carrier_frequency_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"contains_empty_cir": {
"type": "boolean"
},
"csi_sampling_rate_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"num_subcarriers": {
"minimum": 1,
"type": "integer"
},
"profile": {
"minLength": 1,
"type": "string"
},
"relative_path": {
"pattern": "^data/main_training/",
"type": "string"
},
"sample_id": {
"minLength": 1,
"type": "string"
},
"scenario": {
"minLength": 1,
"type": "string"
},
"state": {
"enum": [
"static",
"10kmh",
"20kmh",
"40kmh",
"60kmh"
],
"type": "string"
},
"subcarrier_spacing_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"town": {
"pattern": "^Town[0-9]+$",
"type": "string"
},
"valid_cir": {
"type": "boolean"
}
},
"required": [
"sample_id",
"relative_path",
"town",
"state",
"profile",
"scenario",
"valid_cir",
"contains_empty_cir",
"carrier_frequency_hz",
"bandwidth_hz",
"subcarrier_spacing_hz",
"num_subcarriers",
"csi_sampling_rate_hz",
"archive_path",
"archive_bytes",
"archive_sha256"
],
"type": "object"
},
"sampleMetadata": {
"additionalProperties": false,
"properties": {
"channel": {
"additionalProperties": false,
"properties": {
"contains_empty_cir": {
"type": "boolean"
},
"dominant_link_state": {
"type": "string"
},
"empty_cir_fraction": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"link_sequence_class": {
"type": "string"
},
"los_frame_fraction": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"material_scattering_profile": {
"type": "string"
},
"material_scattering_scale": {
"minimum": 0,
"type": "number"
},
"mean_path_count": {
"minimum": 0,
"type": "number"
},
"nlos_frame_fraction": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"propagation_state_class": {
"type": "string"
},
"rms_delay_spread_mean_s": {
"minimum": 0,
"type": "number"
},
"valid_cir": {
"type": "boolean"
},
"wireless_condition_profile": {
"type": "string"
}
},
"required": [
"valid_cir",
"contains_empty_cir",
"empty_cir_fraction"
],
"type": "object"
},
"dataset": {
"additionalProperties": false,
"properties": {
"profile": {
"type": "string"
},
"role": {
"type": "string"
},
"split_group": {
"type": "string"
},
"state": {
"type": "string"
},
"subset": {
"const": "main_training"
},
"town": {
"type": "string"
}
},
"required": [
"subset",
"profile",
"town",
"state"
],
"type": "object"
},
"duration_s": {
"exclusiveMinimum": 0,
"type": "number"
},
"geometry": {
"additionalProperties": false,
"properties": {
"cav_end_position_m": {
"$ref": "#/$defs/xyPosition"
},
"cav_start_position_m": {
"$ref": "#/$defs/xyPosition"
},
"mean_rsu_cav_distance_m": {
"minimum": 0,
"type": "number"
},
"rsu_position_m": {
"$ref": "#/$defs/xyPosition"
}
},
"type": "object"
},
"metadata_version": {
"const": 2
},
"paths": {
"additionalProperties": false,
"properties": {
"alignment_index": {
"const": "carla/alignment_index.json"
},
"carla": {
"const": "carla"
},
"sionna": {
"const": "sionna"
}
},
"required": [
"carla",
"sionna",
"alignment_index"
],
"type": "object"
},
"provenance": {
"additionalProperties": false,
"properties": {
"carla_cache_key_hash": {
"pattern": "^[0-9a-f]{64}$",
"type": "string"
}
},
"type": "object"
},
"radio": {
"additionalProperties": false,
"properties": {
"bandwidth_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"carrier_frequency_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"num_subcarriers": {
"minimum": 1,
"type": "integer"
},
"sampling_rate_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"subcarrier_spacing_hz": {
"exclusiveMinimum": 0,
"type": "number"
}
},
"required": [
"carrier_frequency_hz",
"bandwidth_hz",
"subcarrier_spacing_hz",
"num_subcarriers",
"sampling_rate_hz"
],
"type": "object"
},
"ray_tracing": {
"additionalProperties": false,
"properties": {
"diffraction": {
"type": "boolean"
},
"max_depth": {
"minimum": 0,
"type": "integer"
},
"num_samples": {
"minimum": 1,
"type": "integer"
},
"reflection": {
"type": "boolean"
},
"scattering": {
"type": "boolean"
}
},
"type": "object"
},
"sample_id": {
"minLength": 1,
"type": "string"
},
"scenario": {
"minLength": 1,
"type": "string"
},
"sensor_context": {
"additionalProperties": false,
"properties": {
"birdview": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"fov_deg": {
"type": "number"
},
"height_m": {
"type": "number"
},
"image_size_x": {
"minimum": 1,
"type": "integer"
},
"image_size_y": {
"minimum": 1,
"type": "integer"
},
"rate_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"yaw_deg": {
"type": "number"
}
},
"type": "object"
},
"spawn_center_m": {
"additionalProperties": false,
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"metadata_version",
"sample_id",
"scenario",
"dataset",
"duration_s",
"radio",
"channel",
"geometry",
"ray_tracing",
"paths"
],
"type": "object"
},
"sensorStream": {
"additionalProperties": false,
"properties": {
"actor": {
"type": "string"
},
"enabled_in_this_pass": {
"type": "boolean"
},
"expected_count": {
"minimum": 0,
"type": "integer"
},
"filename_suffix": {
"type": "string"
},
"modality": {
"type": "string"
},
"observed_count": {
"minimum": 0,
"type": "integer"
},
"observed_frames": {
"items": {
"$ref": "#/$defs/observedFrame"
},
"type": "array"
},
"phase_frame_id": {
"type": "integer"
},
"phase_source": {
"type": "string"
},
"planned_samples": {
"items": {
"$ref": "#/$defs/plannedSample"
},
"type": "array"
},
"rate_hz": {
"exclusiveMinimum": 0,
"type": "number"
},
"relative_dir": {
"type": "string"
},
"sensor_name": {
"type": "string"
},
"stream_id": {
"type": "string"
}
},
"required": [
"actor",
"enabled_in_this_pass",
"expected_count",
"filename_suffix",
"modality",
"observed_count",
"observed_frames",
"planned_samples",
"rate_hz",
"relative_dir",
"sensor_name",
"stream_id"
],
"type": "object"
},
"xyPosition": {
"additionalProperties": false,
"properties": {
"x": {
"description": "CARLA world-frame x coordinate in metres.",
"type": "number"
},
"y": {
"description": "CARLA world-frame y coordinate in metres.",
"type": "number"
}
},
"required": [
"x",
"y"
],
"type": "object"
}
},
"$id": "https://huggingface.co/datasets/scene2wave/scene2wave_dataset/raw/main/metadata/json_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Validate each file against the matching definition under $defs.",
"title": "Scene2Wave packaged release JSON schemas"
}