GetImageComparisonReferenceImage
Returns a training image associated with an image comparison reference.
Type: synchronous
Parameter | Description | Required |
---|---|---|
database
|
The name of the database that contains the reference. | Yes |
format
|
The image format to use for the returned image.
If you do not specify a format, but specify a file name with the |
No |
identifier
|
The identifier of the reference from which you want to retrieve an image. | Yes |
imagelabel
|
The label of the image that you want to retrieve. | Yes |
imagesize
|
The maximum dimensions to use for the returned image, in pixels, width followed by height. If you set the width and height, for example To specify a maximum width or maximum height, specify that dimension and set the other to zero. For example, If you do not specify a size, Media Server returns the image at its original size. |
No |
You can also set the parameters Output and FileName to write the output of this action to a file.
Example
curl http://localhost:14000/action=GetImageComparisonReferenceImage -F database=ReferenceImages -F identifier=6d8e53fd92e601a4b8948e1b9397e381 -F imagelabel=182d1007acab1a12890d2045794f27cc -o ReturnedImage.png
Response
The response contains the image data.
Media Server identifies the image type and sets the Content-Type
header to the appropriate MIME type. The Content-Length
header is set to the length of the image data in bytes.
If an error occurs, Media Server returns a standard XML error response.