Changes between Initial Version and Version 1 of UserGuide1.2

Timestamp:

Nov 27, 2008, 9:34:35 AM (16 years ago)

Author:

Frédéric

Comment:

--

UserGuide1.2

@@ +1 @@
+= Papywizard User Guide (subversion) =
+
+ * [#Usageoverview Usage overview]
+ * [#Advancedusage Advanced usage]
+  * [#Mosaicmode Mosaic mode]
+  * [#Presetmode Preset mode]
+   * [#Custompresets Custom presets]
+   * [#Presetconverter Preset converter]
+ * [#Referencemanual Reference manual]
+  * [#Mainwindow Main window]
+  * [#Configurationdialog Configuration dialog]
+  * [#Bluetoothdialog Bluetooth dialog]
+  * [#Shootdialog Shoot dialog]
+  * [#Logdialog Log dialog]
+ * [#Keyboardshortcuts Keyboard shortcuts]
+
+''This documentation refers to the stable release 1.2''.
+
+For installation instructions, see [InstallationGuide here].
+
+== Usage overview ==
+
+Papywizard is very easy to use, and I hope the GUI is intuitive enough.
+
+The first thing to do is to edit the configuration, to reflect you camera/lens/head/hardware config. Basic settings are the delay to wait after moving (to let the head stop shaking), the delay to wait while shooting (camera Tv value), and the number of pictures to take at each position (bracketing). See below for specific mode settings.
+
+Second, you need to connect to the hardware (Menu ''Hardware > Connect''). If you use the bluetooth driver (default config), you need to enter the correct address of your adapter. Alternatively, you can get a list of all available bluetooth devices arround, and select the correct one.
+
+Then, just move the head either using the big GUI arrows, or using the keys shortcuts (see below), and set the start/end positions.
+
+Once it is done, just open the shooting dialog and launch the entire process. That's it!
+
+== Advanced usage ==
+
+Papywizard has now 2 modes: ''Mosaic'' mode, and ''Preset'' mode. The first one is mainly used for partial panos, and is especially designed for hi-res panos, using a large tele-lens. The second one is designed for full-spherical panos, using a wide-lens or a fisheye.
+
+=== Mosaic mode ===
+
+The mosaic mode computations are based on the following parameters:
+
+ * minimum overlap
+ * camera orientation
+ * sensor coef. and ratio
+ * focal lens
+
+So, these settings must exactly reflect your configuration.
+
+It also needs the start/end positions, which are two opposite corners of the pano you want to shoot. It does not matter which corner you use for start or end, but it will influence the direction the pano will be shot. Note that, depending of the settings, Papywizard can start shooting from the start position, or from the end position. This is usefull to avoid the head to go back to the opposite corner before shooting (which takes time and uses batteries).
+
+It is also possible to choose the initial shooting direction. Using ''yaw'' will shoot row by row; using ''pitch'' will shoot column by column. Same, the head can go back to the begining of the row/column before shooting the next one (see [#Shootingdirection Tips and tricks]).
+
+=== Preset mode ===
+
+This mode is very simple, and does not use any particular settings; it just shoots at all positions defined in the selected template. The only thing to do is to define the ''home'' position of the head (origin), which will be the reference for the template positions (see [#Homeposition Tips and tricks]). In case the camera/lens can't be moved in all positions, it is possible to set some limits, to avoid potential colisions (limits are not saved in the current release, so they must be set each time the head is turned on).
+
+==== Custom presets ====
+
+Some default presets are provided with the software, but it is possible to add your own. For that, you need to create a xml file which describes them. The file must be named '''{{{presets.xml}}}''' and must be in '''{{{~/.config/papywizard/}}}''' on linux, '''{{{/home/user/.config/papywizard/}}}''' on maemo, and '''{{{C:\Documents and settings\<user>\Application Data\papywizard\}}}''' on Windows.
+
+Here is the file structure:
+
+{{{
+#!xml
+<?xml version="1.0" encoding="utf-8" ?>
+<papywizard>
+    <preset name="My custom preset">
+        <tooltip>
+            20D + 50mm
+            12 picts @ +55°
+            20 picts @ +40°
+            50 picts @  10°/-10°
+            20 picts @ -40°
+            55 picts @ -70°
+        </tooltip>
+        <shoot>
+            <pict yaw="0." pitch="55." />
+            <pict yaw="30." pitch="55." />
+            <pict yaw="60." pitch="55." />
+            <pict yaw="90." pitch="55." />
+            ...
+        </shoot>
+    </preset>
+    <preset name="Another custom preset">
+    ....
+     </preset>
+</papywizard>
+}}}
+
+Where:
+ * {{{<preset> name attribute}}}: name used to present the preset in the GUI
+ * {{{<tooltip>}}}: information for that preset (shown in the information presets template window)
+ * {{{<shoot>}}}: list of all positions to shoot, described in {{{yaw/pitch}}} attributes of the {{{<pict>}}} tag (one tag per position)
+
+To save time during shoot, take care of the order of positions. For example, don't ask the head to go back to the begining of the new row, it will take too long; instead, reverse the direction and go back for the next row.
+
+You can also import a custom preset file from the ''File'' menu. Note that this file won't be automatically loaded at next startup; this is mainly to test your presets before putting them in your user config. dir.
+
+If you add usefull templates, feel free to send them so they could be added as default ones.
+
+=== Preset converter ===
+
+As all files managed by Papywizard are xml, it is very easy to convert an output data file to a '''{{{presets.xml}}}''' file, using '''XSL transofrm'''. Here is a [PresetConverter a form] to automatically make such conversion.
+
+== Reference manual ==
+
+=== Main window ===
+
+==== Menus ====
+
+ * '''File > Quit''': exit from Papywizard
+ * '''File > Import Preset File...''': import presets from file
+ * '''Hardware > Connect''': connect to the head hardware
+ * '''Hardware > Set limit...''': set the selected limit to curent position
+ * '''Hardware > Clear limits''': reset all limits
+ * '''Hardware > Reset''': reset the head hardware
+ * '''Help > Manual''': open this documentation (network connection needed)
+ * '''Help > View log...''': open log window
+ * '''Help > About''': show the about dialog
+
+==== buttons ====
+
+ * '''Mosaic/Preset''': switch between mosaic and preset mode
+Mosaic mode:
+ * '''Yaw/Pitch/Both''': set the start (end) shooting positions from current position
+Preset mode:
+ * '''Template''': template defining all positions
+ * '''Templates information''': informations on available templates
+All modes:
+ * '''Left/Right Yaw arrows''': move head on yaw axis
+ * '''Left/Right pitch arrows''': move head on pitch axis
+ * '''Set origin''': set the current position as origin (yaw=0.0°, pitch = 0.0°)
+ * '''Configuration...''': open the config. dialog
+ * '''Shoot...''': open the shooting dialog
+
+==== displays ====
+
+Mosaic mode:
+ * '''Start''': start shooting position
+ * '''End''': end shooting position
+ * '''Total Fov''': total shooting field of view
+ * '''Nb picts''': shooting number of pictures
+ * '''Real overlap''': real shooting overlap
+Preset mode:
+ * '''Template''':
+All modes:
+ * '''Position''': current position of the head
+
+=== Configuration dialog ===
+
+==== Shooting tab ====
+
+ * '''Stab. delay''': delay to wait after the head has stopped, and before shooting, to let the head stablizing
+ * '''Camera orientation''': camera orientation on the head¹
+ * '''Overlap''': minimum wanted overlap¹
+ * '''Start from''': start position¹
+ * '''Initial direction''': initial moving direction¹
+ * '''CR''': if set, go back to the start of the row/columns before starting a new one¹
+
+''¹: mandatory in mosaic mode.''
+
+==== Camera tab ====
+
+ * '''Time value''': shooting time (Tv camera value)
+ * '''Bracketing''': number of picture to take at each position, and the intent of the bracketing
+ * '''Sensor coef.''': ratio to 24x36 sensor size
+ * '''Sensor ratio''': width/height sensor ratio
+ * '''Mirror lockup''': if set, trigger an additionnal shutter sequence before each shot
+
+==== Lens tab ====
+
+ * '''Lens type''': type of the lens (rectilinear or fisheye)
+ * '''Lens focal''': real focal of the lens
+
+==== Hardware tab ====
+
+ * '''Driver''': hardware driver to use ('bluetooth', 'serial', 'ethernet')
+ * '''BT device address''': bluetooth device address for 'bluetooth' driver
+ * '''Choose...''': open the bluetooth choose window
+ * '''Serial port''': serial device port for 'serial' driver
+ * '''ethernet host''': hostname/IP for the 'ethernet' driver
+ * '''ethernet port''': port number of the 'ethernet' driver
+ * '''Auto-connect''': if set, try to automatically connect to the head at startup
+
+==== Misc tab ====
+
+ * '''Logger level''': level of informations to log
+ * '''Data file format''': format to use for the output data file name. The final name is {{{papywizard_<format>.xml}}}
+  * {{{%(date)s}}}: expands to current date
+  * {{{%(time)s}}}: expands to start shooting time
+  * {{{%(date_time)s}}}: same as {{{%(date)s_%(time)s}}}
+  * {{{%(mode)s}}}: expands to shooting mode (mosaic or preset)
+ * '''Data storage dir''': set the directory where data file are written
+
+==== buttons ====
+
+ * '''OK''': validate settings and close dialog
+ * '''Cancel''': revert to previous settings and close dialog
+
+=== Bluetooth dialog ===
+
+This dialog shows the list of availabe bluetooth devices, and a button to refresh the list.
+
+=== Shoot dialog ===
+
+==== buttons ====
+
+ * '''Manual shooting''': if checked, automatically go to suspend mode at the end of each move, before shooting
+ * '''Data file enable''': if checked, write a xml data file in the current directory (for APP)
+ * '''Start''': start shooting process
+ * '''Suspend/Resume''': suspend/resume shooting process
+ * '''Stop''': cancel shooting process
+ * '''Done''': close shooting dialog
+
+==== displays ====
+
+ * ''shooting area'': display the shooting position
+ * ''progress bar'': shooting process progression
+
+=== Log dialog ===
+
+==== buttons ====
+
+ * '''Clear Log''': clear the log window
+ * '''Save Log''': save the log to file (in the data storage dir)
+
+== Keyboard shortcuts ==
+
+Papywizard main target is ''Nokia Internet Tablets'', so keyboard shortcuts are dedicated for that plateform (but works fine with normal PC). Here are defined shortcuts:
+
+ * In main window:
+||'''Nokia'''||'''PC'''||'''Function'''||
+||[[Image(Right.png, 24, nolink)]]||Right|| Turn the head right (Yaw +)||
+||[[Image(Left.png, 24, nolink)]]||Left||Turn the head left (Yaw -)||
+||[[Image(Up.png, 24, nolink)]]||Up||Move the head up (Pitch +)||
+||[[Image(Down.png, 24, nolink)]]||Down||Move the head down (Pitch -)||
+||[[Image(F7-increase.png, 24, nolink)]]||End||Set current position as end position||
+||[[Image(F8-decrease.png, 24, nolink)]]||Home||Set current position as start position||
+||[[Image(Return.png, 24, nolink)]]||Return||Open shooting dialog||
+
+ * In shooting dialog:
+||'''Nokia'''||'''PC'''||'''Function'''||
+||[[Image(Return.png, 24, nolink)]]||Return||Start/pause shooting||
+||[[Image(Escape.png, 24, nolink)]]||Escape||Stop shooting - Return to main window||
+
+ * In all dialogs:
+||'''Nokia'''||'''PC'''||'''Function'''||
+||[[Image(F4-menu.png, 24, nolink)]]||F10||Show menu||
+||[[Image(F5-home.png, 24, nolink)]]||-||Standard maemo behaviour||
+||[[Image(F6-fullscreen.png, 24, nolink)]]||F6||Toggle fullscreen mode (no more activated)||