Class DepthAnnotation

The depth image recorded for a capture.

Inheritance

object

DataModelElement

Annotation

DepthAnnotation

Implements

IMessageProducer

Inherited Members

Annotation.m_Definition

Annotation.annotationId

Annotation.modelType

Annotation.description

Annotation.sensorId

Annotation.IsValid()

DataModelElement.id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Perception.GroundTruth.Labelers

Assembly: Unity.Perception.Runtime.dll

Syntax

[MovedFrom("UnityEngine.Perception.GroundTruth")]
public class DepthAnnotation : Annotation, IMessageProducer

Constructors

DepthAnnotation(DepthDefinition, string, DepthMeasurementStrategy, ImageEncodingFormat, Vector2, byte[])

Constructs a new DepthAnnotation.

Declaration

public DepthAnnotation(DepthDefinition definition, string sensorId, DepthMeasurementStrategy measurementStrategy, ImageEncodingFormat imageFormat, Vector2 dimension, byte[] buffer)

Parameters

Type	Name	Description
DepthDefinition	definition	The depth annotation definition.
string	sensorId	The sensor's string id.
DepthMeasurementStrategy	measurementStrategy	The measurement strategy used to capture the depth image.
ImageEncodingFormat	imageFormat	The encoding format of the depth image.
Vector2	dimension	The width and height of the depth image in pixels.
byte[]	buffer	The encoded range image data.

Properties

buffer

The encoded range image data.

Declaration

public byte[] buffer { get; set; }

Property Value

Type	Description
byte[]

dimension

The range image's width and height in pixels.

Declaration

public Vector2 dimension { get; set; }

Property Value

Type	Description
Vector2

imageFormat

The encoding format (png, exr, etc.) of the depth image.

Declaration

public ImageEncodingFormat imageFormat { get; set; }

Property Value

Type	Description
ImageEncodingFormat

measurementStrategy

The measurement strategy used to capture the depth image.

Declaration

public DepthMeasurementStrategy measurementStrategy { get; set; }

Property Value

Type	Description
DepthMeasurementStrategy

Methods

ToMessage(IMessageBuilder)

Add image information about the depth image to message builder

Declaration

public override void ToMessage(IMessageBuilder builder)

Parameters

Type	Name	Description
IMessageBuilder	builder	The capture message to nest this annotation within.

Overrides

Annotation.ToMessage(IMessageBuilder)

Implements

IMessageProducer