Class IdLabelConfig | Perception | 0.5.0-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class IdLabelConfig

    A definition for how a Labeling should be resolved to a single label and id for ground truth generation.

    Inheritance
    Object
    Object
    ScriptableObject
    LabelConfig<IdLabelEntry>
    IdLabelConfig
    Inherited Members
    LabelConfig<IdLabelEntry>.labelEntriesFieldName
    LabelConfig<IdLabelEntry>.labelEntries
    LabelConfig<IdLabelEntry>.TryGetMatchingConfigurationEntry(Labeling, IdLabelEntry)
    LabelConfig<IdLabelEntry>.Init(IEnumerable<IdLabelEntry>)
    LabelConfig<IdLabelEntry>.TryGetMatchingConfigurationEntry(Labeling, IdLabelEntry, Int32)
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.Perception.GroundTruth
    Syntax
    [CreateAssetMenu(fileName = "IdLabelConfig", menuName = "Perception/ID Label Config", order = 1)]
    public class IdLabelConfig : LabelConfig<IdLabelEntry>

    Fields

    autoAssignIds

    Whether the inspector will auto-assign ids based on the id of the first element.

    Declaration
    public bool autoAssignIds
    Field Value
    Type Description
    Boolean

    startingLabelId

    Whether the inspector will start label ids at zero or one when autoAssignIds is enabled.

    Declaration
    public StartingLabelId startingLabelId
    Field Value
    Type Description
    StartingLabelId

    Methods

    OnInit()

    Called when the labelEntries list is assigned using Init(IEnumerable<T>)

    Declaration
    protected override void OnInit()
    Overrides
    UnityEngine.Perception.GroundTruth.LabelConfig<UnityEngine.Perception.GroundTruth.IdLabelEntry>.OnInit()

    TryGetLabelEntryFromInstanceId(UInt32, out IdLabelEntry)

    Attempts to find the label id for the given instance id.

    Declaration
    public bool TryGetLabelEntryFromInstanceId(uint instanceId, out IdLabelEntry labelEntry)
    Parameters
    Type Name Description
    UInt32 instanceId

    The instanceId of the object for which the labelId should be found

    IdLabelEntry labelEntry

    The LabelEntry associated with the object. default if not found

    Returns
    Type Description
    Boolean

    True if a labelId is found for the given instanceId.

    TryGetLabelEntryFromInstanceId(UInt32, out IdLabelEntry, out Int32)

    Attempts to find the label id for the given instance id.

    Declaration
    public bool TryGetLabelEntryFromInstanceId(uint instanceId, out IdLabelEntry labelEntry, out int index)
    Parameters
    Type Name Description
    UInt32 instanceId

    The instanceId of the object for which the labelId should be found

    IdLabelEntry labelEntry

    The LabelEntry associated with the object. default if not found

    Int32 index

    The index of the found LabelEntry in labelEntries. -1 if not found

    Returns
    Type Description
    Boolean

    True if a labelId is found for the given instanceId.

    Back to top
    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