Class AnnotationDefinition

An annotation definition describes a particular type of annotation and contains an annotation-specific specification describing how annotation data should be mapped back to labels or objects in the scene.

Typically, this specification describes all labels_id and label_name used by the annotation. Some special cases like semantic segmentation might assign additional values (e.g. pixel value) to record the mapping between label_id/label_name and pixel color in the annotated PNG files.

Inheritance

object

DataModelElement

AnnotationDefinition

BoundingBox3DDefinition

BoundingBoxDefinition

DepthDefinition

InstanceSegmentationDefinition

KeypointAnnotationDefinition

NormalDefinition

PixelPositionDefinition

SemanticSegmentationDefinition

Implements

IMessageProducer

Inherited Members

DataModelElement.modelType

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 AnnotationDefinition : DataModelElement, IMessageProducer

Constructors

AnnotationDefinition(string)

Creates an annotation definition file.

Declaration

protected AnnotationDefinition(string id)

Parameters

Type	Name	Description
string	id	The id of the annotation

Properties

description

The description of the annotation.

Declaration

public abstract string description { 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