# {py:mod}`kompass.data_types`

```{py:module} kompass.data_types
```

```{autodoc2-docstring} kompass.data_types
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Detections <kompass.data_types.Detections>`
  - ```{autodoc2-docstring} kompass.data_types.Detections
    :summary:
    ```
* - {py:obj}`Trackings <kompass.data_types.Trackings>`
  - ```{autodoc2-docstring} kompass.data_types.Trackings
    :summary:
    ```
* - {py:obj}`CameraInfo <kompass.data_types.CameraInfo>`
  - ```{autodoc2-docstring} kompass.data_types.CameraInfo
    :summary:
    ```
* - {py:obj}`LaserScan <kompass.data_types.LaserScan>`
  - ```{autodoc2-docstring} kompass.data_types.LaserScan
    :summary:
    ```
* - {py:obj}`PointCloud2 <kompass.data_types.PointCloud2>`
  - ```{autodoc2-docstring} kompass.data_types.PointCloud2
    :summary:
    ```
* - {py:obj}`PointStamped <kompass.data_types.PointStamped>`
  - ```{autodoc2-docstring} kompass.data_types.PointStamped
    :summary:
    ```
* - {py:obj}`Point <kompass.data_types.Point>`
  - ```{autodoc2-docstring} kompass.data_types.Point
    :summary:
    ```
* - {py:obj}`Pose <kompass.data_types.Pose>`
  - ```{autodoc2-docstring} kompass.data_types.Pose
    :summary:
    ```
* - {py:obj}`PoseStamped <kompass.data_types.PoseStamped>`
  - ```{autodoc2-docstring} kompass.data_types.PoseStamped
    :summary:
    ```
* - {py:obj}`Odometry <kompass.data_types.Odometry>`
  - ```{autodoc2-docstring} kompass.data_types.Odometry
    :summary:
    ```
* - {py:obj}`TwistStamped <kompass.data_types.TwistStamped>`
  - ```{autodoc2-docstring} kompass.data_types.TwistStamped
    :summary:
    ```
* - {py:obj}`TwistArray <kompass.data_types.TwistArray>`
  - ```{autodoc2-docstring} kompass.data_types.TwistArray
    :summary:
    ```
* - {py:obj}`Path <kompass.data_types.Path>`
  - ```{autodoc2-docstring} kompass.data_types.Path
    :summary:
    ```
````

### API

````{py:class} Detections
:canonical: kompass.data_types.Detections

Bases: {py:obj}`ros_sugar.supported_types.SupportedType`

```{autodoc2-docstring} kompass.data_types.Detections
```

````

````{py:class} Trackings
:canonical: kompass.data_types.Trackings

Bases: {py:obj}`ros_sugar.supported_types.SupportedType`

```{autodoc2-docstring} kompass.data_types.Trackings
```

````

````{py:class} CameraInfo
:canonical: kompass.data_types.CameraInfo

Bases: {py:obj}`ros_sugar.supported_types.SupportedType`

```{autodoc2-docstring} kompass.data_types.CameraInfo
```

````

`````{py:class} LaserScan
:canonical: kompass.data_types.LaserScan

Bases: {py:obj}`ros_sugar.supported_types.LaserScan`

```{autodoc2-docstring} kompass.data_types.LaserScan
```

````{py:method} convert(output: kompass_core.datatypes.LaserScanData, **_) -> sensor_msgs.msg.LaserScan
:canonical: kompass.data_types.LaserScan.convert
:classmethod:

```{autodoc2-docstring} kompass.data_types.LaserScan.convert
```

````

`````

````{py:class} PointCloud2
:canonical: kompass.data_types.PointCloud2

Bases: {py:obj}`ros_sugar.supported_types.SupportedType`

```{autodoc2-docstring} kompass.data_types.PointCloud2
```

````

````{py:class} PointStamped
:canonical: kompass.data_types.PointStamped

Bases: {py:obj}`ros_sugar.supported_types.PointStamped`

```{autodoc2-docstring} kompass.data_types.PointStamped
```

````

````{py:class} Point
:canonical: kompass.data_types.Point

Bases: {py:obj}`ros_sugar.supported_types.Point`

```{autodoc2-docstring} kompass.data_types.Point
```

````

````{py:class} Pose
:canonical: kompass.data_types.Pose

Bases: {py:obj}`ros_sugar.supported_types.Pose`

```{autodoc2-docstring} kompass.data_types.Pose
```

````

````{py:class} PoseStamped
:canonical: kompass.data_types.PoseStamped

Bases: {py:obj}`ros_sugar.supported_types.PoseStamped`

```{autodoc2-docstring} kompass.data_types.PoseStamped
```

````

`````{py:class} Odometry
:canonical: kompass.data_types.Odometry

Bases: {py:obj}`ros_sugar.supported_types.Odometry`

```{autodoc2-docstring} kompass.data_types.Odometry
```

````{py:method} convert(output: kompass_core.models.RobotState, **_) -> nav_msgs.msg.Odometry
:canonical: kompass.data_types.Odometry.convert
:classmethod:

```{autodoc2-docstring} kompass.data_types.Odometry.convert
```

````

`````

`````{py:class} TwistStamped
:canonical: kompass.data_types.TwistStamped

Bases: {py:obj}`ros_sugar.supported_types.Twist`

```{autodoc2-docstring} kompass.data_types.TwistStamped
```

````{py:method} convert(vx: float, vy: float, omega: float, **kwargs) -> geometry_msgs.msg.TwistStamped
:canonical: kompass.data_types.TwistStamped.convert
:classmethod:

```{autodoc2-docstring} kompass.data_types.TwistStamped.convert
```

````

`````

`````{py:class} TwistArray
:canonical: kompass.data_types.TwistArray

Bases: {py:obj}`ros_sugar.supported_types.SupportedType`

```{autodoc2-docstring} kompass.data_types.TwistArray
```

````{py:method} convert(output: kompass_interfaces.msg.TwistArray, **_)
:canonical: kompass.data_types.TwistArray.convert
:classmethod:

```{autodoc2-docstring} kompass.data_types.TwistArray.convert
```

````

`````

`````{py:class} Path
:canonical: kompass.data_types.Path

Bases: {py:obj}`ros_sugar.supported_types.Path`

```{autodoc2-docstring} kompass.data_types.Path
```

````{py:method} to_json(path: nav_msgs.msg.Path, json_file: str)
:canonical: kompass.data_types.Path.to_json
:classmethod:

```{autodoc2-docstring} kompass.data_types.Path.to_json
```

````

````{py:method} from_json(json_file: str) -> typing.Union[nav_msgs.msg.Path, None]
:canonical: kompass.data_types.Path.from_json
:classmethod:

```{autodoc2-docstring} kompass.data_types.Path.from_json
```

````

`````