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.
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.DataModel
Syntax
public class Frame : DataModelElement, IMessageProducerConstructors
Frame(Int32, Int32, Int32, Single)
Creates a new frame.
Declaration
public Frame(int frame, int sequence, int step, float timestamp)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | frame | The simulation frame ID |
| Int32 | sequence | The sequence ID |
| Int32 | step | The step inside the sequence of the frame |
| Single | timestamp | The timestamp of the frame |
Properties
frame
The perception frame number of this record
Declaration
public int frame { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
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
Declaration
public override string modelType { get; }Property Value
| Type | Description |
|---|---|
| String |
Overrides
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 |
|---|---|
| Int32 |
step
The step in the sequence that this record is a part of
Declaration
public int step { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
timestamp
The timestamp of the frame
Declaration
public float timestamp { get; }Property Value
| Type | Description |
|---|---|
| Single |
Methods
IsValid()
Is the component valid?
Declaration
public override bool IsValid()Returns
| Type | Description |
|---|---|
| Boolean | Is the component valid? |
Overrides
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 |