Class BoundingBox2DLabeler

Produces 2d bounding box annotations for all visible objects each frame.

Inheritance
Object
CameraLabeler
BoundingBox2DLabeler
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth
Syntax
[Serializable]
public sealed class BoundingBox2DLabeler : CameraLabeler

Constructors

BoundingBox2DLabeler()

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

Declaration
public BoundingBox2DLabeler()

BoundingBox2DLabeler(IdLabelConfig)

Creates a new BoundingBox2DLabeler with the given IdLabelConfig.

Declaration
public BoundingBox2DLabeler(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
[FormerlySerializedAs("labelingConfiguration")]
public IdLabelConfig idLabelConfig
Field Value
Type Description
IdLabelConfig

Properties

description

A human-readable description of the labeler

Declaration
public override string description { get; protected set; }
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
Boolean
Overrides

Methods

OnBeginRendering()

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

Declaration
protected override void OnBeginRendering()
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) system. This called is triggered from 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(). Implement this to initialize state.

Declaration
protected override void Setup()
Overrides