Search against dataset
This is a very simple stateless RPC style API that allows the client to perform a search against a dataset with a query image.
HTTP POST URL http://api.mobileacuity.net/v1/search// Message body contains the query image (colour jpeg format) Header "Content-Type: image/jpeg" Optional header "Accept: text/plain" [default if not provided] Optional header "Accept: application/json" Optional “identity” parameter which is recorded in the service audit if present On success returns HTTP 200 and either the value associated with the matching reference image or if "Accept: application/json" the best matches formatted in order, best first, in body. On failure returns either HTTP 400 or HTTP 403
Example use of the API is provided by the following curl commands, the first returning plain text and the second returning JSON. “ma” is the client and “test” is the dataset.
$ curl -H "Content-Type: image/jpeg" --data-binary @query-brave.jpg URL http://api.mobileacuity.net/v1/search/ma/test
$ curl -H "Accept: application/json" -H "Content-Type: image/jpeg" --data-binary @query-brave.jpg URL http://api.mobileacuity.net/v1/search/ma/test
The following fields are returned when a JSON response is requested:
“mst” Model to scene transform
“s” Match score
“c” Centre point of query image projected into reference image coordinates
“r” Value of the matching reference image
“r0” id of the matching reference image
Note that the API does not rescale the query. It is recommended that the largest dimension of the query image is in the region of 640 pixels. The system will fail with any image with more than 1,300,000 total pixels.