Skip to main content

​
Object Objects

@dataclass
class Object(OntologyElement)

​
title

@property
def title() -> str
Returns the name of the object, used as the title.

​
children

@property
def children() -> Sequence[OntologyElement]
Returns the attributes of the object as its children.

​
create_instance

def create_instance() -> ObjectInstance
Create a :class:encord.objects.ObjectInstance to be used with a label row. Returns:
  • ObjectInstance - An instance of the object to be used in labeling.

​
from_dict

@classmethod
def from_dict(cls, d: dict) -> Object
Create an Object from a dictionary. Arguments:
  • d - A dictionary representing the object.
Returns:
  • Object - The created Object instance.
Raises:
  • TypeError - If the shape in the dictionary is not recognized.

​
to_dict

def to_dict() -> Dict[str, Any]
Convert the Object to a dictionary. Returns: Dict[str, Any]: The dictionary representation of the object.

​
add_attribute

def add_attribute(cls: Type[AttributeType],
                  name: str,
                  local_uid: Optional[int] = None,
                  feature_node_hash: Optional[str] = None,
                  required: bool = False,
                  dynamic: bool = False) -> AttributeType
Adds an attribute to the object. Arguments:
  • cls - The 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 an 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 an existing ontology.
  • required - Whether the label editor would mark this attribute as ‘required’.
  • dynamic - Whether the attribute can have a different answer for the same object across different frames.
Returns:
  • AttributeType - The created attribute that can be further specified with options, where appropriate.
Raises:
  • ValueError - If the specified local_uid or feature_node_hash violate uniqueness constraints.