Class RayPerceptionSensor
A sensor implementation that supports ray cast-based observations.
Implements
Inherited Members
Namespace: Unity.MLAgents.Sensors
Assembly: solution.dll
Syntax
public class RayPerceptionSensor : ISensorConstructors
| Name | Description |
|---|---|
| RayPerceptionSensor(string, RayPerceptionInput) | Creates the RayPerceptionSensor. |
Properties
| Name | Description |
|---|---|
| RayPerceptionOutput | The most recent raycast results. |
Methods
| Name | Description |
|---|---|
| GetBuiltInSensorType() | Return the corresponding BuiltInSensorType for the sensor. |
| GetCompressedObservation() | Return a compressed representation of the observation. For small observations, this should generally not be implemented. However, compressing large observations (such as visual results) can significantly improve model training time. |
| GetCompressionSpec() | Return information on the compression type being used. If no compression is used, return Default(). |
| GetName() | Get the name of the sensor. This is used to ensure deterministic sorting of the sensors on an Agent, so the naming must be consistent across all sensors and agents. |
| GetObservationSpec() | Returns a description of the observations that will be generated by the sensor. See ObservationSpec for more details, and helper methods to create one. |
| Perceive(RayPerceptionInput, bool) | Evaluates the raycasts to be used as part of an observation of an agent. |
| Reset() | Resets the internal state of the sensor. This is called at the end of an Agent's episode. Most implementations can leave this empty. |
| Update() | Update any internal state of the sensor. This is called once per each agent step. |
| Write(ObservationWriter) | Computes the ray perception observations and saves them to the provided ObservationWriter. |