Disparity Map

post

https://api.immersity.ai/api/v1/disparity

Historically, a disparity map is a visual representation of the differences in pixel coordinates between the corresponding points in a stereo image pair. It is typically generated from a pair of stereo images taken from slightly different viewpoints (left and right cameras). Using the power of the Immersity Cloud API, you can now generate a disparity map for any standard 2D image.

Body Params

The input parameters for the disparity map estimation.

inputImageUrl

string

required

Readable input image url

resultPresignedUrl

string

Presigned URL where the service should write the results to. The URL MUST have 'PUT' permission so the service can write the result to. For more details about signed URLs, please refer to your respective cloud providers.

correlationId

string

UUID to correlate this request. This must be unique for each request. If not provided, the service will generate one

dilation

number

-0.01 to 0.01

Defaults to 0.0063

Edge dilation has the effect of widening objects to avoid stretching artifacts. If there is no dilation then colors from the foreground may bleed along the edge towards the background and vice versa. To have a cleaner edge we can include some of the background color in the foreground object by widening the object. This operation is performed directly on the disparity map before rendering the output.

inputType

string

enum

Defaults to image2d

There are two types of input. Standard 2D images and 360 degree images. 360 degree images are processed differently due to the fisheye nature and the need to have these join seamlessly on the left and right edge

Allowed:

outputBitDepth

string

enum

Defaults to uint8

The disparity map can be created in either 8-bit bit depth or 16-bit depth. 8-bit results in a smaller file size whilst 16-bit results in a disparity map with greater depth definition

Allowed:

Responses

400

The request has invalid parameters

401

Returned if the user is not authenticated or authentication parameters are invalid

402

Returned it there is not enough credit balance

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The request has succeeded