Class SensorDefinition

Definition class for sensors. UnityEngine.Perception.GroundTruth.DataModel

Inheritance
Object
DataModelElement
SensorDefinition
RgbSensorDefinition
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.DataModel
Syntax
public class SensorDefinition : DataModelElement, IMessageProducer

Constructors

SensorDefinition(String, String, String)

Constructor for the sensor definition.

Declaration
public SensorDefinition(string id, string modality, string description)
Parameters
Type Name Description
String id

The id of the sensor
String modality

The modality of the sensor
String description

The description of the sensor

SensorDefinition(String, CaptureTriggerMode, String, Single, Int32, Boolean, String, Single)

Constructor for the sensor definition.

Declaration
public SensorDefinition(string id, CaptureTriggerMode captureTriggerMode, string description, float firstCaptureFrame, int framesBetweenCaptures, bool manualSensorsAffectTiming, string modality, float simulationDeltaTime)
Parameters
Type Name Description
String id

The id of the sensor
CaptureTriggerMode captureTriggerMode

The capture trigger mode of the sensor
String description

The description of the sensor
Single firstCaptureFrame

The first capture frame
Int32 framesBetweenCaptures

Frames between captures
Boolean manualSensorsAffectTiming

Do manual sensors affect timing
String modality

The modality of the sensor
Single simulationDeltaTime

The simulation delta time

Fields

captureTriggerMode

The capture trigger model for the sensor. captureTriggerMode

Declaration
public CaptureTriggerMode captureTriggerMode
Field Value
Type Description
CaptureTriggerMode

description

The description of the sensor.

Declaration
public string description
Field Value
Type Description
String

firstCaptureFrame

The first capture frame of the sensor.

Declaration
public float firstCaptureFrame
Field Value
Type Description
Single

framesBetweenCaptures

The number of frames between captures.

Declaration
public int framesBetweenCaptures
Field Value
Type Description
Int32

manualSensorsAffectTiming

Does manual sensors affect timing?

Declaration
public bool manualSensorsAffectTiming
Field Value
Type Description
Boolean

modality

The mode of the sensor;

Declaration
public string modality
Field Value
Type Description
String

simulationDeltaTime

The simulation delta time.

Declaration
public float simulationDeltaTime
Field Value
Type Description
Single

Properties

modelType

Declaration
public override string modelType { get; }
Property Value
Type Description
String
Overrides

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
Overrides