# {py:mod}`agents.ros`

```{py:module} agents.ros
```

```{autodoc2-docstring} agents.ros
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`StreamingString <agents.ros.StreamingString>`
  - ```{autodoc2-docstring} agents.ros.StreamingString
    :summary:
    ```
* - {py:obj}`Video <agents.ros.Video>`
  - ```{autodoc2-docstring} agents.ros.Video
    :summary:
    ```
* - {py:obj}`Detections <agents.ros.Detections>`
  - ```{autodoc2-docstring} agents.ros.Detections
    :summary:
    ```
* - {py:obj}`DetectionsMultiSource <agents.ros.DetectionsMultiSource>`
  - ```{autodoc2-docstring} agents.ros.DetectionsMultiSource
    :summary:
    ```
* - {py:obj}`PointsOfInterest <agents.ros.PointsOfInterest>`
  - ```{autodoc2-docstring} agents.ros.PointsOfInterest
    :summary:
    ```
* - {py:obj}`Trackings <agents.ros.Trackings>`
  - ```{autodoc2-docstring} agents.ros.Trackings
    :summary:
    ```
* - {py:obj}`TrackingsMultiSource <agents.ros.TrackingsMultiSource>`
  - ```{autodoc2-docstring} agents.ros.TrackingsMultiSource
    :summary:
    ```
* - {py:obj}`RGBD <agents.ros.RGBD>`
  - ```{autodoc2-docstring} agents.ros.RGBD
    :summary:
    ```
* - {py:obj}`JointTrajectoryPoint <agents.ros.JointTrajectoryPoint>`
  - ```{autodoc2-docstring} agents.ros.JointTrajectoryPoint
    :summary:
    ```
* - {py:obj}`JointTrajectory <agents.ros.JointTrajectory>`
  - ```{autodoc2-docstring} agents.ros.JointTrajectory
    :summary:
    ```
* - {py:obj}`JointJog <agents.ros.JointJog>`
  - ```{autodoc2-docstring} agents.ros.JointJog
    :summary:
    ```
* - {py:obj}`JointState <agents.ros.JointState>`
  - ```{autodoc2-docstring} agents.ros.JointState
    :summary:
    ```
* - {py:obj}`Topic <agents.ros.Topic>`
  - ```{autodoc2-docstring} agents.ros.Topic
    :summary:
    ```
* - {py:obj}`FixedInput <agents.ros.FixedInput>`
  - ```{autodoc2-docstring} agents.ros.FixedInput
    :summary:
    ```
* - {py:obj}`MapLayer <agents.ros.MapLayer>`
  - ```{autodoc2-docstring} agents.ros.MapLayer
    :summary:
    ```
* - {py:obj}`Route <agents.ros.Route>`
  - ```{autodoc2-docstring} agents.ros.Route
    :summary:
    ```
````

### API

`````{py:class} StreamingString
:canonical: agents.ros.StreamingString

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

```{autodoc2-docstring} agents.ros.StreamingString
```

````{py:method} convert(output: str, stream: bool = False, done: bool = True, **_) -> automatika_embodied_agents.msg.StreamingString
:canonical: agents.ros.StreamingString.convert
:classmethod:

```{autodoc2-docstring} agents.ros.StreamingString.convert
```

````

`````

`````{py:class} Video
:canonical: agents.ros.Video

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

```{autodoc2-docstring} agents.ros.Video
```

````{py:method} convert(output: typing.Union[typing.List[ros_sugar.supported_types.ROSImage], typing.List[ros_sugar.supported_types.ROSCompressedImage], typing.List[numpy.ndarray]], **_) -> automatika_embodied_agents.msg.Video
:canonical: agents.ros.Video.convert
:classmethod:

```{autodoc2-docstring} agents.ros.Video.convert
```

````

`````

`````{py:class} Detections
:canonical: agents.ros.Detections

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

```{autodoc2-docstring} agents.ros.Detections
```

````{py:method} convert(output: typing.Union[typing.Dict, typing.List[typing.Dict]], images: typing.Union[ros_sugar.supported_types.ROSImage, ros_sugar.supported_types.ROSCompressedImage, numpy.ndarray, typing.List[ros_sugar.supported_types.ROSImage], typing.List[ros_sugar.supported_types.ROSCompressedImage], typing.List[numpy.ndarray]], **_) -> automatika_embodied_agents.msg.Detections2D
:canonical: agents.ros.Detections.convert
:classmethod:

```{autodoc2-docstring} agents.ros.Detections.convert
```

````

`````

`````{py:class} DetectionsMultiSource
:canonical: agents.ros.DetectionsMultiSource

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

```{autodoc2-docstring} agents.ros.DetectionsMultiSource
```

