Class Frame

The top level structure that holds all of the artifacts of a simulation frame. This is only reported after all of the captures, annotations, and metrics are ready to report for a single frame.

Inheritance

object

DataModelElement

Frame

Implements

IMessageProducer

Inherited Members

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.DataModel

Assembly: Unity.Perception.Runtime.dll

Syntax

public class Frame : DataModelElement, IMessageProducer

Constructors

Frame(int, int, int, float)

Creates a new frame.

Declaration

public Frame(int frame, int sequence, int step, float timestamp)

Parameters

Type	Name	Description
int	frame	The simulation frame ID
int	sequence	The sequence ID
int	step	The step inside the sequence of the frame
float	timestamp	The timestamp of the frame

Properties

frame

The perception frame number of this record

Declaration

public int frame { get; }

Property Value

Type	Description
int

metrics

A list of all of the metrics recorded recorded for the frame.

Declaration

public List<Metric> metrics { get; }

Property Value

Type	Description
List<Metric>

modelType

Data model type for Frame

Declaration

public override string modelType { get; }

Property Value

Type	Description
string

Overrides

DataModelElement.modelType

sensors

A list of all of the sensor captures recorded for the frame.

Declaration

public List<Sensor> sensors { get; set; }

Property Value

Type	Description
List<Sensor>

sequence

The sequence that this record is a part of

Declaration

public int sequence { get; }

Property Value

Type	Description
int

step

The step in the sequence that this record is a part of

Declaration

public int step { get; }

Property Value

Type	Description
int

timestamp

The timestamp of the frame

Declaration

public float timestamp { get; }

Property Value

Type	Description
float

Methods

IsValid()

Is the component valid?

Declaration

public override bool IsValid()

Returns

Type	Description
bool	Is the component valid?

Overrides

DataModelElement.IsValid()

ToMessage(IMessageBuilder)

Convert contents int a message.

Declaration

public override void ToMessage(IMessageBuilder builder)

Parameters

Type	Name	Description
IMessageBuilder	builder	The message builder that will convert the class's contents into a message

Overrides

DataModelElement.ToMessage(IMessageBuilder)

Implements

IMessageProducer