Class CameraLabeler

Abstract class for defining custom annotation and metric generation to be run by PerceptionCamera. Instances of CameraLabeler on labelers will be invoked each frame the camera is set to capture data (see ShouldCaptureThisFrame).

Inheritance

object

CameraLabeler

BoundingBox2DLabeler

BoundingBox3DLabeler

DepthLabeler

InstanceSegmentationLabeler

RenderedObjectInfoLabeler

SemanticSegmentationLabeler

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Perception.GroundTruth

Assembly: Unity.Perception.Runtime.dll

Syntax

[Serializable]
public abstract class CameraLabeler

Fields

enabled

Whether the CameraLabeler should be set up and called each frame.

Declaration

public bool enabled

Field Value

Type	Description
bool

Properties

description

A human-readable description of the labeler

Declaration

public abstract string description { get; }

Property Value

Type	Description
string

hudPanel

The heads up display (HUD) panel. Generally used to add stats to the display.

Declaration

public HUDPanel hudPanel { get; }

Property Value

Type	Description
HUDPanel

labelerId

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

Declaration

public abstract string labelerId { get; }

Property Value

Type	Description
string

overlayPanel

The overlay panel. Used to control which full screen image visual is displayed.

Declaration

public OverlayPanel overlayPanel { get; }

Property Value

Type	Description
OverlayPanel

perceptionCamera

The PerceptionCamera that contains this labeler.

Declaration

protected PerceptionCamera perceptionCamera { get; }

Property Value

Type	Description
PerceptionCamera

sensorHandle

The SensorHandle for the PerceptionCamera that contains this labeler. Use this to report annotations and metrics.

Declaration

protected SensorHandle sensorHandle { get; }

Property Value

Type	Description
SensorHandle

supportsVisualization

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

Declaration

protected abstract bool supportsVisualization { get; }

Property Value

Type	Description
bool

visualizationEnabled

Turns on/off the labeler's realtime visualization capability. If a labeler does not support realtime visualization (supportsVisualization) or visualization is not enabled on the PerceptionCamera this will not function.

Declaration

public bool visualizationEnabled { get; set; }

Property Value

Type	Description
bool

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 virtual void Cleanup()

OnBeginRendering(ScriptableRenderContext)

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

Declaration

protected virtual void OnBeginRendering(ScriptableRenderContext scriptableRenderContext)

Parameters

Type	Name	Description
ScriptableRenderContext	scriptableRenderContext	The current context from the Scriptable Render Pipeline.

OnEndRendering(ScriptableRenderContext)

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

Declaration

protected virtual void OnEndRendering(ScriptableRenderContext ctx)

Parameters

Type	Name	Description
ScriptableRenderContext	ctx	The current context from the Scriptable Render Pipeline.

OnUpdate()

Called during the Update each frame the the labeler is enabled and ShouldCaptureThisFrame is true.

Declaration

protected virtual void OnUpdate()

OnVisualize()

Labeling pass to display labeler's visualization components, if applicable. Important note, all labeler's visualizations need to use Unity's Immediate Mode GUI (IMGUI) https://docs.unity3d.com/Manual/GUIScriptingGuide.html system. This called is triggered from OnGUI() call. This call happens immediately before OnVisualizeAdditionalUI() so that the visualization components are drawn below the UI elements.

Declaration

protected virtual void OnVisualize()

OnVisualizeAdditionalUI()

In this pass, a labeler can add custom GUI controls to the scene. Important note, all labeler's additional GUIs need to use Unity's Immediate Mode GUI (IMGUI) https://docs.unity3d.com/Manual/GUIScriptingGuide.html system. This called is triggered from OnGUI() call. This call happens immediately after the OnVisualize() so that the visualization components are drawn below the UI elements.

Declaration

protected virtual void OnVisualizeAdditionalUI()

OnVisualizerEnabledChanged(bool)

Called when the labeler's visualization capability is turned on or off.

Declaration

protected virtual void OnVisualizerEnabledChanged(bool visualizerEnabled)

Parameters

Type	Name	Description
bool	visualizerEnabled	The current enabled state of the visualizer

Setup()

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

Declaration

protected virtual void Setup()