paralleldomain.model.dataset

class DatasetMeta(name, available_annotation_types, custom_attributes=<factory>)

Stores name, annotation types and any custom meta attributes for a dataset

Parameters
Return type

None

name

Name of the dataset.

Type

str

available_annotation_types

List of available annotation types for all scenes.

Type

List[Type[paralleldomain.model.annotation.common.Annotation]]

custom_attributes

Dictionary of arbitrary dataset attributes.

Type

Dict[str, Any]

class Dataset(decoder)

The Dataset object is the entry point for loading any data.

A dataset manages all attached scenes and its sensor data. It takes care of calling the decoder when specific data is required and stores it in the PD SDK model classes and attributes.

Parameters

decoder (paralleldomain.model.dataset.DatasetDecoderProtocol) –

property unordered_scene_names: List[str]

Returns a list of sensor frame set names within the dataset.

Return type

List[str]

property metadata: paralleldomain.model.dataset.DatasetMeta

Returns a list of scene names within the dataset.

Return type

DatasetMeta

property unordered_scenes: Dict[str, paralleldomain.model.unordered_scene.UnorderedScene[Optional[datetime.datetime]]]

Returns a dictionary of SensorFrameSet instances with the scene name as key. This a superset of scenes and hence will also include all scenes.

Return type

Dict[str, UnorderedScene[Optional[datetime]]]

property available_annotation_types: List[Type[paralleldomain.model.annotation.common.Annotation]]

Returns a list of available annotation types for the dataset.

Return type

List[Type[Annotation]]

property name: str

Returns the name of the dataset.

Return type

str

get_unordered_scene(scene_name)

Allows access to a sensor frame set by using its name.

Parameters

scene_name (str) – Name of sensor frame set to be returned

Returns

Returns the SensorFrameSet object for a sensor frame set name.

Return type

UnorderedScene

property scene_names: List[str]

Returns a list of scene names within the dataset.

Return type

List[str]

property scenes: Dict[str, paralleldomain.model.scene.Scene]

Returns a dictionary of Scene instances with the scene name as key.

Return type

Dict[str, Scene]

get_scene(scene_name)

Allows access to a scene by using its name.

Parameters

scene_name (str) – Name of scene to be returned

Returns

Returns the Scene object for a scene name.

Return type

Scene