Class DepthLabeler

A labeler that captures depth images.

Inheritance
object
CameraLabeler
DepthLabeler
Implements
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.Labelers
Assembly: Unity.Perception.Runtime.dll
Syntax
[Serializable]
[MovedFrom("UnityEngine.Perception.GroundTruth")]
public sealed class DepthLabeler : CameraLabeler, IOverlayPanelProvider

Fields

annotationId

The string id used to identify this labeler in the dataset.

Declaration
public string annotationId
Field Value
Type Description
string

measurementStrategy

The capture strategy to use when capturing depth values.

Declaration
[Tooltip("Capturing depth values returns the distance between the surface of the object and the forward plane of the camera. Capturing range values returns the line of sight distance between the surface of the object and the position of the camera.")]
public DepthMeasurementStrategy measurementStrategy
Field Value
Type Description
DepthMeasurementStrategy

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