ClassDescription
The description of a semantic Class.
If an entity is annotated with a corresponding components.ClassId
, Rerun will use
the attached datatypes.AnnotationInfo
to derive labels and colors.
Keypoints within an annotation class can similarly be annotated with a
components.KeypointId
in which case we should defer to the label and color for the
datatypes.AnnotationInfo
specifically associated with the Keypoint.
Keypoints within the class can also be decorated with skeletal edges.
Keypoint-connections are pairs of components.KeypointId
s. If an edge is
defined, and both keypoints exist within the instance of the class, then the
keypoints should be connected with an edge. The edge should be labeled and
colored as described by the class's datatypes.AnnotationInfo
.
Fields fields
info
Type: AnnotationInfo
The datatypes.AnnotationInfo
for the class.
keypoint_annotations
Type: List of AnnotationInfo
The datatypes.AnnotationInfo
for all of the keypoints.
keypoint_connections
Type: List of KeypointPair
The connections between keypoints.
Arrow datatype arrow-datatype
Struct {
info: Struct {
id: uint16
label: nullable utf8
color: nullable uint32
}
keypoint_annotations: List<Struct {
id: uint16
label: nullable utf8
color: nullable uint32
}>
keypoint_connections: List<Struct {
keypoint0: uint16
keypoint1: uint16
}>
}
API reference links api-reference-links
- 🌊 C++ API docs for
ClassDescription
- 🐍 Python API docs for
ClassDescription
- 🦀 Rust API docs for
ClassDescription