REST API - Send Image to PEKAT
Image processing works on the principle of sending the image via HTTP request. Only one image can be sent per request. (MODIFY & DELETE)
Enable Process
User must enable ‘Process’ enabled in the left panel to process the image.
Request
The sending address consists of IP address, port, and type. The method must be of ‘POST’ type, and the content of ‘application/octet-stream’ type.
Find a practical API demonstration in Python at GitHub Image Analyze API.
IP Address
If the project runs on a local computer, the address is 127.0.0.1. If a remote computer is accessed, then you need to use the IP address of the remote computer.
Port
This is selected when starting the project.
API Key
If the project is running with the API key, each request in the parameter query must contain API key.
Data
You can add extra information to the request. This string will be add to the context (key is data). It is available only in the Code module (context variable).
'http://127.0.0.1:8000/analyze_image?width=1920&height=1024&data=SomeInfo'
Types
analyze_raw_Image
Used for sending the image as raw data. For example, the numpy array in Python is converted to binary format.
You need to send the image dimensions in a query parameter.
Example of a 1920x1024 image
'http://127.0.0.1:8000/analyze_raw_image?width=1920&height=1024'
If you are sending Bayer RG 8 data, it is necessary to add an argument bayer.
'http://127.0.0.1:8000/analyze_raw_image?width=1920&height=1024&bayer'
analyze_image
For sending an image in ‘jpg’ or ‘png’ formats. - PASS THROUGH THE FLOW,TRAINED MODELS…
Example
'http://127.0.0.1:8000/analyze_image'
Example with API key
'http://127.0.0.1:8000/analyze_image?api_key=SUPER_SECRET'
Response
Query parameter ‘response_type’ determines the response type.
‘context’ – a serialized context in JSON format. context will be always there by result
context starts empty by the deafult, JSON dictonary.. also contatins images
priintscreen
‘image’ – processed image - output image that passed through the flow…..
‘annotated_image’ – processed image with annotations - heatmaps over the image….
‘heatmap’ - response is heatmap ‘.png’ image format - only the heat maps over the image (without the image!)…….
For image and annotated_image types, the serialized context is added to the header with the header title: context.