Class Annotation

Abstract class that holds the common data found in all annotations. Concrete instances of this class will add data for their specific annotation type.

Inheritance
Object
DataModelElement
Annotation
BoundingBox3DAnnotation
BoundingBoxAnnotation
InstanceSegmentationAnnotation
KeypointAnnotation
SemanticSegmentationAnnotation
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.DataModel
Syntax
public abstract class Annotation : DataModelElement, IMessageProducer

Constructors

Annotation(AnnotationDefinition, String)

Create a new annotation.

Declaration
protected Annotation(AnnotationDefinition definition, string sensorId)
Parameters
Type Name Description
AnnotationDefinition definition

The definition of the annotation
String sensorId

The ID of the sensor that recorded the image for this annotation

Fields

m_Definition

Declaration
protected AnnotationDefinition m_Definition
Field Value
Type Description
AnnotationDefinition

Properties

annotationId

The annotation ID.

Declaration
public string annotationId { get; }
Property Value
Type Description
String

description

The description of the annotation.

Declaration
public string description { get; }
Property Value
Type Description
String

modelType

Declaration
public override string modelType { get; }
Property Value
Type Description
String
Overrides

sensorId

The sensor that this annotation is associated with.

Declaration
public string sensorId { get; }
Property Value
Type Description
String

Methods

IsValid()

Is the component valid?

Declaration
public override bool IsValid()
Returns
Type Description
Boolean

Is the component valid?
Overrides

ToMessage(IMessageBuilder)

Convert contents int a message.

Declaration
public override void ToMessage(IMessageBuilder builder)
Parameters
Type Name Description
IMessageBuilder builder

The message builder that will convert the class's contents into a message
Overrides