Class BoundingBox3DLabeler

Produces 3d bounding box ground truth for all visible and Labeling objects each frame.

Inheritance
object
CameraLabeler
BoundingBox3DLabeler
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.Labelers
Assembly: Unity.Perception.Runtime.dll
Syntax
[MovedFrom("UnityEngine.Perception.GroundTruth")]
public class BoundingBox3DLabeler : CameraLabeler

Constructors

BoundingBox3DLabeler()

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

Declaration
public BoundingBox3DLabeler()

BoundingBox3DLabeler(IdLabelConfig)

Creates a new BoundingBox3DLabeler with the given IdLabelConfig.

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

The label config for resolving the label for each object.

Fields

annotationId

The GUID id to associate with the 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

visualizationColor

Color to use for 3D visualization box

Declaration
public Color visualizationColor
Field Value
Type Description
Color

Properties

description

A human-readable description of the labeler

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

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

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

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 scriptableRenderContext)
Parameters
Type Name Description
ScriptableRenderContext scriptableRenderContext
Overrides

OnUpdate()

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

Declaration
protected override void OnUpdate()
Overrides

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 override void OnVisualize()
Overrides

Setup()

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

Declaration
protected override void Setup()
Overrides

Events

BoundingBoxComputed

Fired when the bounding boxes are computed for a frame.

Declaration
public event Action<int, List<BoundingBox3D>> BoundingBoxComputed
Event Type
Type Description
Action<int, List<BoundingBox3D>>