Skip to content

TIER IV API

DBMetadata

A dataclass to represent dataset metadata.

Attributes:

  • data_root (str) –

    Root directory path.

  • dataset_id (str) –

    Unique dataset ID.

  • version (str | None) –

    Dataset version.

Tier4 

Tier4(
    data_root: str,
    revision: str | None = None,
    verbose: bool = True,
)

Database class for T4 dataset to help query and retrieve information from the database.

Load database and creates reverse indexes and shortcuts.

Parameters:

  • data_root

    (str) –

    Path to the root directory of dataset.

  • revision

    (str | None, default: None ) –

    You can specify any specific version if you want. If None, search the latest one.

  • verbose

    (bool, default: True ) –

    Whether to display status during load.

Examples:

>>> from t4_devkit import Tier4
>>> t4 = Tier4("data/tier4")
======
Loading T4 tables in `annotation`...
Reverse indexing...
Done reverse indexing in 0.010 seconds.
======
21 category
8 attribute
4 visibility
31 instance
7 sensor
7 calibrated_sensor
2529 ego_pose
1 log
1 scene
88 sample
2529 sample_data
1919 sample_annotation
0 object_ann
0 surface_ann
0 keypoint
1 map
Done loading in 0.046 seconds.
======

data_root property 

data_root: str

Return the path to dataset root directory.

dataset_id property 

dataset_id: str

Return the dataset ID.

version property 

version: str | None

Return the dataset version, or None if it is failed to lookup.

annotation_dir property 

annotation_dir: str

Return the path to annotation directory.

map_dir property 

map_dir: str

Return the path to map directory.

bag_dir property 

bag_dir: str

Return the path to ROS bag directory.

get_table 

get_table(schema: str | SchemaName) -> list[SchemaTable]

Return the list of dataclasses corresponding to the schema table.

Parameters:

Returns:

  • list[SchemaTable] –

    List of dataclasses.

get 

get(schema: str | SchemaName, token: str) -> SchemaTable

Return a record identified by the associated token.

Parameters:

  • schema
    (str | SchemaName) –

    Name of schema.

  • token
    (str) –

    Token to identify the specific record.

Returns:

  • SchemaTable –

    Table record of the corresponding token.

get_idx 

get_idx(schema: str | SchemaName, token: str) -> int

Return the index of the record in a table in constant runtime.

Parameters:

  • schema
    (str | SchemaName) –

    Name of schema.

  • token
    (str) –

    Token of record.

Returns:

  • int –

    The index of the record in table.

get_sample_data_path 

get_sample_data_path(sample_data_token: str) -> str

Return the file path to a raw data recorded in sample_data.

Parameters:

  • sample_data_token
    (str) –

    Token of sample_data.

Returns:

  • str –

    File path.

get_sample_data 

get_sample_data(
    sample_data_token: str,
    *,
    selected_ann_tokens: list[str] | None = None,
    as_3d: bool = True,
    as_sensor_coord: bool = True,
    future_seconds: float = 0.0,
    visibility: VisibilityLevel = VisibilityLevel.NONE,
) -> tuple[str, list[BoxLike], CamIntrinsicLike | None]

Return the data path as well as all annotations related to that sample_data. Note that output boxes is w.r.t base link or sensor coordinate system.

Parameters:

  • sample_data_token
    (str) –

    Token of sample_data.

  • selected_ann_tokens
    (list[str] | None, default: None ) –

    Specify if you want to extract only particular annotations.

  • as_3d
    (bool, default: True ) –

    Whether to return 3D or 2D boxes.

  • as_sensor_coord
    (bool, default: True ) –

    Whether to transform boxes as sensor origin coordinate system.

  • visibility
    (VisibilityLevel, default: NONE ) –

    If sample_data is an image, this sets required visibility for only 3D boxes.

Returns:

  • tuple[str, list[BoxLike], CamIntrinsicLike | None] –

    Data path, a list of boxes and 3x3 camera intrinsic matrix.

get_semantic_label 

get_semantic_label(
    category_token: str,
    attribute_tokens: list[str] | None = None,
) -> SemanticLabel

Return a SemanticLabel instance from specified category_token and attribute_tokens.

Parameters:

  • category_token
    (str) –

    Token of Category table.

  • attribute_tokens
    (list[str] | None, default: None ) –

    List of attribute tokens.

Returns:

get_box3d 

get_box3d(
    sample_annotation_token: str,
    *,
    future_seconds: float = 0.0,
) -> Box3D

