Taxonomy format#

Section covering the formats for all Taxonomy objects. Taxonomies define a labeling schema for your RedBrick AI projects.

class redbrick.types.taxonomy.AttributeOption#

Attribute Option.

name: str#

optionId: int#

color: str#

archived: bool#

class redbrick.types.taxonomy.Attribute#

Attribute.

name: str#

attrType: Literal['BOOL', 'TEXT', 'SELECT', 'MULTISELECT']#

attrId: int#

options: Optional[List[AttributeOption]]#: For attrType SELECT and MULTISELECT this defines the list of selection options.

archived: bool#

parents: Optional[List[str]]#: Defining parents will add a nested structure to the taxonomy. Multiple attributes with parent [“Type A”] will be visually nested under a expansion panel Type A in the user interface.

Note

Only supported for Classifications, not for Object Attributes.

hint: Optional[str]#: A string containing raw text, or HTML. The hints will appear in the viewer.

defaultValue: Union[str, bool, int, List[int], None]#: For SELECT or MULTISELECT types, defaultValue will pre-populate the UI with the selection.

class redbrick.types.taxonomy.ObjectType#

Object’s are used to annotate features or objects in tasks.

category: str#: Category of the Taxonomy object is a string descriptor.

classId: int#: A unique integer for this object. Segmentation files can be exported to contain classId as the values in the file.

labelType: Literal['BBOX', 'CUBOID', 'POINT', 'POLYLINE', 'POLYGON', 'ELLIPSE', 'SEGMENTATION', 'LENGTH', 'ANGLE']#: They type of label for this object.

attributes: Optional[List[Attribute]]#: Attributes allow further classification of objects.

color: str#

archived: bool#

parents: Optional[List[str]]#: Defining parents will add a nested structure to the taxonomy. Multiple objects with parent [“Type A”] will be visually nested under a expansion panel Type A in the user interface.

hint: Optional[str]#: A string containing raw text, or HTML. The hints will appear in the viewer.

class redbrick.types.taxonomy.Taxonomy#

Taxonomy object.

orgId: str#

taxId: str#

name: str#

studyClassify: List[Attribute]#

seriesClassify: List[Attribute]#

instanceClassify: List[Attribute]#

objectTypes: List[ObjectType]#

createdAt: str#

archived: bool#

isNew: bool#