Class DatasetCapture
Global manager for frame scheduling and output capture for simulations. Data capture follows the schema defined in TODO: Expose schema publicly
Namespace: UnityEngine.Perception.GroundTruth
Syntax
public static class DatasetCapture : objectProperties
perceptionVersion
The current perception version
Declaration
public static string perceptionVersion { get; }Property Value
| Type | Description |
|---|---|
| String |
schemaVersion
The json metadata schema version the DatasetCapture's output conforms to.
Declaration
public static string schemaVersion { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
GetSequenceAndStepFromFrame(Int32)
Retrieves the sequence and step numbers from a simulation frame.
Declaration
public static (int sequence, int step) GetSequenceAndStepFromFrame(int frame)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | frame | The simulation frame |
Returns
| Type | Description |
|---|---|
| (, )<Int32, Int32> | The sequence and step numbers |
RegisterAnnotationDefinition(AnnotationDefinition)
Registers an annotation with the running simulation.
Declaration
public static void RegisterAnnotationDefinition(AnnotationDefinition definition)Parameters
| Type | Name | Description |
|---|---|---|
| AnnotationDefinition | definition | The annotation to register |
RegisterMetric(MetricDefinition)
Registers a metric with the running simulation.
Declaration
public static void RegisterMetric(MetricDefinition metricDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| MetricDefinition | metricDefinition | The metric to register |
RegisterSensor(SensorDefinition)
Registers a sensor with the current simulation.
Declaration
public static SensorHandle RegisterSensor(SensorDefinition sensor)Parameters
| Type | Name | Description |
|---|---|---|
| SensorDefinition | sensor | The sensor to register |
Returns
| Type | Description |
|---|---|
| SensorHandle | A handle to the registered sensor |
ReportMetadata(String, Boolean)
Report simulation metadata
Declaration
public static void ReportMetadata(string key, bool value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| Boolean | value | The value of the metadata |
ReportMetadata(String, Boolean[])
Report simulation metadata
Declaration
public static void ReportMetadata(string key, bool[] value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| Boolean[] | value | The value of the metadata |
ReportMetadata(String, Int32)
Report simulation metadata
Declaration
public static void ReportMetadata(string key, int value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| Int32 | value | The value of the metadata |
ReportMetadata(String, Int32[])
Report simulation metadata
Declaration
public static void ReportMetadata(string key, int[] value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| Int32[] | value | The value of the metadata |
ReportMetadata(String, Single)
Report simulation metadata
Declaration
public static void ReportMetadata(string key, float value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| Single | value | The value of the metadata |
ReportMetadata(String, Single[])
Report simulation metadata
Declaration
public static void ReportMetadata(string key, float[] value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| Single[] | value | The value of the metadata |
ReportMetadata(String, String)
Report simulation metadata
Declaration
public static void ReportMetadata(string key, string value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| String | value | The value of the metadata |
ReportMetadata(String, String[])
Report simulation metadata
Declaration
public static void ReportMetadata(string key, string[] value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| String[] | value | The value of the metadata |
ReportMetadata(String, UInt32)
Report simulation metadata
Declaration
public static void ReportMetadata(string key, uint value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key of the metadata |
| UInt32 | value | The value of the metadata |
ReportMetric(MetricDefinition)
Declaration
public static AsyncFuture<Metric> ReportMetric(MetricDefinition definition)Parameters
| Type | Name | Description |
|---|---|---|
| MetricDefinition | definition |
Returns
| Type | Description |
|---|---|
| AsyncFuture<Metric> |
ReportMetric(MetricDefinition, Metric)
Declaration
public static void ReportMetric(MetricDefinition definition, Metric metric)Parameters
| Type | Name | Description |
|---|---|---|
| MetricDefinition | definition | |
| Metric | metric |
ResetSimulation()
Shuts down the active simulation and starts a new simulation.
Declaration
public static void ResetSimulation()StartNewSequence()
Starts a new sequence in the capture.
Declaration
public static void StartNewSequence()Events
SimulationEnding
Called when the simulation ends. The simulation ends on playmode exit, application exit, or when ResetSimulation() is called.
Declaration
public static event Action SimulationEndingEvent Type
| Type | Description |
|---|---|
| Action |