Map Metadata

class py123d.datatypes.MapMetadata[source]

Class to hold metadata information about a map.

Public Data Attributes:

dataset

The dataset name in lowercase.

split

Data split name, typically {dataset_name}_{train/val/test}.

log_name

Name of the log file.

location

Location of the map data.

map_has_z

Indicates if the map includes Z (elevation) data.

map_is_per_log

Indicates if the map is per-log (map for each log) or global (map for multiple logs in dataset).

version

Version of the py123d library used to create this map metadata.

Public Methods:

from_dict(data_dict)

Create a MapMetadata instance from a dictionary.

to_dict()

Convert the MapMetadata instance to a dictionary.

Inherited from BaseMetadata

to_dict()

Serialize the metadata instance to a plain Python dictionary.

from_dict(data_dict)

Construct a metadata instance from a plain Python dictionary.


property dataset: str

The dataset name in lowercase.

property split: str | None

Data split name, typically {dataset_name}_{train/val/test}.

property log_name: str | None

Name of the log file.

property location: str | None

Location of the map data.

property map_has_z: bool

Indicates if the map includes Z (elevation) data.

property map_is_per_log: bool

Indicates if the map is per-log (map for each log) or global (map for multiple logs in dataset).

property version: str

Version of the py123d library used to create this map metadata.

classmethod from_dict(data_dict)[source]

Create a MapMetadata instance from a dictionary.

Parameters:

data_dict (Dict[str, Any]) – A dictionary representation of a MapMetadata instance.

Return type:

MapMetadata

Returns:

A MapMetadata instance.

to_dict()[source]

Convert the MapMetadata instance to a dictionary.

Return type:

Dict[str, Any]

Returns:

A dictionary representation of the MapMetadata instance.