Skip to content

Latest commit

 

History

History
103 lines (67 loc) · 3.43 KB

guide.md

File metadata and controls

103 lines (67 loc) · 3.43 KB
Raw

ImgLab User Guide:

Import:

  1. To open a file, click the photo icon on the bottom left-hand corner (or press Ctrl + I).
  2. To open a folder, click the folder icon right below the photo icon.
  3. Left click a photo that appears in the slider in the bottom row.

Auto suggestion:

Auto suggestion

Plugins:

You can request to face++ API to collect the points which automatically gets plotted on the image. To use this, you must register on Face++ to use their API.

  1. Click the puzzle icon on the top right-hand corner.
  2. On the drag-down menu, select Face Plus Plus.
  3. Enter the api_key if applicable (or leave blank).
  4. Click Plot with Face++.
  5. If you feel that the result should be improved, you can drag any of the points to the correct location.

Plugins

Different Shapes:

Create various shapes (circles, rectangles, polygons) on your image.

  1. Select any shapes tool on the toolbar on the left-hand side.
  2. Left click on the starting point of the image.
  3. Drag the curse while holding the left click to adjust the size of the shape.

Polygons

Keyboard Shortcuts:

Use the following shortcuts to speed up your work and save yourself some clicking.

File Management:

  • Alt + O : Open images.
  • Shift + Alt + O : Open image folder.
  • Ctrl + I : Import data file.
  • Ctrl + E : Export data file.
  • Alt + Left/Right Arrow : Navigate through images in the slider.

Shape Manipulation:

  • Del : Delete selected shapes or feature points.
  • Enter : Confirm action.
  • Alt + A : Select all shapes.
  • Ctrl + Directional Arrow : Move the currently selected shape in the corresponding direction.

Toolbar Shortcuts:

  • Alt + F : Feature Point
  • Alt + C : Circle
  • Alt + R : Rectangle
  • Alt + P : Polygon
  • Alt + M : Move
  • Alt + L : Light
  • Alt + E : Ellipse
  • Alt + + (Plus key) : Zoom
  • Alt + W : Magic wand

Hotkeys

Zoom In/Out:

Zoom in and out of your image to adjust your precision or simply get a different view.

  1. Select the magnifying glass in the toolbar on the top left-hand corner.
  2. Click the magnifying glass with the (+) to zoom in or (-) to zoom out.

Zoom

Copy/Paste Labels Across Images:

A short description of the feature will go here.

  1. Steps to complete this operation will be available here.
  2. Placeholder. Work in progress.

DEMONSTRATION GIF NOT YET AVAILABLE.

Offline Installation:

To use it offline, you can either download installers or clone this repo and run it on a local server.

Installing

  1. Fork this repository on github and make a clone from your forked copy
  2. Go to the folder you wish the create the directory and type $ git clone 'your_local_fork_on_github' in your terminal.

Setup local environment

  1. Install node and npm
  2. Open the terminal and run $ npm install -g live-server to install node live server.
  3. Run $ live-server in /imglab/ folder.
  4. Open your browser (if it hasn't popped up already) at: http://127.0.0.1:8080/

Note that live-server is just an app to run the server in easy way. You may try any other option as well.