docs.unity3d.com
    Show / Hide Table of Contents

    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
    InstanceSegmentationDefinition
    KeypointAnnotationDefinition
    SemanticSegmentationDefinition
    Inherited Members
    DataModelElement.modelType
    DataModelElement.id
    Namespace: UnityEngine.Perception.GroundTruth.DataModel
    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
    Boolean

    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)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023