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

DepthAnnotation

InstanceSegmentationAnnotation

KeypointAnnotation

NormalAnnotation

PixelPositionAnnotation

SemanticSegmentationAnnotation

Implements

IMessageProducer

Inherited Members

DataModelElement.id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Perception.GroundTruth.DataModel

Assembly: Unity.Perception.Runtime.dll

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

The annotation definition associated with this annotation.

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

Type of the data object

Declaration

public override string modelType { get; }

Property Value

Type	Description
string

Overrides

DataModelElement.modelType

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
bool	Is the component valid?

Overrides

DataModelElement.IsValid()

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

DataModelElement.ToMessage(IMessageBuilder)

Implements

IMessageProducer