carla/PythonAPI/docs/sensor_data.yml

---
- module_name: carla
  doc: >
  # - CLASSES ------------------------------
  classes:
  - class_name: SensorData
    # - DESCRIPTION ------------------------
    doc: >
      Base class for all the objects containing data generated by a sensor.
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: frame
      doc: >
        Frame count when the data was generated.
    - var_name: timestamp
      doc: >
        Simulation-time when the data was generated.
    - var_name: transform
      doc: >
        Sensor's transform when the data was generated.
    # --------------------------------------

  - class_name: ColorConverter
    # - DESCRIPTION ------------------------
    doc: >
      Defines the color converter options.
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: Raw
      doc: >
    - var_name: Depth
      doc: >
    - var_name: LogarithmicDepth
      doc: >
    - var_name: CityScapesPalette
      doc: >

  - class_name: Image
    parent: carla.SensorData
    # - DESCRIPTION ------------------------
    doc: >
      Defines an image of 32-bit BGRA colors.
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: width
      type: int
      doc: >
        Image width in pixels.
    - var_name: height
      type: int
      doc: >
        Image height in pixels
    - var_name: fov
      type: float
      doc: >
        Horizontal field of view of the image in degrees.
    - var_name: raw_data
      type: bytes
      doc: >
    # - METHODS ----------------------------
    methods:
    - def_name: convert
      params:
      - param_name: color_converter
        type: carla.ColorConverter
      doc: >
    # --------------------------------------
    - def_name: save_to_disk
      params:
      - param_name: path
        type: str
      - param_name: color_converter
        type: carla.ColorConverter
        default: Raw
      doc: >
    # --------------------------------------
    - def_name: __len__
      doc: >
    # --------------------------------------
    - def_name: __iter__
      doc: >
    # --------------------------------------
    - def_name: __getitem__
      params:
      - param_name: pos
        type: int
      doc: >
    # --------------------------------------
    - def_name: __setitem__
      params:
      - param_name: pos
        type: int
      - param_name: color
        type: carla.Color
      doc: >
    # --------------------------------------
    - def_name: __str__
      doc: >
    # --------------------------------------

  - class_name: LidarMeasurement
    parent: carla.SensorData
    # - DESCRIPTION ------------------------
    doc: >
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: horizontal_angle
      type: float
      doc: >
    - var_name: channels
      type: int
      doc: >
    - var_name: raw_data
      type: bytes
      doc: >
    # - METHODS ----------------------------
    methods:
    - def_name: get_point_count
      params:
      - param_name: channel 
        type: int
      doc: >
    # --------------------------------------
    - def_name: save_to_disk
      params:
      - param_name: path  
        type: str
      doc: >
    # --------------------------------------
    - def_name: __len__
      doc: >
    # --------------------------------------
    - def_name: __iter__
      doc: >
    # --------------------------------------
    - def_name: __getitem__
      params:
      - param_name: pos
        type: int
      doc: >
    # --------------------------------------
    - def_name: __setitem__
      params:
      - param_name: pos
        type: int
      - param_name: location
        type: carla.Location
      doc: >
    # --------------------------------------
    - def_name: __str__
      doc: >
    # --------------------------------------

  - class_name: CollisionEvent
    parent: carla.SensorData
    # - DESCRIPTION ------------------------
    doc: >
      Defines a registered collision.
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: actor
      type: carla.Actor
      doc: >
        Get "self" actor. Actor that measured the collision.
    - var_name: other_actor
      type: carla.Actor
      doc: >
        Get the actor to which we collided.
    - var_name: normal_impulse
      type: carla.Vector3D
      doc: >
        Normal impulse result of the collision.

  - class_name: ObstacleDetectionEvent
    parent: carla.SensorData
    # - DESCRIPTION ------------------------
    doc: >
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: actor
      type: carla.Actor
      doc: >
        Get "self" actor. Actor that measured the collision.
    - var_name: other_actor
      type: carla.Actor
      doc: >
        Get the actor to which we collided.
    - var_name: distance
      type: float
      doc: >
        Get obstacle distance.
    # - METHODS ----------------------------
    methods:
    - def_name: __str__
      doc: > 
    # --------------------------------------

  - class_name: LaneInvasionEvent
    parent: carla.SensorData
    # - DESCRIPTION ------------------------
    doc: >
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: actor
      type: carla.Actor
      doc: >
        Get "self" actor. Actor that invaded another lane.
    - var_name: crossed_lane_markings
      type: list(carla.LaneMarking)
      doc: >
        List of lane markings that have been crossed.
    # - METHODS ----------------------------
    methods:
    - def_name: __str__
      doc: > 
    # --------------------------------------

  - class_name: GnssEvent
    parent: carla.SensorData
    # - DESCRIPTION ------------------------
    doc: >
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: latitude
      type: float
      doc: >
    - var_name: longitude
      type: float
      doc: >
    - var_name: altitude
      type: float
      doc: >
    # - METHODS ----------------------------
    methods:
    - def_name: __str__
      doc: > 
    # --------------------------------------
