Skip to content

Commit 9922137

Browse files
committed
Update readme.
1 parent 6ff55ab commit 9922137

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

+22-6
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Key | Description
6363
`Alt` | switch to display small labels on the fly.
6464
`Shift + Left drag` | merge two labels.
6565
`Alt + Left drag` | extract a small label / group small labels into a big label.
66-
`Ctrl + Left drag` | split a big label into several small labels. In practice, aavoid using this as its result could be messy.
66+
`Ctrl + Left drag` | split a big label into several small labels. In practice, avoid using this as its result could be messy.
6767
`Left click` | show the bounding box of the current label.
6868

6969
A comprehensive list of supported keyboard shortcuts is as below.
@@ -80,20 +80,26 @@ Key | Description
8080
`C` | toggle displaying camera trajectory
8181
`S` | save current screen to image. The images are stored screenshots/ folder, named image000.png, image001.png, and so on.
8282
`P` | batch screenshot. Export screenshots for grey mesh, segmented mesh, bounding boxes.
83-
`Shift + A` | switch to object pose adjustment mode. In this mode, press 'x' to select the active axis, and Shift + left drag to adjust the pose.
84-
`G` | switch to floor alignment mode.
8583
`Shift + S` | save (overwrite) current scene to PLY, XML, trajectory.log.
86-
`Z` | undo
84+
`Shift + E` | save 2D labels (solid color).
85+
`Shift + B` | save 2D labels (blended with input color images).
86+
`Z` | undo
8787
`Q` | exit
8888

8989
# Operation modes
90-
The main operation mode is label interaction. This mode is designed for user to merge, extract, and split existing segments.
90+
The main operation mode is label interaction. This mode is designed for user to merge, extract, and split existing segments as described in the paper.
91+
92+
Additionally, when user clicks on a segment, the bounding box of the segment will be shown. If one clicks on the sides of the bounding box, its corresponding face will be highlighted. One can drag to adjust the size of the bounding boxes, which in turn discards all labels that are out of the bounding box from the selected segment.
93+
94+
This program also comes with two other operation modes as follows.
9195

92-
In addition, this program also comes with two other operation modes as follows.
9396
- *Floor alignment mode*: usually the scene should have its floor aligned with the XZ axis, but the mesh from 3D reconstruction program might not have this property. Floor alignment mode is designed to address this issue. Press `G` to switch to this mode, and click on a segment on the floor to move the origin of the coordinate system there.
9497
Current implementation requires that the floor adjusted scene has to be saved, the program restarted before proceeding to other segmentation tasks.
9598

9699
- *Object pose editing mode*: In this mode, the local XYZ axes for a segment is displayed. User can specify the front direction of the segment by aligning the local Z-axis accordingly.
100+
101+
In this mode, press `X` to select the active axis (highlighted in bold), and `Shift + Left drag` to adjust the pose.
102+
97103
This is not the best UI for specifying object poses, but it's relatively simple to use. We are investigating more efficient approaches and will release when they are ready. Stay tuned!
98104

99105
# Display modes
@@ -137,6 +143,16 @@ Or press `Shift + S` to save.
137143

138144
* Please open new issue tickets on Github for questions and bug reports. Thanks!
139145

146+
# License
147+
148+
Our annotation tool adopts various open-source projects including
149+
150+
* [RPly](http://w3.impa.br/~diego/software/rply/) for PLY read and write.
151+
* [The VCG library](http://vcg.isti.cnr.it/vcglib/) for PLY read and write.
152+
* SSAO shaders from [LearnOpenGL](http://learnopengl.com/#!Advanced-Lighting/SSAO)
153+
* [GLEW](http://glew.sourceforge.net/) for OpenGL extension.
154+
* [Qt](https://www.qt.io/) for building UI.
155+
140156
# Disclaimer
141157
Copyright (c) 2015-2016 Singapore University of Technology and Design
142158

0 commit comments

Comments
 (0)