Class SensorDefinition

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

Inheritance

object

DataModelElement

SensorDefinition

RgbSensorDefinition

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 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, float, int, bool, string, float)

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
float	firstCaptureFrame	The first capture frame
int	framesBetweenCaptures	Frames between captures
bool	manualSensorsAffectTiming	Do manual sensors affect timing
string	modality	The modality of the sensor
float	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
float

framesBetweenCaptures

The number of frames between captures.

Declaration

public int framesBetweenCaptures

Field Value

Type	Description
int

manualSensorsAffectTiming

Does manual sensors affect timing?

Declaration

public bool manualSensorsAffectTiming

Field Value

Type	Description
bool

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
float

Properties

modelType

Type of the data object

Declaration

public override string modelType { get; }

Property Value

Type	Description
string

Overrides

DataModelElement.modelType

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