Apiguide

Images

Retrieving Images from the enVision 100S

The /images endpoint provides a mechanism for a calling application to retrieve images captured by the device during a previous measure transaction.

The IP address of the device is required to call this endpoint. Check the Integration Guide for details on determining the device IP address.

The response to a call to the /image endpoint is a binary file in either JPG or BMP format.

Annotated Image

Returns the color image with annotations in JPEG format

/api/image/{imageid}

Request Parameters

The value of the ImageId property returned from a call to /measure

Example

Request for image id 183a16c4-6c01-44fb-9f76-4092b17f3c02
curl "http://<YOUR_DEVICE_ADDRESS>/api/image/183a16c4-6c01-44fb-9f76-4092b17f3c02" 
-X GET
--output "annotated_image.jpg" \

Color Image

Returns the raw (non-annotated) color image in JPEG format.

/api/image/color/{imageid}

Request Parameters

The value of the ImageId property returned from a call to /measure

Example

Request for image id 183a16c4-6c01-44fb-9f76-4092b17f3c02
curl "http://<YOUR_DEVICE_ADDRESS>/api/image/color/183a16c4-6c01-44fb-9f76-4092b17f3c02" 
-X GET
--output "color_image.jpg" \

Depth Image

Returns a colored representation of the depth map captured by the device in BMP format

/api/image/depth/{imageid}

Request Parameters

The value of the ImageId property returned from a call to /measure

Example

Request for image id 183a16c4-6c01-44fb-9f76-4092b17f3c02
curl "http://<YOUR_DEVICE_ADDRESS>/api/image/depth/183a16c4-6c01-44fb-9f76-4092b17f3c02" 
-X GET
--output "depth_image.bmp" \

Copyright © PHD Solutions 2024