docs.unity3d.com
    Show / Hide Table of Contents

    Class InstanceSegmentationLabeler

    Produces instance segmentation for each frame.

    Inheritance
    Object
    CameraLabeler
    InstanceSegmentationLabeler
    Inherited Members
    CameraLabeler.enabled
    CameraLabeler.hudPanel
    CameraLabeler.overlayPanel
    CameraLabeler.perceptionCamera
    CameraLabeler.sensorHandle
    CameraLabeler.OnVisualizerEnabledChanged(Boolean)
    CameraLabeler.OnUpdate()
    CameraLabeler.OnEndRendering(ScriptableRenderContext)
    CameraLabeler.OnVisualize()
    CameraLabeler.OnVisualizeAdditionalUI()
    CameraLabeler.Cleanup()
    Namespace: UnityEngine.Perception.GroundTruth
    Syntax
    public sealed class InstanceSegmentationLabeler : CameraLabeler, IOverlayPanelProvider

    Constructors

    InstanceSegmentationLabeler()

    Creates a new InstanceSegmentationLabeler. Be sure to assign idLabelConfig before adding to a PerceptionCamera.

    Declaration
    public InstanceSegmentationLabeler()

    InstanceSegmentationLabeler(IdLabelConfig)

    Creates a new InstanceSegmentationLabeler with the given IdLabelConfig.

    Declaration
    public InstanceSegmentationLabeler(IdLabelConfig labelConfig)
    Parameters
    Type Name Description
    IdLabelConfig labelConfig

    The label config for resolving the label for each object.

    Fields

    annotationId

    The GUID to associate with annotations produced by this labeler.

    Declaration
    public string annotationId
    Field Value
    Type Description
    String

    idLabelConfig

    The idLabelConfig which associates objects with labels.

    Declaration
    public IdLabelConfig idLabelConfig
    Field Value
    Type Description
    IdLabelConfig

    Properties

    description

    A human-readable description of the labeler

    Declaration
    public override string description { get; }
    Property Value
    Type Description
    String
    Overrides
    CameraLabeler.description

    label

    Interface that should be defined by a class that wants to be able to provide a image to the overlay panel.

    Declaration
    public string label { get; }
    Property Value
    Type Description
    String
    Implements
    IOverlayPanelProvider.label

    labelerId

    The GUID id to associate with the data produced by this labeler.

    Declaration
    public override string labelerId { get; }
    Property Value
    Type Description
    String
    Overrides
    CameraLabeler.labelerId

    overlayImage

    Interface that should be defined by a class that wants to be able to provide a image to the overlay panel.

    Declaration
    public Texture overlayImage { get; }
    Property Value
    Type Description
    Texture
    Implements
    IOverlayPanelProvider.overlayImage

    supportsVisualization

    Labelers should set this in their setup to define if they support realtime visualization of their data.

    Declaration
    protected override bool supportsVisualization { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    CameraLabeler.supportsVisualization

    Methods

    OnBeginRendering(ScriptableRenderContext)

    Called just before the camera renders each frame the the labeler is enabled and ShouldCaptureThisFrame is true.

    Declaration
    protected override void OnBeginRendering(ScriptableRenderContext scriptableRenderContext)
    Parameters
    Type Name Description
    ScriptableRenderContext scriptableRenderContext

    The current context from the Scriptable Render Pipeline.

    Overrides
    CameraLabeler.OnBeginRendering(ScriptableRenderContext)

    Setup()

    Called just before the first call to OnUpdate() or OnBeginRendering(ScriptableRenderContext). Implement this to initialize state.

    Declaration
    protected override void Setup()
    Overrides
    CameraLabeler.Setup()
    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