Skip to content

Commit 5850857

Browse files
authored
Merge pull request #2 from rpartsey/patch-1
Fix the laser observation description
2 parents abe11ac + b733918 commit 5850857

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ If you encounter a task using non-standard channel configurations, the API has a
137137
| `'image_depth_info'` | <pre>{<br> 'frame_id': string<br> 'height': int<br> 'width': int<br> 'matrix_instrinsics':<br> numpy.ndarray(shape=(3,3),<br> dtype='float64')<br>'matrix_projection':<br> numpy.ndarray(shape=(3,4)<br> dtype='float64')<br>}</pre> | Sensor information for the depth image. `'matrix_instrinsics'` is of the format:<br><pre>[fx 0 cx]<br>[0 fy cy]<br>[0 0 1]</pre> for a camera with focal lengths `(fx,fy)`, & principal point `(cx,cy)`. Likewise, `'matrix_projection'` is:<br><pre>[fx 0 cx Tx]<br>[0 fy cy Ty]<br>[0 0 1 0]</pre>where `(Tx,Ty)` is the translation between stereo sensors. See [here](http://docs.ros.org/melodic/api/sensor_msgs/html/msg/CameraInfo.html) for further information on fields. |
138138
| `'image_rgb'` | <pre>numpy.ndarray(shape=(H,W,3),<br> dtype='uint8')</pre> | RGB image from the default image sensor with colour values mapped to the 3 channels, in the 0-255 range. |
139139
| `'image_rgb_info'` | <pre>{<br> 'frame_id': string<br> 'height': int<br> 'width': int<br> 'matrix_instrinsics':<br> numpy.ndarray(shape=(3,3),<br> dtype='float64')<br>'matrix_projection':<br> numpy.ndarray(shape=(3,4)<br> dtype='float64')<br>}</pre> | Sensor information for the RGB image. `'matrix_instrinsics'` is of the format:<br><pre>[fx 0 cx]<br>[0 fy cy]<br>[0 0 1]</pre> for a camera with focal lengths `(fx,fy)`, & principal point `(cx,cy)`. Likewise, `'matrix_projection'` is:<br><pre>[fx 0 cx Tx]<br>[0 fy cy Ty]<br>[0 0 1 0]</pre>where `(Tx,Ty)` is the translation between stereo sensors. See [here](http://docs.ros.org/melodic/api/sensor_msgs/html/msg/CameraInfo.html) for further information on fields. |
140-
| `'laser'` | <pre>{<br> 'range_max': float64,<br> 'range_min': float64,<br> 'scans':<br> numpy.ndarray(shape=(N,2),<br> dtype='float64')<br>}</pre> | Set of scan values from a laser sensor, between `'range_min'` & `'range_max'` (in meters). The `'scans'` array consists of `N` scans of format `[scan_angle, scan_value]`. For example, `scans[100,0]` would get the angle of the 100th scan & `scans[100,1]` would get the distance value. |
140+
| `'laser'` | <pre>{<br> 'range_max': float64,<br> 'range_min': float64,<br> 'scans':<br> numpy.ndarray(shape=(N,2),<br> dtype='float64')<br>}</pre> | Set of scan values from a laser sensor, between `'range_min'` & `'range_max'` (in meters). The `'scans'` array consists of `N` scans of format `[scan_value, scan_angle]`. For example, `scans[100, 0]` would get the distance value & `scans[100, 1]` would get the angle of the 100th scan. |
141141
| `'poses'` | <pre>{<br> ...<br> 'frame_name': {<br> 'parent_frame': string<br> 'rotation_rpy':<br> numpy.ndarray(shape=(3,),<br> dtype='float64')<br> 'rotation_xyzw':<br> numpy.ndarray(shape=(4,),<br> dtype='float64')<br> 'translation_xyz':<br> numpy.ndarray(shape=(3,),<br> dtype='float64')<br> }<br> ...<br>}</pre> | Dictionary of relative poses for the current system state. The pose of each system component is available at key `'frame_name'`. Each pose has a `'parent_frame'` which the pose is relative to (all poses are typically with respect to global `'map'` frame), & the pose values. `'rotation_rpy'` is `[roll,pitch,yaw]` in `ZYX` order, `'rotation_xyzw'` is the equivalent quaternion `[x,y,z,w]`, & `'translation_xyz'` is the Cartesion `[x,y,z]` coordinates. |
142142

143143
## Using the API to communicate with the BenchBot system

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
long_description = fh.read()
55

66
setup(name='benchbot_api',
7-
version='2.4.1',
7+
version='2.4.2',
88
author='Ben Talbot',
99
author_email='b.talbot@qut.edu.au',
1010
description='The BenchBot API for use with the BenchBot software stack',

0 commit comments

Comments
 (0)