Class DatasetCapture
Global manager for frame scheduling and output capture for simulations.
Data capture follows the schema defined in TODO: Expose schema publicly
Inheritance
DatasetCapture
Assembly: solution.dll
Syntax
public static class DatasetCapture
Properties
| Name |
Description |
|
SchemaVersion
|
The json metadata schema version the DatasetCapture's output conforms to.
|
Methods
| Name |
Description |
|
RegisterAnnotationDefinition(string, string, string, Guid)
|
Creates an annotation type, which can be used to produce annotations during the simulation.
See ReportAnnotationFile(AnnotationDefinition, string), ReportAnnotationValues<T>(AnnotationDefinition, T[]) and ReportAnnotationAsync(AnnotationDefinition).
|
|
RegisterAnnotationDefinition<TSpec>(string, TSpec[], string, string, Guid)
|
Creates an annotation type, which can be used to produce annotations during the simulation.
See ReportAnnotationFile(AnnotationDefinition, string), ReportAnnotationValues<T>(AnnotationDefinition, T[]) and ReportAnnotationAsync(AnnotationDefinition).
|
|
RegisterEgo(string)
|
Register a new ego. Used along with RegisterSensor to organize sensors under a top-level ego container. RegisterSensor(EgoHandle, string, string, float, float)
|
|
RegisterMetricDefinition(string, string, Guid)
|
Creates a metric type, which can be used to produce metrics during the simulation.
See ReportMetric<T>(MetricDefinition, T[]), ReportMetricAsync(MetricDefinition), ReportMetric<T>(MetricDefinition, T[]),
ReportMetricAsync(MetricDefinition), ReportMetric<T>(MetricDefinition, T[]), ReportMetricAsync(MetricDefinition)
|
|
RegisterMetricDefinition<TSpec>(string, TSpec[], string, Guid)
|
Creates a metric type, which can be used to produce metrics during the simulation.
See ReportMetric<T>(MetricDefinition, T[]), ReportMetricAsync(MetricDefinition), ReportMetric<T>(MetricDefinition, T[]),
ReportMetricAsync(MetricDefinition), ReportMetric<T>(MetricDefinition, T[]), ReportMetricAsync(MetricDefinition)
|
|
RegisterSensor(EgoHandle, string, string, float, float)
|
Register a new sensor under the given ego.
|
|
ReportMetric(MetricDefinition, string)
|
Report a metric not associated with any sensor or annotation.
|
|
ReportMetricAsync(MetricDefinition)
|
Report a metric not associated with any sensor or annotation.
|
|
ReportMetric<T>(MetricDefinition, T[])
|
Report a metric not associated with any sensor or annotation.
|
|
ResetSimulation()
|
Stop the current simulation and start a new one. All pending data is written to disk before returning.
|
|
StartNewSequence()
|
Starts a new sequence in the capture.
|
Events