Skip to content

Latest commit

 

History

History
106 lines (79 loc) · 8 KB

README.md

File metadata and controls

106 lines (79 loc) · 8 KB

SwimFix
User Guide Web Interface

Table of Contents

  1. Introduction
  2. Login
  3. Register User
  4. User Interface functionality
  5. Admin Interface functionality

Web Interface

Our system allows users to communicate with the system through a web interface which allows uploading new videos to the server, watch statistics extracted from his previous uploaded videos, while maintaining the users’ privacy and a convenient user experience.

Login

Login to the system is done by entering username and password and pressing on the Login button as seen in the picture:

In case a user is not registered in the system- pressing the blue link below the Login button will redirect you to the Registration page (next page).

Register User

In this page, the user has to enter the following credentials:

  • Username in English- must begin with a letter.

  • Valid email address.

  • Password.

  • Password again.

If the user is already registered, you can go back to the login page by pressing on the blue link which appears below the Sign Up button.

After logging in to the system, there are 2 kinds of menus for 2 kinds of users:
on the right menu- a menu for a regular user, and the two menus to the left are for an admin user. Admin users have all the regular user permissions, with more functionality that appears after pressing on the Admin Panel on the navigation bar and appears on the most left menu.


Now we will describe the functionality in the interface.

User Interface Functionality

Upload Video To The Server

The user can upload a video of him swimming front crawl style using a basic interface which enables choosing file and uploading it.
A user can access this interface by pressing on “Performance Assessment” on the navigation bar.
After a video is uploaded, the user is redirected to the index page- and a success/failure message will appear.

Watching Feedbacks On Videos

The user can watch statistics extracted from his previous uploaded videos in the “Previous Feedbacks” page which can be accessed by pressing on “Previous Feedbacks” button in the navigation bar. In this page there is a table containing all the feedbacks the user has received on his videos ordered by the upload date. By pressing "Download and View Feedback" the user will be redirected to a page containing the video frames and a table which contains error descriptions and a list of frames in which the system recognized the error in.
In addition, the user can watch the graphs extracted from his video by pressing on the “Download and View Graphs” button on the video’s row. By doing so, the user will be redirected to a page containing all the graphs in a dynamic view, which allows him to click on a point in a graph and see immediately the frame of the video in this point with a Wireframe on it. < update image here > Example:
[In this picture: the user clicked on frame number 142 in the graph, and immediately saw the frame corresponding with the number in the video, with annotations of keypoints and wireframe on the frame]

Users Forum

The user interface implements Forum which can be accessed by pressing the “Forum” button in the navigation bar. The forum enables every user to write and share messages with all the system’s users.
Functionality of the forum:

  • Viewing topics created by the users in the system.

  • Creating a new topic in the forum containing title and content. Done by filling the title and content in the bottom of the page and pressing the “Create” button.

  • Viewing posts in a topic by pressing on the topic’s name

  • Adding a post in a topic by filling the content and pressing the “Post” button

Admin Interface Functionality

The following functionalities can be access only by Admin users:

Add Admin

Allows admin to promote other registered users to Admins. The page contains a list of all the users registered to the system, and by pressing the "Promote" link on the same row- the selected user will become an admin.

Plug and Play

Allows admin to send the server scripts in python for classifying swimming errors. The server side implementation will be implemented in the future.

Add Test

The following mechanism allows admin to upload a csv file generated by Test Generator and Run Test on it in the future.

Run Test

In this page, you can choose a video to upload and if the video has a test for it on the server (uploaded by Add Test) the video will be processed the same it would have been through Upload Video To The Server, but at the end, it will be compared to the expected output( aka ground truth). To see the comparison go to Test Results

Test Results

In this page a list of all the videos the user uploaded in Run Test will appear. To watch the results press on the "Go to see results for this test" link in the same row as the video desired. By doing so, the user will be redirected to a page containing all the graphs in a dynamic view, which allows him to click on a point in a graph and see immediately the frame of the video in this point with a Wireframe on it.