====== Scan tutorial ======

===== Install Scan =====


Ensure Java 1.8 is installed on your system in a terminal:

{{{{:soft:scan:screenshot_from_2016-07-27_11_26_49.png?200|}}

If not, see the [[https://amapstudio.cirad.fr/faq|FAQ]]

Run the Scan installer by double clicking on it.

===== Launch Scan =====

Open a terminal, change directory to where AMAPstudio is installed, then :
  * under windows, type 'scan'
  * under Linux or Mac, type 'sh scan.sh'

You may build a shortcut on your desktop to start Scan faster.

/**
Note: to launch Scan in english: scan -l en
Note: to launch Scan in french: scan -l fr
*/

{{:soft:scan:screenshot_from_2016-06-28_18_17_14.png?200|}}

===== Import a scan (i.e. point cloud) =====

File > Import a scan > choose a file to be imported

e.g. format (extract):

{{:soft:scan:screenshot_from_2016-06-28_18_21_37.png?200|}}

{{:soft:scan:screenshot_from_2016-06-28_18_22_16.png?200|}}



===== Tune the sub sampling rate =====

Edit > Sub sample

{{:soft:scan:screenshot_from_2016-06-28_18_30_55.png?200|}}

Choose the max number of points of the complete scan to be rendered to get a responsive user interface.

Note: this is only for viewing, all algorithms hereafter are run on the complete scan

Note : Scan is based on OpenGL and advanced viewing techniques, but sub sampling is generally interesting to be able to load big scans and keep a responsive user interface. Scan was built to work on a single plant / tree point cloud at a time.
===== Import a topology created on this scan by SimpleTree =====

File > Import a SimpleTree CSV

{{:soft:scan:screenshot_from_2016-06-28_18_23_43.png?200|}}

{{:soft:scan:screenshot_from_2016-06-28_18_24_46.png?200|}}

===== Move in the 3D view =====

Select one of the viewing tools and click / drag in the 3D view

{{:soft:scan:screenshot_from_2016-06-28_18_28_57.png?200|}}

===== Focus temporarily on a spheric region =====

Select the focus tool in the lateral bar

{{:soft:scan:screenshot_from_2016-06-28_18_34_27.png?200|}}

Select a focus sphere by clicking its center then dragging the mouse for the chosen radius. On click release, the view is restricted to the inside of the sphere

{{:soft:scan:screenshot_from_2016-06-28_18_33_37.png?200|}}

Right click or click unfocus to unfocus.

===== Add a Vertex in the topology =====

Select the 'Add a vertex' tool

{{:soft:scan:screenshot_from_2016-06-28_18_39_45.png?200|}}

__Click at the center of a branch and drag the mouse to the border of the branch__, then release the mouse button
-> a vertex is added in the topology according to the current strategy and gesture

{{:soft:scan:screenshot_from_2016-06-28_18_44_16.png|}}

Options: 

  * Rerun the same strategy with a lower / larger radius by clicking on the '-' and '+' buttons to check is the result is better
  * Select an alternative strategy then click the refresh button

===== Add edges =====

Select the 'Add edges' tool

{{:soft:scan:screenshot_from_2016-06-28_19_09_24.png?200|}}

Click on the first vertex, then on the second, third... Finish the gesture by a right click.

{{:soft:scan:screenshot_from_2016-06-28_18_52_44.png?200|}}

===== Remove an edge / a vertex =====

Choose the 'Selection' tool, click on th edge / vertex, then press the 'Delete' key or click on the trash button.

To undo your action, press Ctrl-Z. To redo your action, press Ctrl-Y.


===== Configure the 3D view =====

Use the 3D view configuration button: {{:soft:scan:screenshot_from_2016-06-28_18_45_46.png|}} to open the configuration dialog

Click on the render line to configure the rendering for a given type

{{:soft:scan:screenshot_from_2016-06-28_18_46_42.png?200|}} {{:soft:scan:screenshot_from_2016-06-28_18_46_52.png?200|}} {{:soft:scan:screenshot_from_2016-06-28_18_47_09.png?200|}}

===== Swap renderers to get another view =====

e.g. select the 'Edge' line, right click on it and choose the 'Cylinder renderer'

{{:soft:scan:screenshot_from_2016-06-28_18_58_43.png?200|}}


===== Set ramifications =====

Select an edge to be set as a ramification on its bearer edge, then chose the 'Ramification' tool {{:soft:scan:screenshot_from_2016-06-28_19_04_10.png|}}.



{{:soft:scan:screenshot_from_2016-06-28_19_01_05.png?200|}} {{:soft:scan:screenshot_from_2016-06-28_19_03_04.png?200|}}

===== Remove an Edge =====

Select the Edge and press 'Delete'

{{:soft:scan:screenshot_from_2016-06-28_19_06_37.png?200|}}

Undo available: Ctrl-Z

===== Cut a sub-tree =====

Select an edge and chose the saw tool {{:soft:scan:screenshot_from_2016-06-28_19_05_56.png|}}

{{:soft:scan:screenshot_from_2016-06-28_19_06_51.png?200|}}

Undo available: Ctrl-Z

===== Save your work before leaving =====

Choose File > Save project if you want to reopen it later in Scan with 'Open project'.

Choose File > Export OPF File if you want to reopen the topology later in Xplo.