#!/usr/bin/env python3
#
# Copyright 2021 Graviti. Licensed under MIT License.
#
"""Catalog.
:class:`Catalog` is used to describe the types of labels
contained in a :class:`~tensorbay.dataset.dataset.DatasetBase` and
all the optional values of the label contents.
A :class:`Catalog` contains one or several :class:`~tensorbay.label.basic.SubcatalogBase`,
corresponding to different types of labels.
.. table:: subcatalog classes
:widths: auto
================================== ==================================================
subcatalog classes explaination
================================== ==================================================
:class:`.ClassificationSubcatalog` subcatalog for classification type of label
:class:`.Box2DSubcatalog` subcatalog for 2D bounding box type of label
:class:`.Box3DSubcatalog` subcatalog for 3D bounding box type of label
:class:`.Keypoints2DSubcatalog` subcatalog for 2D keypoints type of label
:class:`.PolygonSubcatalog` subcatalog for polygon type of label
:class:`.Polyline2DSubcatalog` subcatalog for 2D polyline type of label
:class:`.SentenceSubcatalog` subcatalog for transcripted sentence type of label
================================== ==================================================
"""
from functools import partial
from typing import Any, Dict, Type, TypeVar, Union
from ..label import LabelType
from ..utility import AttrsMixin, ReprMixin, ReprType, attr, common_loads, upper
from .label_box import Box2DSubcatalog, Box3DSubcatalog
from .label_classification import ClassificationSubcatalog
from .label_keypoints import Keypoints2DSubcatalog
from .label_polygon import PolygonSubcatalog
from .label_polyline import Polyline2DSubcatalog
from .label_sentence import SentenceSubcatalog
Subcatalogs = Union[
ClassificationSubcatalog,
Box2DSubcatalog,
Box3DSubcatalog,
PolygonSubcatalog,
Polyline2DSubcatalog,
Keypoints2DSubcatalog,
SentenceSubcatalog,
]
_ERROR_MESSAGE = "The '{attr_name}' subcatalog is not provided in this dataset"
_attr = partial(attr, is_dynamic=True, key=upper, error_message=_ERROR_MESSAGE)
[docs]class Catalog(ReprMixin, AttrsMixin):
"""This class defines the concept of catalog.
:class:`Catalog` is used to describe the types of labels
contained in a :class:`~tensorbay.dataset.dataset.DatasetBase`
and all the optional values of the label contents.
A :class:`Catalog` contains one or several :class:`~tensorbay.label.basic.SubcatalogBase`,
corresponding to different types of labels.
Each of the :class:`~tensorbay.label.basic.SubcatalogBase`
contains the features, fields and the specific definitions of the labels.
Examples:
>>> from tensorbay.utility import NameList
>>> from tensorbay.label import ClassificationSubcatalog, CategoryInfo
>>> classification_subcatalog = ClassificationSubcatalog()
>>> categories = NameList()
>>> categories.append(CategoryInfo("example"))
>>> classification_subcatalog.categories = categories
>>> catalog = Catalog()
>>> catalog.classification = classification_subcatalog
>>> catalog
Catalog(
(classification): ClassificationSubcatalog(
(categories): NameList [...]
)
)
"""
_T = TypeVar("_T", bound="Catalog")
_repr_type = ReprType.INSTANCE
_repr_attrs = tuple(label_type.value for label_type in LabelType)
_repr_maxlevel = 2
classification: ClassificationSubcatalog = _attr()
box2d: Box2DSubcatalog = _attr()
box3d: Box3DSubcatalog = _attr()
polygon: PolygonSubcatalog = _attr()
polyline2d: Polyline2DSubcatalog = _attr()
keypoints2d: Keypoints2DSubcatalog = _attr()
sentence: SentenceSubcatalog = _attr()
def __bool__(self) -> bool:
for label_type in LabelType:
if hasattr(self, label_type.value):
return True
return False
[docs] @classmethod
def loads(cls: Type[_T], contents: Dict[str, Any]) -> _T:
"""Load a Catalog from a dict containing the catalog information.
Arguments:
contents: A dict containing all the information of the catalog.
Returns:
The loaded :class:`Catalog` object.
Examples:
>>> contents = {
... "CLASSIFICATION": {
... "categories": [
... {
... "name": "example",
... }
... ]
... },
... "KEYPOINTS2D": {
... "keypoints": [
... {
... "number": 5,
... }
... ]
... },
... }
>>> Catalog.loads(contents)
Catalog(
(classification): ClassificationSubcatalog(
(categories): NameList [...]
),
(keypoints2d): Keypoints2DSubcatalog(
(is_tracking): False,
(keypoints): [...]
)
)
"""
return common_loads(cls, contents)
[docs] def dumps(self) -> Dict[str, Any]:
"""Dumps the catalog into a dict containing the information of all the subcatalog.
Returns:
A dict containing all the subcatalog information with their label types as keys.
Examples:
>>> # catalog is the instance initialized above.
>>> catalog.dumps()
{'CLASSIFICATION': {'categories': [{'name': 'example'}]}}
"""
return self._dumps()