Class InstanceSegmentationLabeler

Produces instance segmentation for each frame.

Inheritance
object
CameraLabeler
InstanceSegmentationLabeler
Implements
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.Labelers
Assembly: Unity.Perception.Runtime.dll
Syntax
[Serializable]
[MovedFrom("UnityEngine.Perception.GroundTruth")]
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
[Tooltip("The id to associate with instance segmentation annotations in the dataset.")]
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

imageReadback

An event called each frame after the instance segmentation image is read back from the GPU. The first returned parameter is the Time.frameCount when the frame was captured, the second is the readback pixel data, and the final parameter is the source segmentation texture.

Declaration
public Action<int, NativeArray<Color32>, RenderTexture> imageReadback
Field Value
Type Description
Action<int, NativeArray<Color32>, RenderTexture>

Properties

description

A human-readable description of the labeler

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

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

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

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

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
bool
Overrides

Methods

Cleanup()

Called when the Labeler is about to be destroyed or removed from the PerceptionCamera. Use this to clean up to state.

Declaration
protected override void Cleanup()
Overrides

OnEndRendering(ScriptableRenderContext)

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

Declaration
protected override void OnEndRendering(ScriptableRenderContext ctx)
Parameters
Type Name Description
ScriptableRenderContext ctx

The current context from the Scriptable Render Pipeline.
Overrides

Setup()

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

Declaration
protected override void Setup()
Overrides

Implements