Objects.classification

​

OntologyClassificationLevel Objects

class OntologyClassificationLevel(StringEnum)

• GLOBAL OntologyClassificationLevel - Indicates a global, whole-image classification that applies to the entire data unit rather than to a specific object or region.

​

Classification Objects

@dataclass
class Classification(OntologyElement)

• uid int - Deprecated. Please use feature_node_hash instead.
• feature_node_hash str - Unique hash value identifying the feature node in the ontology tree corresponding to this classification.
• attributes List[Attribute] - List of Attribute instances that define the semantic meaning or properties associated with the classification.
• _level OntologyClassificationLevel | None - The hierarchical level of this classification (for example: GLOBAL). Optional: defaults to None.

    >>> classification = Classification(
    ...     uid=1,
    ...     feature_node_hash="abc123",
    ...     attributes=[Attribute(name="Scene Type", value="Indoor")],
    ...     level=OntologyClassificationLevel.GLOBAL,
    ... )

​

title

@property
def title() -> str

• str - The title of the classification.

​

level

@property
def level() -> OntologyClassificationLevel | None

​

children

@property
def children() -> Sequence[OntologyElement]

• Sequence[OntologyElement] - The attributes of the classification.

​

is_global

@property
def is_global() -> bool

• bool - True if the classification level is global, False otherwise.

​

create_instance

def create_instance(range_only: bool = False) -> ClassificationInstance

• ClassificationInstance - An instance of ClassificationInstance.

​

from_dict

@classmethod
def from_dict(cls, d: dict) -> Classification

• d dict - A dictionary containing classification information.

• Classification - An instance of Classification.

​

to_dict

def to_dict() -> Dict[str, Any]

• ValueError - If the classification does not have any attributes.

​

add_attribute

def add_attribute(cls: Type[AttributeType],
                  name: str,
                  local_uid: Optional[int] = None,
                  feature_node_hash: Optional[str] = None,
                  required: bool = False) -> AttributeType

• cls Type[AttributeType] - The attribute type, one of RadioAttribute, ChecklistAttribute, TextAttribute.
• name str - The user-visible name of the attribute.
• local_uid Optional[int] - Integer identifier of the attribute. Normally auto-generated; omit this unless the aim is to create an exact clone of an existing ontology.
• feature_node_hash Optional[str] - Global identifier of the attribute. Normally auto-generated; omit this unless the aim is to create an exact clone of an existing ontology.
• required bool - Whether the label editor would mark this attribute as ‘required’.

• AttributeType - The created attribute that can be further specified with Options, where appropriate.

• ValueError - If the classification already has an attribute assigned.