from __future__ import annotations
from dataclasses import dataclass
from typing import Any, Dict, List, Optional, Sequence, Type, TypeVar
from encord.objects.attributes import (
Attribute,
_add_attribute,
attribute_from_dict,
attributes_to_list_dict,
)
from encord.objects.ontology_element import OntologyElement
[docs]@dataclass
class Classification(OntologyElement):
"""
Represents a whole-image classification as part of Ontology structure. Wraps a single Attribute that describes
the image in general rather than an individual object.
"""
uid: int
feature_node_hash: str
attributes: List[Attribute]
@property
def title(self) -> str:
return self.attributes[0].name
@property
def children(self) -> Sequence[OntologyElement]:
return self.attributes
[docs] def create_instance(self) -> ClassificationInstance:
"""Create a :class:`encord.objects.ClassificationInstance` to be used with a label row."""
return ClassificationInstance(self)
[docs] @classmethod
def from_dict(cls, d: dict) -> Classification:
attributes_ret: List[Attribute] = [attribute_from_dict(attribute_dict) for attribute_dict in d["attributes"]]
return Classification(
uid=int(d["id"]),
feature_node_hash=d["featureNodeHash"],
attributes=attributes_ret,
)
[docs] def to_dict(self) -> Dict[str, Any]:
ret: Dict[str, Any] = {
"id": str(self.uid),
"featureNodeHash": self.feature_node_hash,
}
if attributes_list := attributes_to_list_dict(self.attributes):
ret["attributes"] = attributes_list
return ret
T = TypeVar("T", bound=Attribute)
[docs] def add_attribute(
self,
cls: Type[T],
name: str,
local_uid: Optional[int] = None,
feature_node_hash: Optional[str] = None,
required: bool = False,
) -> T:
"""
Adds an attribute to the classification.
Args:
cls: attribute type, one of `RadioAttribute`, `ChecklistAttribute`, `TextAttribute`
name: the user-visible name of the attribute
local_uid: integer identifier of the attribute. Normally auto-generated;
omit this unless the aim is to create an exact clone of existing ontology
feature_node_hash: global identifier of the attribute. Normally auto-generated;
omit this unless the aim is to create an exact clone of existing ontology
required: whether the label editor would mark this attribute as 'required'
Returns:
the created attribute that can be further specified with Options, where appropriate
Raises:
ValueError: if the classification already has an attribute assigned
"""
if self.attributes:
raise ValueError("Classification should have exactly one root attribute")
return _add_attribute(self.attributes, cls, name, [self.uid], local_uid, feature_node_hash, required)
def __hash__(self):
return hash(self.feature_node_hash)
from encord.objects.classification_instance import ClassificationInstance