...
Added more documentation 2019-05-03 18:18:02 +08:00			`---`
			`- module_name: carla`
			`doc: >`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - CLASSES ------------------------------`
Added more documentation 2019-05-03 18:18:02 +08:00			`classes:`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- class_name: SensorData`
Added more documentation 2019-05-03 18:18:02 +08:00			`# - DESCRIPTION ------------------------`
			`doc: >`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`Base class for all the objects containing data generated by a sensor.`
Added more documentation 2019-05-03 18:18:02 +08:00			`# - PROPERTIES -------------------------`
			`instance_variables:`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`- var_name: frame`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Frame count when the data was generated.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: timestamp`
			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Simulation-time when the data was generated.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: transform`
			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Sensor's transform when the data was generated.`
Fixed some documentation in py reference 2019-07-03 00:32:23 +08:00			`# --------------------------------------`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00
			`- class_name: ColorConverter`
			`# - DESCRIPTION ------------------------`
			`doc: >`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`Defines the color converter options.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - PROPERTIES -------------------------`
			`instance_variables:`
			`- var_name: Raw`
			`doc: >`
			`- var_name: Depth`
			`doc: >`
			`- var_name: LogarithmicDepth`
			`doc: >`
			`- var_name: CityScapesPalette`
			`doc: >`

			`- class_name: Image`
Added inheritance in PythonAPI docs 2019-06-05 21:05:57 +08:00			`parent: carla.SensorData`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - DESCRIPTION ------------------------`
			`doc: >`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`Defines an image of 32-bit BGRA colors.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - PROPERTIES -------------------------`
			`instance_variables:`
			`- var_name: width`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Added and fixed some classes information 2019-07-03 22:17:51 +08:00			`Image width in pixels.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: height`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Added and fixed some classes information 2019-07-03 22:17:51 +08:00			`Image height in pixels`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: fov`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: float`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Added and fixed some classes information 2019-07-03 22:17:51 +08:00			`Horizontal field of view of the image in degrees.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: raw_data`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: bytes`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# - METHODS ----------------------------`
			`methods:`
			`- def_name: convert`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: color_converter`
			`type: carla.ColorConverter`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# --------------------------------------`
			`- def_name: save_to_disk`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: path`
			`type: str`
			`- param_name: color_converter`
			`type: carla.ColorConverter`
			`default: Raw`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# --------------------------------------`
			`- def_name: __len__`
			`doc: >`
			`# --------------------------------------`
			`- def_name: __iter__`
			`doc: >`
			`# --------------------------------------`
			`- def_name: __getitem__`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: pos`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# --------------------------------------`
			`- def_name: __setitem__`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: pos`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`- param_name: color`
			`type: carla.Color`
			`doc: >`
			`# --------------------------------------`
			`- def_name: __str__`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# --------------------------------------`

			`- class_name: LidarMeasurement`
