Initial documentation - dev status

Author: Robert Freiholtz

.gitignore

@@ -1 +1,2 @@
 **/*.pyc
+documentation/site

documentation/docs/assets/images/Q.png

@@ -0,0 +1,27 @@
+:root {
+  --md-primary-fg-color:        #DA291C;
+  --md-accent-fg-color:         #F6BE00;
+}
+
+[data-md-color-scheme="default"] {
+  @extend :root;
+  --md-accent-fg-color:         #004c97;
+  --md-typeset-a-color:         #DA291C;
+  --md-code-bg-color:           #e1e1e1;
+}
+
+[data-md-color-scheme="slate"] {
+  @extend :root;
+  --md-default-bg-color:        #1E1E1E;
+  --md-typeset-a-color:         #DA291C;
+  --md-code-bg-color:           #323232;
+}
+
+.md-typeset h1
+{
+  color:                        #DA291C;
+  font-weight:                       bold;
+}
+.md-typeset h2 {
+  color:                        #DA291C;
+}

documentation/docs/assets/stylesheets/extra.css

@@ -0,0 +1,39 @@
+# QTM Common API
+
+The Common API (Application Programming Interface) provides scripting support
+for QTM (Qualisys Track Manager). Scripting is supported through both
+[Python](https://www.python.org/) and [Lua](https://www.lua.org/).
+Additionally, the Common API is also exposed through a REST API.
+
+The API's functionality (that is, what QTM functionality can be accessed) is
+exposed through a number of modules. This documentation provides a language
+agnostic description of the modules. For more details, see the [list of
+modules](modules.md). Below follows some short examples:
+
+=== "Python"
+    ``` py
+    from qtm.data.series import _3d
+    from qtm.data.object import trajectory
+    # Get the data series identifier of a trajectory with the label "F_HeadFront".
+    id = trajectory.find_trajectory("F_HeadFront")
+    # Get the first sample of this trajectory.
+    _3d.get_sample(id, 0)
+    {'position': [-1193.8392806851402, 1428.9096641692772, 1677.330950395389], 'residual': 1.933161315987386}
+    ```
+
+=== "Lua"
+    ``` lua
+    -- Get the data series identifier of a trajectory with the label "F_HeadFront".
+    id = qtm.data.object.trajectory.find_trajectory("F_HeadFront")
+    -- Get the first sample of this trajectory.
+    qtm.data.series._3d.get_sample(id, 0)
+    {position = {-1193.8392806851, 1428.9096641693, 1677.3309503954}, residual = 1.9331613159874}
+    ```
+
+=== "REST"
+    ``` js
+    curl --json '["F_HeadFront"]' http://localhost:7979/api/common/qtm/data/object/trajectory/find_trajectory
+    2985
+    curl --json '[2985, 0]' http://localhost:7979/api/common/qtm/data/series/_3d/get_sample
+    {"position":[-1193.8392806851402,1428.9096641692772,1677.330950395389],"residual":1.9331613159873859}
+    ```

documentation/docs/index.md

@@ -0,0 +1,34 @@
+# Modules
+
+ * [qtm](qtm.md) - Interface to the qtm application.
+ * [qtm.data.object.event](qtm.data.object.event.md) - Access and modify events.
+ * [qtm.data.object.trajectory](qtm.data.object.trajectory.md) - Access and modify trajectories.
+ * [qtm.data.series._2d](qtm.data.series._2d.md) - Access and modify 2d data series.
+ * [qtm.data.series._3d](qtm.data.series._3d.md) - Access and modify 3d data series.
+ * [qtm.data.series._6d](qtm.data.series._6d.md) - Access and modify 6dof data series.
+ * [qtm.data.series.analog](qtm.data.series.analog.md) - Access and modify analog data series.
+ * [qtm.data.series.force](qtm.data.series.force.md) - Access and modify force data series.
+ * [qtm.data.series.gaze](qtm.data.series.gaze.md) - Access and modify gaze data series.
+ * [qtm.data.series.skeleton](qtm.data.series.skeleton.md) - Access and modify skeleton data series.
+ * [qtm.data.series.time.irig](qtm.data.series.time.irig.md) - Access and modify irig (inter-range instrumentation group) data series.
+ * [qtm.data.series.time.ptp](qtm.data.series.time.ptp.md) - Access and modify ptp (precision time protocol) data series.
+ * [qtm.data.series.time.smpte](qtm.data.series.time.smpte.md) - Access and modify smpte (society of motion picture and television engineers) data series.
+ * [qtm.gui](qtm.gui.md) - Control and customize the graphical user interface.
+ * [qtm.gui._3d](qtm.gui._3d.md) - Interface to the measurement 3d view with methods for custom drawing.
+ * [qtm.gui.message](qtm.gui.message.md) - Interface to the messages window.
+ * [qtm.gui.selection](qtm.gui.selection.md) - Access and modify the current selection.
+ * [qtm.gui.terminal](qtm.gui.terminal.md) - Interface to the terminal window.
+ * [qtm.gui.timeline](qtm.gui.timeline.md) - Interface to the measurement timeline.
+ * [qtm.settings.camera](qtm.settings.camera.md) - Access and modify camera settings.
+ * [qtm.settings.directory](qtm.settings.directory.md) - Access and modify directory settings.
+ * [qtm.settings.euler](qtm.settings.euler.md) - Access and modify euler angle settings.
+ * [qtm.settings.export.c3d](qtm.settings.export.c3d.md) - Access and modify c3d export settings.
+ * [qtm.settings.export.fbx](qtm.settings.export.fbx.md) - Access and modify fbx export settings.
+ * [qtm.settings.export.mat](qtm.settings.export.mat.md) - Access and modify mat export settings.
+ * [qtm.settings.export.tsv](qtm.settings.export.tsv.md) - Access and modify tsv export settings.
+ * [qtm.settings.processing._2d](qtm.settings.processing._2d.md) - Access and modify 2d processing settings.
+ * [qtm.settings.processing._3d](qtm.settings.processing._3d.md) - Access and modify 3d processing settings.
+ * [qtm.settings.processing._6d](qtm.settings.processing._6d.md) - Access and modify 6dof processing settings.
+ * [qtm.utilities.color](qtm.utilities.color.md) - Utilities for converting various color models to a qtm compatible format.
+ * [qtm.utilities.documentation](qtm.utilities.documentation.md) - Various documentation utilities.
+ * [qtm.utilities.math](qtm.utilities.math.md) - Various math utilities.

documentation/docs/modules.md

@@ -0,0 +1,62 @@
+# qtm.data.object.event
+
+Access and modify events.
+
+Events consist of a label, a time (in seconds) and an optional color (in 0xbbggrr format, see 'qtm.utilities.color' module). If the latter is null, red (0x0000ff) will be used.
+
+## add_event
+
+Add an event.
+
+**Parameters**
+
+`event` `{"label": string, "time": float, "color": integer?}`<br/>
+The event to add.
+
+
+
+
+---
+## get_event_count
+
+Get the total number of events.
+
+**Returns**
+
+`integer` 
+
+
+---
+## get_events
+
+Get all events.
+
+**Returns**
+
+`[{"label": string, "time": float, "color": integer?}]` 
+
+
+---
+## clear_events
+
+Remove all events.
+
+
+
+---
+## help
+
+Get the documentation for a module or method.
+
+**Parameters**
+
+`method` `string?`<br/>
+The name of the method (if null, the documentation for the module will be returned instead).
+
+
+**Returns**
+
+`string` 
+
+
+---