Return a Box3D class from a sample_annotation record.

Parameters:

  • sample_annotation_token
    (str) –

    Token of sample_annotation.

  • future_seconds
    (float, default: 0.0 ) –

    Future time in [s].

Returns:

  • Box3D –

    Instantiated Box3D.

get_box2d 

get_box2d(object_ann_token: str) -> Box2D

Return a Box2D class from a object_ann record.

Parameters:

  • object_ann_token
    (str) –

    Token of object_ann.

Returns:

  • Box2D –

    Instantiated Box2D.

get_box3ds 

get_box3ds(
    sample_data_token: str, *, future_seconds: float = 0.0
) -> list[Box3D]

Rerun a list of Box3D classes for all annotations of a particular sample_data record. It the sample_data is a keyframe, this returns annotations for the corresponding sample.

Parameters:

  • sample_data_token
    (str) –

    Token of sample_data.

  • future_seconds
    (float, default: 0.0 ) –

    Future time in [s].

Returns:

  • list[Box3D] –

    List of instantiated Box3D classes.

get_box2ds 

get_box2ds(sample_data_token: str) -> list[Box2D]

Rerun a list of Box2D classes for all annotations of a particular sample_data record. It the sample_data is a keyframe, this returns annotations for the corresponding sample.

Parameters:

  • sample_data_token
    (str) –

    Token of sample_data.

Returns:

  • list[Box2D] –

    List of instantiated Box2D classes.

box_velocity 

box_velocity(
    sample_annotation_token: str, max_time_diff: float = 1.5
) -> Vector3

Return the velocity of an annotation. If corresponding annotation has a true velocity, this returns it. Otherwise, this estimates the velocity by computing the difference between the previous and next frame. If it is failed to estimate the velocity, values are set to np.nan.

Parameters:

  • sample_annotation_token
    (str) –

    Token of sample_annotation.

  • max_time_diff
    (float, default: 1.5 ) –

    Max allowed time difference between consecutive samples.

Returns:

  • Vector3 ( Vector3 ) –

    Velocity in the order of (vx, vy, vz) in m/s.

TODO

Currently, velocity coordinates is with respect to map, but if should be each box.

render_scene 

render_scene(
    *,
    max_time_seconds: float = np.inf,
    future_seconds: float = 0.0,
    save_dir: str | None = None,
) -> None

Render specified scene.

Parameters:

  • max_time_seconds
    (float, default: inf ) –

    Max time length to be rendered [s].

  • future_seconds
    (float, default: 0.0 ) –

    Future time in [s].

  • save_dir
    (str | None, default: None ) –

    Directory path to save the recording.

render_instance 

render_instance(
    instance_token: str | Sequence[str],
    *,
    future_seconds: float = 0.0,
    save_dir: str | None = None,
) -> None

Render particular instance.

Parameters:

  • instance_token
    (str | Sequence[str]) –

    Instance token(s).

  • future_seconds
    (float, default: 0.0 ) –

    Future time in [s].

  • save_dir
    (str | None, default: None ) –

    Directory path to save the recording.

render_pointcloud 

render_pointcloud(
    *,
    max_time_seconds: float = np.inf,
    ignore_distortion: bool = True,
    save_dir: str | None = None,
) -> None

Render pointcloud on 3D and 2D view.

Parameters:

  • max_time_seconds
    (float, default: inf ) –

    Max time length to be rendered [s].

  • save_dir
    (str | None, default: None ) –

    Directory path to save the recording.

  • ignore_distortion
    (bool, default: True ) –

    Whether to ignore distortion parameters.

TODO

Add an option of rendering radar channels.

load_metadata 

load_metadata(
    db_root: str, revision: str | None = None
) -> DBMetadata

Load metadata of T4 dataset including root directory path, dataset ID, and version.

Parameters:

  • db_root

    (str) –

    Path to root directory of database.

  • revision

    (str | None, default: None ) –

    Specify version of the dataset. If None, search the latest one.

Returns:

load_table 

load_table(
    annotation_dir: str, schema: SchemaName
) -> list[SchemaTable]

Load schema table from a JSON file.

If the schema is optional and there is no corresponding JSON file in dataset, returns empty list.

Parameters:

  • annotation_dir

    (str) –

    Path to the directory of JSON annotation schema files.

  • schema

    (SchemaName) –

    An enum member of SchemaName.

Returns:

  • list[SchemaTable] –

    Loaded table data saved in .json.