Added inheritance in PythonAPI docs 2019-06-05 21:05:57 +08:00			`parent: carla.SensorData`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - DESCRIPTION ------------------------`
			`doc: >`
			`# - PROPERTIES -------------------------`
			`instance_variables:`
			`- var_name: horizontal_angle`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: float`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`- var_name: channels`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`- var_name: raw_data`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: bytes`
Added more documentation 2019-05-03 18:18:02 +08:00			`doc: >`
			`# - METHODS ----------------------------`
			`methods:`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- def_name: get_point_count`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: channel`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Added more documentation 2019-05-03 18:18:02 +08:00			`doc: >`
			`# --------------------------------------`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- def_name: save_to_disk`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: path`
			`type: str`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# --------------------------------------`
			`- def_name: __len__`
			`doc: >`
			`# --------------------------------------`
			`- def_name: __iter__`
			`doc: >`
			`# --------------------------------------`
			`- def_name: __getitem__`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: pos`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# --------------------------------------`
			`- def_name: __setitem__`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`params:`
			`- param_name: pos`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`type: int`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`- param_name: location`
			`type: carla.Location`
			`doc: >`
			`# --------------------------------------`
			`- def_name: __str__`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`# --------------------------------------`

			`- class_name: CollisionEvent`
Added inheritance in PythonAPI docs 2019-06-05 21:05:57 +08:00			`parent: carla.SensorData`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - DESCRIPTION ------------------------`
			`doc: >`
Added and fixed some classes information 2019-07-03 22:18:21 +08:00			`Defines a registered collision.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - PROPERTIES -------------------------`
			`instance_variables:`
			`- var_name: actor`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: carla.Actor`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Get "self" actor. Actor that measured the collision.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: other_actor`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: carla.Actor`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Get the actor to which we collided.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: normal_impulse`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: carla.Vector3D`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Normal impulse result of the collision.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00
			`- class_name: ObstacleDetectionEvent`
Added inheritance in PythonAPI docs 2019-06-05 21:05:57 +08:00			`parent: carla.SensorData`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - DESCRIPTION ------------------------`
			`doc: >`
			`# - PROPERTIES -------------------------`
			`instance_variables:`
			`- var_name: actor`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: carla.Actor`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Get "self" actor. Actor that measured the collision.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: other_actor`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: carla.Actor`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Get the actor to which we collided.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: distance`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: float`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Get obstacle distance.`
Fixed some documentation in py reference 2019-07-03 00:32:23 +08:00			`# - METHODS ----------------------------`
			`methods:`
			`- def_name: __str__`
			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`# --------------------------------------`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00
			`- class_name: LaneInvasionEvent`
Added inheritance in PythonAPI docs 2019-06-05 21:05:57 +08:00			`parent: carla.SensorData`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - DESCRIPTION ------------------------`
			`doc: >`
			`# - PROPERTIES -------------------------`
			`instance_variables:`
			`- var_name: actor`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: carla.Actor`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`Get "self" actor. Actor that invaded another lane.`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`- var_name: crossed_lane_markings`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: list(carla.LaneMarking)`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`List of lane markings that have been crossed.`
Fixed some documentation in py reference 2019-07-03 00:32:23 +08:00			`# - METHODS ----------------------------`
			`methods:`
			`- def_name: __str__`
			`doc: >`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`# --------------------------------------`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00
			`- class_name: GnssEvent`
Added inheritance in PythonAPI docs 2019-06-05 21:05:57 +08:00			`parent: carla.SensorData`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`# - DESCRIPTION ------------------------`
			`doc: >`
			`# - PROPERTIES -------------------------`
			`instance_variables:`
			`- var_name: latitude`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: float`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`- var_name: longitude`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: float`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
			`- var_name: altitude`
Updated python API reference documentation 2019-07-02 19:10:28 +08:00			`type: float`
Now docs contain all classes, methods & variables 2019-05-03 20:56:18 +08:00			`doc: >`
Fixed some documentation in py reference 2019-07-03 00:32:23 +08:00			`# - METHODS ----------------------------`
			`methods:`
			`- def_name: __str__`
			`doc: >`
			`# --------------------------------------`
Added more documentation 2019-05-03 18:18:02 +08:00			`...`