Skip to content

Commit 77a3be7

Browse files
authored
Update image_apis.md
This adds an extra section to the image type documentation about the new image types added in #3938
1 parent de1c8ae commit 77a3be7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/image_apis.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,9 @@ To change resolution, FOV etc, you can use [settings.json](settings.md). For exa
217217
DisparityNormalized = 4,
218218
Segmentation = 5,
219219
SurfaceNormals = 6,
220-
Infrared = 7
220+
Infrared = 7,
221+
OpticalFlow = 8,
222+
OpticalFlowVis = 9
221223
```
222224

223225
### DepthPlanar and DepthPerspective
@@ -287,5 +289,8 @@ The `simGetSegmentationObjectID` API allows you get object ID for given mesh nam
287289
### Infrared
288290
Currently this is just a map from object ID to grey scale 0-255. So any mesh with object ID 42 shows up with color (42, 42, 42). Please see [segmentation section](#segmentation) for more details on how to set object IDs. Typically noise setting can be applied for this image type to get slightly more realistic effect. We are still working on adding other infrared artifacts and any contributions are welcome.
289291

292+
### OpticalFlow and OpticalFlowVis
293+
These image types return information about motion perceived by the point of view of the camera. OpticalFlow returns a 2-channel image where the channels correspond to vx and vy respectively. OpticalFlowVis is similar to OpticalFlow but converts flow data to RGB for a more 'visual' output.
294+
290295
## Example Code
291296
A complete example of setting vehicle positions at random locations and orientations and then taking images can be found in [GenerateImageGenerator.hpp](https://github.com/Microsoft/AirSim/tree/master/Examples/DataCollection/StereoImageGenerator.hpp). This example generates specified number of stereo images and ground truth disparity image and saving it to [pfm format](pfm.md).

0 commit comments

Comments
 (0)