Skip to content

Setup.rst

Latest commit

 

History

History
337 lines (288 loc) · 7.48 KB

Setup.rst

File metadata and controls

337 lines (288 loc) · 7.48 KB

Project Assignees Distribution

TODOs
Part Description Type Assigned to
General Add folder structure Setup Marcelo
Doc Create README file Setup, Implement Marcelo
Doc Create Sphinx doc Setup, Implement Marcelo
General Setup Travis-CI Setup Marcelo
General Define Protocol Design Willy, Yihang, Marcelo
General User guide video Implement Yihang
Client_GUI Design GUI Design Willy, Yihang, Marcelo
Client_GUI Draw GUI Implement Willy, Marcelo
Client_GUI Code GUI Implement Willy, Marcelo
Client_API-calls Code API-calls Implement Willy, Marcelo
Client_GUI Integration Tests Test Willy, Yihang, Marcelo
Server_DB Online MongoDB Setup Setup Yihang
Server_DB DB Design Design Willy, Yihang, Marcelo
Server_DB Implement Model Implement Yihang
Server_DB Implement Calls Implement Yihang
Server_DB Unit Tests Test Yihang
Server_Views Implement Views Implement Marcelo
Server_IPC Implement Image Processing Code Implement Marcelo
Server_IPC Test Image Processing Code Test Marcelo
Server_API Implement API Implement Marcelo
Server_API Test API Test Marcelo
Server_API Implement API Implement Marcelo
Server_API Test API Test Marcelo
Server Integration Test Server Test Marcelo
General Integration Test Project Test Willy, Yihang, Marcelo
Validation Implement Validation Implement Marcelo
Validation Test Validation Test Marcelo

Database

We are using MongoDB online as the database for our server.

MongoDB Model Image

Image
Name Description Field Type
ID Unique id for each image numeric string / integer
Filename Name of the file string
Format encoding of the image. Can be either: PNG, JPEG, TIFF string
Size size of the image in pixels expressed in IxJ, with numbers I,J representing width and height string
Timestamp Date and time at which the image was stored in the server timestamp format/string
Description User description of the image. string
User Hash A hash that identifies a unique user who is the owner of the image string
Data Actual information in the file containing ALL bytes (including image format metadata) string coded in base64
Process Time The process time of each image applied string

REST API Methods

Upload Image

To upload a single image, the user must generate a POST request to server:port/api/upload/image with the following info in a dictionary:

Upload Image Dictionary
Key Description
'filename' String with the name of the file
'format' String with the format of the file: PNG, JPEG or TIFF
'user_hash' A String with the user hash
'data' The WHOLE file converted to a 64base string.

The return value is a dictionary with following information:

Upload Image Return Value
Key Description
'sucess' True / False
'error_msg' String with the error message

Upload Multiple Images

To upload multiple images, the user must generate a POST request to server:port/api/upload/zip with the following info in a dictionary:

Upload Images Zip Dictionary
Key Description
'filename' String with the name of the zip file
'user_hash' A String with the user hash
'data' The WHOLE zip file converted to a 64base string.

The return value is a dictionary with the following information

Upload Multiple Images Return Value
Key Description
'sucess' True / False
'error_msg' String with the error message

Get Images Info

To get information about all the images stored in the server, the user must generate a GET request to server:port/api/image_info/<User Hash>.

The return value is a dictionary with a key for each image in the server. That key is the Image ID, and each value is a dictionary with the following information:

Image Info Return Dictionary
Key Description
"filename" Filename of the image
"format" Format of the image
"timestamp" Timestamp of the image
"size" Size of the image
"description" Description of the image

Download Image

To Download a single image, the user must generate a GET request to server:port/api/download/ with a dictionary with the following info:

Download Images Dictionary
Key Description
'image_ids' List of Image IDs of the images to download
'format' Image format to download
'user_hash' A String with the user hash

If only one image ID is provided, the return value will be a string with the image coded in base64 If many image IDs are provided, the return value will be a string with a zip file with the images coded in base64

Downlaod Image Return Value
Key Description
'sucess' True / False
'error_msg' String with the error message
'data' The WHOLE file converted to a 64base string.

Image Processing

To apply any processing algorithm to an image, the user must generate a POST request to server:port/api/img_proc/ with a dictionary the following info:

Process Image Input
Key Description
'image_id' Image IDs of the images to process
'algorithm' Algorithm to apply to the image
'out_image_format' Format of the output processed image
'out_image_filename' Filename of the output processed image

The algorithm can be any of the following:

Algorithms
Histogram Equalization
Contrast Stretching
Log Compression
Contrast Invert
No Algorithm

The return value is a list with a dictionary with a key (image ID) for each image the user sent to proces. Each element has the following info:

Process Image Return
Key Description
'success' True / False
'error_msg' String with the error message
'processing_time' Time it took to process the image