````{py:method} convert(output: typing.List, images: typing.List, **_) -> automatika_embodied_agents.msg.Detections2DMultiSource
:canonical: agents.ros.DetectionsMultiSource.convert
:classmethod:

```{autodoc2-docstring} agents.ros.DetectionsMultiSource.convert
```

````

`````

`````{py:class} PointsOfInterest
:canonical: agents.ros.PointsOfInterest

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

```{autodoc2-docstring} agents.ros.PointsOfInterest
```

````{py:method} convert(output: typing.List[typing.Tuple[int, int]], img: typing.Union[ros_sugar.supported_types.ROSImage, ros_sugar.supported_types.ROSCompressedImage, numpy.ndarray], **_) -> automatika_embodied_agents.msg.PointsOfInterest
:canonical: agents.ros.PointsOfInterest.convert
:classmethod:

```{autodoc2-docstring} agents.ros.PointsOfInterest.convert
```

````

`````

`````{py:class} Trackings
:canonical: agents.ros.Trackings

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

```{autodoc2-docstring} agents.ros.Trackings
```

````{py:method} convert(output: typing.Union[typing.Dict, typing.List[typing.Dict]], images: typing.Union[ros_sugar.supported_types.ROSImage, ros_sugar.supported_types.ROSCompressedImage, numpy.ndarray, typing.List[ros_sugar.supported_types.ROSImage], typing.List[ros_sugar.supported_types.ROSCompressedImage], typing.List[numpy.ndarray]]) -> automatika_embodied_agents.msg.Trackings
:canonical: agents.ros.Trackings.convert
:classmethod:

```{autodoc2-docstring} agents.ros.Trackings.convert
```

````

`````

`````{py:class} TrackingsMultiSource
:canonical: agents.ros.TrackingsMultiSource

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

```{autodoc2-docstring} agents.ros.TrackingsMultiSource
```

````{py:method} convert(output: typing.List, images: typing.List, **_) -> automatika_embodied_agents.msg.TrackingsMultiSource
:canonical: agents.ros.TrackingsMultiSource.convert
:classmethod:

```{autodoc2-docstring} agents.ros.TrackingsMultiSource.convert
```

````

`````

````{py:class} RGBD
:canonical: agents.ros.RGBD

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

```{autodoc2-docstring} agents.ros.RGBD
```

````

`````{py:class} JointTrajectoryPoint
:canonical: agents.ros.JointTrajectoryPoint

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

```{autodoc2-docstring} agents.ros.JointTrajectoryPoint
```

````{py:method} convert(output: agents.utils.actions.JointsData, index: typing.Optional[int] = None, **_) -> typing.Any
:canonical: agents.ros.JointTrajectoryPoint.convert
:classmethod:

```{autodoc2-docstring} agents.ros.JointTrajectoryPoint.convert
```

````

`````

`````{py:class} JointTrajectory
:canonical: agents.ros.JointTrajectory

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

```{autodoc2-docstring} agents.ros.JointTrajectory
```

````{py:method} convert(output: agents.utils.actions.JointsData, **_) -> typing.Any
:canonical: agents.ros.JointTrajectory.convert
:classmethod:

```{autodoc2-docstring} agents.ros.JointTrajectory.convert
```

````

`````

`````{py:class} JointJog
:canonical: agents.ros.JointJog

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

```{autodoc2-docstring} agents.ros.JointJog
```

````{py:method} convert(output: agents.utils.actions.JointsData, **_) -> typing.Any
:canonical: agents.ros.JointJog.convert
:classmethod:

```{autodoc2-docstring} agents.ros.JointJog.convert
```

````

`````

`````{py:class} JointState
:canonical: agents.ros.JointState

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

```{autodoc2-docstring} agents.ros.JointState
```

````{py:method} convert(output: agents.utils.actions.JointsData, **_) -> sensor_msgs.msg.JointState
:canonical: agents.ros.JointState.convert
:classmethod:

```{autodoc2-docstring} agents.ros.JointState.convert
```

````

`````

````{py:class} Topic
:canonical: agents.ros.Topic

Bases: {py:obj}`ros_sugar.io.topic.Topic`

```{autodoc2-docstring} agents.ros.Topic
```

````

````{py:class} FixedInput
:canonical: agents.ros.FixedInput

Bases: {py:obj}`agents.ros.Topic`

```{autodoc2-docstring} agents.ros.FixedInput
```

````

````{py:class} MapLayer
:canonical: agents.ros.MapLayer

Bases: {py:obj}`ros_sugar.config.BaseAttrs`

```{autodoc2-docstring} agents.ros.MapLayer
```

````

````{py:class} Route
:canonical: agents.ros.Route

Bases: {py:obj}`ros_sugar.config.BaseAttrs`

```{autodoc2-docstring} agents.ros.Route
```

````