Merge remote branch 'origin/master' into dexela

Conflicts: CMakeLists.txt src/CMakeLists.txt src/uca-camera.c
author: Mihael Koep <koep@schneide.com> 2012-10-19 17:03:49 +0200
committer: Mihael Koep <koep@schneide.com> 2012-10-19 17:03:49 +0200
commit: 9866002f3f569f6da886d71964d3298183cd1646 (patch)
tree: 968097e2f5fa11a094238ead6469739a725d8ce2 /docs
parent: 37f48ae1b67b1205ba4884ec350afdf5ab7dd2d3 (diff)
parent: 6f12303cf4c4130d544c30f8ad5e2445a1fa3e61 (diff)
download: uca-9866002f3f569f6da886d71964d3298183cd1646.tar.gz
uca-9866002f3f569f6da886d71964d3298183cd1646.tar.bz2
uca-9866002f3f569f6da886d71964d3298183cd1646.tar.xz
uca-9866002f3f569f6da886d71964d3298183cd1646.zip
7 files changed, 473 insertions, 57 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 53dc6fd..ff7113d 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -10,11 +10,15 @@ html: manual.html
 clean:
 	rm -f manual.pdf manual.html
 
-manual.pdf: manual.md
-	$(PANDOC) $(OPTS) manual.md -o manual.pdf
+manual.pdf: manual.md gen-changelog
+	./gen-changelog
+	$(PANDOC) $(OPTS) manual.md z-changes-*.md -o manual.pdf
+	rm z-changes-*.md
 
-manual.html: manual.md style.css
-	$(PANDOC) $(OPTS) manual.md -H webfonts.html -c style.css -o manual.html
+manual.html: manual.md style.css gen-changelog
+	./gen-changelog
+	$(PANDOC) $(OPTS) manual.md z-changes-*.md -H webfonts.html -c style.css -o manual.html
+	rm z-changes-*.md
 
 ifeq ($(PANDOC),)
 	$(warning Pandoc not found!)
diff --git a/docs/base.html b/docs/base.html
new file mode 100644
index 0000000..e86807f
--- /dev/null
+++ b/docs/base.html
@@ -0,0 +1,67 @@
+<html><head><link rel="stylesheet" href="style.css" type="text/css" /><link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700|Droid+Serif:400,400italic|Inconsolata' rel='stylesheet' type='text/css'><title>Basic camera &mdash; properties</title></head><body><div id="header"><h1 class="title">Property documentation of Basic camera</h1><h2>Properties</h2><ul id="toc"><li><code><a href=#name>"name"</a></code></li><li><code><a href=#sensor-width>"sensor-width"</a></code></li><li><code><a href=#sensor-height>"sensor-height"</a></code></li><li><code><a href=#sensor-bitdepth>"sensor-bitdepth"</a></code></li><li><code><a href=#sensor-horizontal-binning>"sensor-horizontal-binning"</a></code></li><li><code><a href=#sensor-horizontal-binnings>"sensor-horizontal-binnings"</a></code></li><li><code><a href=#sensor-vertical-binning>"sensor-vertical-binning"</a></code></li><li><code><a href=#sensor-vertical-binnings>"sensor-vertical-binnings"</a></code></li><li><code><a href=#sensor-max-frame-rate>"sensor-max-frame-rate"</a></code></li><li><code><a href=#trigger-mode>"trigger-mode"</a></code></li><li><code><a href=#exposure-time>"exposure-time"</a></code></li><li><code><a href=#roi-x0>"roi-x0"</a></code></li><li><code><a href=#roi-y0>"roi-y0"</a></code></li><li><code><a href=#roi-width>"roi-width"</a></code></li><li><code><a href=#roi-height>"roi-height"</a></code></li><li><code><a href=#roi-width-multiplier>"roi-width-multiplier"</a></code></li><li><code><a href=#roi-height-multiplier>"roi-height-multiplier"</a></code></li><li><code><a href=#has-streaming>"has-streaming"</a></code></li><li><code><a href=#has-camram-recording>"has-camram-recording"</a></code></li><li><code><a href=#transfer-asynchronously>"transfer-asynchronously"</a></code></li><li><code><a href=#is-recording>"is-recording"</a></code></li><li><code><a href=#is-readout>"is-readout"</a></code></li></ul><h2>Details</h2><dl><dt id="name"><a href="#toc">name</a></dt>
+<dd><pre><code class="prop-type">"name" : gchararray : Read-only</code></pre>
+<p>Name of the camera</p>
+</dd><dt id="sensor-width"><a href="#toc">sensor-width</a></dt>
+<dd><pre><code class="prop-type">"sensor-width" : guint : Read-only</code></pre>
+<p>Width of the sensor in pixels</p>
+</dd><dt id="sensor-height"><a href="#toc">sensor-height</a></dt>
+<dd><pre><code class="prop-type">"sensor-height" : guint : Read-only</code></pre>
+<p>Height of the sensor in pixels</p>
+</dd><dt id="sensor-bitdepth"><a href="#toc">sensor-bitdepth</a></dt>
+<dd><pre><code class="prop-type">"sensor-bitdepth" : guint : Read-only</code></pre>
+<p>Number of bits per pixel</p>
+</dd><dt id="sensor-horizontal-binning"><a href="#toc">sensor-horizontal-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in horizontal direction</p>
+</dd><dt id="sensor-horizontal-binnings"><a href="#toc">sensor-horizontal-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in horizontal direction</p>
+</dd><dt id="sensor-vertical-binning"><a href="#toc">sensor-vertical-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in vertical direction</p>
+</dd><dt id="sensor-vertical-binnings"><a href="#toc">sensor-vertical-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in vertical direction</p>
+</dd><dt id="sensor-max-frame-rate"><a href="#toc">sensor-max-frame-rate</a></dt>
+<dd><pre><code class="prop-type">"sensor-max-frame-rate" : gfloat : Read-only</code></pre>
+<p>Maximum frame rate at full frame resolution</p>
+</dd><dt id="trigger-mode"><a href="#toc">trigger-mode</a></dt>
+<dd><pre><code class="prop-type">"trigger-mode" : UcaCameraTrigger : Read / Write</code></pre>
+<p>Trigger mode</p>
+</dd><dt id="exposure-time"><a href="#toc">exposure-time</a></dt>
+<dd><pre><code class="prop-type">"exposure-time" : gdouble : Read / Write</code></pre>
+<p>Exposure time in seconds</p>
+</dd><dt id="roi-x0"><a href="#toc">roi-x0</a></dt>
+<dd><pre><code class="prop-type">"roi-x0" : guint : Read / Write</code></pre>
+<p>Horizontal coordinate</p>
+</dd><dt id="roi-y0"><a href="#toc">roi-y0</a></dt>
+<dd><pre><code class="prop-type">"roi-y0" : guint : Read / Write</code></pre>
+<p>Vertical coordinate</p>
+</dd><dt id="roi-width"><a href="#toc">roi-width</a></dt>
+<dd><pre><code class="prop-type">"roi-width" : guint : Read / Write</code></pre>
+<p>Width of the region of interest</p>
+</dd><dt id="roi-height"><a href="#toc">roi-height</a></dt>
+<dd><pre><code class="prop-type">"roi-height" : guint : Read / Write</code></pre>
+<p>Height of the region of interest</p>
+</dd><dt id="roi-width-multiplier"><a href="#toc">roi-width-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-width-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of horizontal ROI</p>
+</dd><dt id="roi-height-multiplier"><a href="#toc">roi-height-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-height-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of vertical ROI</p>
+</dd><dt id="has-streaming"><a href="#toc">has-streaming</a></dt>
+<dd><pre><code class="prop-type">"has-streaming" : gboolean : Read-only</code></pre>
+<p>Is the camera able to stream the data</p>
+</dd><dt id="has-camram-recording"><a href="#toc">has-camram-recording</a></dt>
+<dd><pre><code class="prop-type">"has-camram-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera able to record the data in-camera</p>
+</dd><dt id="transfer-asynchronously"><a href="#toc">transfer-asynchronously</a></dt>
+<dd><pre><code class="prop-type">"transfer-asynchronously" : gboolean : Read / Write</code></pre>
+<p>Specify whether data should be transfered asynchronously using a specified callback</p>
+</dd><dt id="is-recording"><a href="#toc">is-recording</a></dt>
+<dd><pre><code class="prop-type">"is-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera currently recording</p>
+</dd><dt id="is-readout"><a href="#toc">is-readout</a></dt>
+<dd><pre><code class="prop-type">"is-readout" : gboolean : Read-only</code></pre>
+<p>Is camera in readout mode</p>
+</dd></dl></body></html>
diff --git a/docs/gen-changelog b/docs/gen-changelog
new file mode 100755
index 0000000..51650f1
--- /dev/null
+++ b/docs/gen-changelog
@@ -0,0 +1,20 @@
+#!/bin/bash
+
+FROM=$1
+TO=$2
+OUTPUT=$3
+series=('v1.0' 'v1.0.1')
+
+logname="z-changes-${series[0]}.md"
+
+echo "## Changes for stable branch ${series[0]}
+" >> $logname
+
+for ((i = 1; i < ${#series[@]}; i++)) do
+    curr=${series[i]}
+    prev=${series[i-1]}
+
+    echo "### Changes from $prev to $curr
+" >> $logname
+    git log --pretty=format:'* [%h](http://ufo.kit.edu/repos/libuca.git/commit/?id=%h): %s' $prev..$curr >> $logname
+done
diff --git a/docs/manual.md b/docs/manual.md
index 69abae8..a68400e 100644
--- a/docs/manual.md
+++ b/docs/manual.md
@@ -12,7 +12,18 @@ Before installing `libuca` itself, you should install any drivers and SDKs
 needed to access the cameras you want to access through `libuca`. Now you have
 two options: install pre-built packages or build from source.
 
-## Building from source
+### Installing packages
+
+Packages for the core library and all plugins are currently provided for
+openSUSE. To install them run `zypper`:
+
+    sudo zypper in libuca-x.y.z-x86_64.rpm
+    sudo zypper in uca-plugin-*.rpm
+
+To install development files such as headers, you have to install the
+`libuca-x.y.z-devel.rpm` package.
+
+### Building from source
 
 Building the library and installing from source is simple and straightforward.
 Make sure you have
@@ -38,7 +49,8 @@ repository][repo], you also need Git:
 
 [repo]: http://ufo.kit.edu/repos/libuca.git/
 
-### Fetching the sources
+
+#### Fetching the sources
 
 Untar the distribution
 
@@ -54,7 +66,7 @@ and create a new, empty build directory inside:
     mkdir build
 
 
-### Configuring and building
+#### Configuring and building
 
 Now you need to create the Makefile with CMake. Go into the build directory and
 point CMake to the `libuca` top-level directory:
@@ -86,7 +98,7 @@ latter that 64 should be appended to any library paths. This is necessary on
 Linux distributions that expect 64-bit libraries in `/usr[/local]/lib64`.
 
 
-### Building this manual
+#### Building this manual
 
 Make sure you have [Pandoc][] installed. With Debian/Ubuntu this can be achieved
 with
@@ -107,6 +119,7 @@ necessary header files:
 
 ~~~ {.c}
 #include <glib-object.h>
+#include <uca-plugin-manager.h>
 #include <uca-camera.h>
 ~~~
 
@@ -116,6 +129,7 @@ Then you need to setup the type system:
 int
 main (int argc, char *argv[])
 {
+    UcaPluginManager *manager;
     UcaCamera *camera;
     GError *error = NULL; /* this _must_ be set to NULL */
 
@@ -124,10 +138,12 @@ main (int argc, char *argv[])
 
 Now you can instantiate new camera _objects_. Each camera is identified by a
 human-readable string, in this case we want to access any pco camera that is
-supported by [libpco][]:
+supported by [libpco][]. To instantiate a camera we have to create a plugin
+manager first:
 
 ~~~ {.c}
-    camera = uca_camera_new ("pco", &error);
+    manager = uca_plugin_manager_new ();
+    camera = uca_plugin_manager_get_camera (manager, "pco", &error);
 ~~~
 
 Errors are indicated with a returned value `NULL` and `error` set to a value
@@ -241,6 +257,16 @@ The following cameras are supported:
 * Pylon
 * UFO Camera developed at KIT/IPE.
 
+## Property documentation
+
+* [Basic camera properties][base-doc]
+* [pco][pco-doc]
+* [mock][mock-doc]
+
+[base-doc]: base.html
+[pco-doc]: pco.html
+[mock-doc]: mock.html
+
 
 # More API
 
@@ -252,38 +278,19 @@ communicate with the camera. Now we will go into more detail.
 We have already seen how to instantiate a camera object from a name. If you have
 more than one camera connected to a machine, you will most likely want the user
 decide which to use. To do so, you can enumerate all camera strings with
-`uca_camera_get_types`:
+`uca_plugin_manager_get_available_cameras`:
 
 ~~~ {.c}
-    gchar **types;
+    GList *types;
 
-    types = uca_camera_get_types ();
+    types = uca_camera_get_available_cameras (manager);
 
-    for (guint i = 0; types[i] != NULL; i++)
-        g_print ("%s\n", types[i]);
+    for (GList *it = g_list_first; it != NULL; it = g_list_next (it))
+        g_print ("%s\n", (gchar *) it->data);
 
-    /* free the string array */
-    g_strfreev (types);
-~~~
-
-If you _know_ which camera you want to use you can instantiate the sub-classed
-camera object directly. In this case we create a pco-based camera:
-
-~~~ {.c}
-#include <glib-object.h>
-#include <uca/uca-camera-pco.h>
-
-int
-main (int argc, char *argv[])
-{
-    UcaPcoCamera *camera;
-    GError *error = NULL;
-
-    g_type_init ();
-    camera = uca_pco_camera_new (&error);
-    g_object_unref (camera);
-    return 0;
-}
+    /* free the strings and the list */
+    g_list_foreach (types, (GFunc) g_free, NULL);
+    g_list_free (types);
 ~~~
 
 [last section]: #first-look-at-the-api
@@ -374,6 +381,37 @@ setup_async (UcaCamera *camera)
 }
 ~~~
 
+
+# Bindings
+
+Since version 1.1, libuca generates GObject introspection meta data if
+`g-ir-scanner` and `g-ir-compiler` can be found. When the XML description
+`Uca-x.y.gir` and the typelib `Uca-x.y.typelib` are installed, GI-aware
+languages can access libuca and create and modify cameras, for example in
+Python:
+
+~~~ {.python}
+from gi.repository import Uca
+
+pm = Uca.PluginManager()
+
+# List all cameras
+print(pm.get_available_cameras())
+
+# Load a camera
+cam = pm.get_camera('pco')
+
+# You can read and write properties in two ways
+cam.set_properties(exposure_time=0.05)
+cam.props.roi_width = 1024
+~~~
+
+Note, that the naming of classes and properties depends on the GI implementation
+of the target language. For example with Python, the namespace prefix `uca_`
+becomes the module name `Uca` and dashes separating property names become
+underscores.
+
+
 # Integrating new cameras
 
 A new camera is integrated by [sub-classing][] `UcaCamera` and implement all
@@ -381,6 +419,31 @@ virtual methods. The simplest way is to take the `mock` camera and
 rename all occurences. Note, that if you class is going to be called `FooBar`,
 the upper case variant is `FOO_BAR` and the lower case variant is `foo_bar`.
 
+In order to fully implement a camera, you need to override at least the
+following virtual methods:
+
+* `start_recording`: Take suitable actions so that a subsequent call to
+  `grab` delivers an image or blocks until one is exposed.
+* `stop_recording`: Stop recording so that subsequent calls to `grab`
+  fail.
+* `grab`: Return an image from the camera or block until one is ready.
+
+## Asynchronous operation
+
+When the camera supports asynchronous acquisition and announces it with a true
+boolean value for `"transfer-asynchronously"`, a mechanism must be setup up
+during `start_recording` so that for each new frame the grab func callback is
+called.
+
+## Cameras with internal memory
+
+Cameras such as the pco.dimax record into their own on-board memory rather than
+streaming directly to the host PC. In this case, both `start_recording` and
+`stop_recording` initiate and end acquisition to the on-board memory. To
+initiate a data transfer, the host calls `start_readout` which must be suitably
+implemented. The actual data transfer happens either with `grab` or
+asynchronously.
+
 
 [sub-classing]: http://developer.gnome.org/gobject/stable/howto-gobject.html
 
@@ -426,3 +489,6 @@ grabbing time:
 # The GObject Tango device
 
 [TODO: Get more information from Volker Kaiser and/or Mihael Koep]
+
+
+# ChangeLog
diff --git a/docs/mock.html b/docs/mock.html
new file mode 100644
index 0000000..0d38fc8
--- /dev/null
+++ b/docs/mock.html
@@ -0,0 +1,70 @@
+<html><head><link rel="stylesheet" href="style.css" type="text/css" /><link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700|Droid+Serif:400,400italic|Inconsolata' rel='stylesheet' type='text/css'><title>mock &mdash; properties</title></head><body><div id="header"><h1 class="title">Property documentation of mock</h1><h2>Properties</h2><ul id="toc"><li><code><a href=#name>"name"</a></code></li><li><code><a href=#sensor-width>"sensor-width"</a></code></li><li><code><a href=#sensor-height>"sensor-height"</a></code></li><li><code><a href=#sensor-bitdepth>"sensor-bitdepth"</a></code></li><li><code><a href=#sensor-horizontal-binning>"sensor-horizontal-binning"</a></code></li><li><code><a href=#sensor-horizontal-binnings>"sensor-horizontal-binnings"</a></code></li><li><code><a href=#sensor-vertical-binning>"sensor-vertical-binning"</a></code></li><li><code><a href=#sensor-vertical-binnings>"sensor-vertical-binnings"</a></code></li><li><code><a href=#sensor-max-frame-rate>"sensor-max-frame-rate"</a></code></li><li><code><a href=#trigger-mode>"trigger-mode"</a></code></li><li><code><a href=#exposure-time>"exposure-time"</a></code></li><li><code><a href=#roi-x0>"roi-x0"</a></code></li><li><code><a href=#roi-y0>"roi-y0"</a></code></li><li><code><a href=#roi-width>"roi-width"</a></code></li><li><code><a href=#roi-height>"roi-height"</a></code></li><li><code><a href=#roi-width-multiplier>"roi-width-multiplier"</a></code></li><li><code><a href=#roi-height-multiplier>"roi-height-multiplier"</a></code></li><li><code><a href=#has-streaming>"has-streaming"</a></code></li><li><code><a href=#has-camram-recording>"has-camram-recording"</a></code></li><li><code><a href=#transfer-asynchronously>"transfer-asynchronously"</a></code></li><li><code><a href=#is-recording>"is-recording"</a></code></li><li><code><a href=#is-readout>"is-readout"</a></code></li><li><code><a href=#frame-rate>"frame-rate"</a></code></li></ul><h2>Details</h2><dl><dt id="name"><a href="#toc">name</a></dt>
+<dd><pre><code class="prop-type">"name" : gchararray : Read-only</code></pre>
+<p>Name of the camera</p>
+</dd><dt id="sensor-width"><a href="#toc">sensor-width</a></dt>
+<dd><pre><code class="prop-type">"sensor-width" : guint : Read-only</code></pre>
+<p>Width of the sensor in pixels</p>
+</dd><dt id="sensor-height"><a href="#toc">sensor-height</a></dt>
+<dd><pre><code class="prop-type">"sensor-height" : guint : Read-only</code></pre>
+<p>Height of the sensor in pixels</p>
+</dd><dt id="sensor-bitdepth"><a href="#toc">sensor-bitdepth</a></dt>
+<dd><pre><code class="prop-type">"sensor-bitdepth" : guint : Read-only</code></pre>
+<p>Number of bits per pixel</p>
+</dd><dt id="sensor-horizontal-binning"><a href="#toc">sensor-horizontal-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in horizontal direction</p>
+</dd><dt id="sensor-horizontal-binnings"><a href="#toc">sensor-horizontal-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in horizontal direction</p>
+</dd><dt id="sensor-vertical-binning"><a href="#toc">sensor-vertical-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in vertical direction</p>
+</dd><dt id="sensor-vertical-binnings"><a href="#toc">sensor-vertical-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in vertical direction</p>
+</dd><dt id="sensor-max-frame-rate"><a href="#toc">sensor-max-frame-rate</a></dt>
+<dd><pre><code class="prop-type">"sensor-max-frame-rate" : gfloat : Read-only</code></pre>
+<p>Maximum frame rate at full frame resolution</p>
+</dd><dt id="trigger-mode"><a href="#toc">trigger-mode</a></dt>
+<dd><pre><code class="prop-type">"trigger-mode" : UcaCameraTrigger : Read / Write</code></pre>
+<p>Trigger mode</p>
+</dd><dt id="exposure-time"><a href="#toc">exposure-time</a></dt>
+<dd><pre><code class="prop-type">"exposure-time" : gdouble : Read / Write</code></pre>
+<p>Exposure time in seconds</p>
+</dd><dt id="roi-x0"><a href="#toc">roi-x0</a></dt>
+<dd><pre><code class="prop-type">"roi-x0" : guint : Read / Write</code></pre>
+<p>Horizontal coordinate</p>
+</dd><dt id="roi-y0"><a href="#toc">roi-y0</a></dt>
+<dd><pre><code class="prop-type">"roi-y0" : guint : Read / Write</code></pre>
+<p>Vertical coordinate</p>
+</dd><dt id="roi-width"><a href="#toc">roi-width</a></dt>
+<dd><pre><code class="prop-type">"roi-width" : guint : Read / Write</code></pre>
+<p>Width of the region of interest</p>
+</dd><dt id="roi-height"><a href="#toc">roi-height</a></dt>
+<dd><pre><code class="prop-type">"roi-height" : guint : Read / Write</code></pre>
+<p>Height of the region of interest</p>
+</dd><dt id="roi-width-multiplier"><a href="#toc">roi-width-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-width-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of horizontal ROI</p>
+</dd><dt id="roi-height-multiplier"><a href="#toc">roi-height-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-height-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of vertical ROI</p>
+</dd><dt id="has-streaming"><a href="#toc">has-streaming</a></dt>
+<dd><pre><code class="prop-type">"has-streaming" : gboolean : Read-only</code></pre>
+<p>Is the camera able to stream the data</p>
+</dd><dt id="has-camram-recording"><a href="#toc">has-camram-recording</a></dt>
+<dd><pre><code class="prop-type">"has-camram-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera able to record the data in-camera</p>
+</dd><dt id="transfer-asynchronously"><a href="#toc">transfer-asynchronously</a></dt>
+<dd><pre><code class="prop-type">"transfer-asynchronously" : gboolean : Read / Write</code></pre>
+<p>Specify whether data should be transfered asynchronously using a specified callback</p>
+</dd><dt id="is-recording"><a href="#toc">is-recording</a></dt>
+<dd><pre><code class="prop-type">"is-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera currently recording</p>
+</dd><dt id="is-readout"><a href="#toc">is-readout</a></dt>
+<dd><pre><code class="prop-type">"is-readout" : gboolean : Read-only</code></pre>
+<p>Is camera in readout mode</p>
+</dd><dt id="frame-rate"><a href="#toc">frame-rate</a></dt>
+<dd><pre><code class="prop-type">"frame-rate" : gfloat : Read / Write</code></pre>
+<p>Number of frames per second that are taken</p>
+</dd></dl></body></html>
diff --git a/docs/pco.html b/docs/pco.html
new file mode 100644
index 0000000..3f764e1
--- /dev/null
+++ b/docs/pco.html
@@ -0,0 +1,130 @@
+<html><head><link rel="stylesheet" href="style.css" type="text/css" /><link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700|Droid+Serif:400,400italic|Inconsolata' rel='stylesheet' type='text/css'><title>pco &mdash; properties</title></head><body><div id="header"><h1 class="title">Property documentation of pco</h1><h2>Properties</h2><ul id="toc"><li><code><a href=#name>"name"</a></code></li><li><code><a href=#sensor-width>"sensor-width"</a></code></li><li><code><a href=#sensor-height>"sensor-height"</a></code></li><li><code><a href=#sensor-bitdepth>"sensor-bitdepth"</a></code></li><li><code><a href=#sensor-horizontal-binning>"sensor-horizontal-binning"</a></code></li><li><code><a href=#sensor-horizontal-binnings>"sensor-horizontal-binnings"</a></code></li><li><code><a href=#sensor-vertical-binning>"sensor-vertical-binning"</a></code></li><li><code><a href=#sensor-vertical-binnings>"sensor-vertical-binnings"</a></code></li><li><code><a href=#sensor-max-frame-rate>"sensor-max-frame-rate"</a></code></li><li><code><a href=#trigger-mode>"trigger-mode"</a></code></li><li><code><a href=#exposure-time>"exposure-time"</a></code></li><li><code><a href=#frames-per-second>"frames-per-second"</a></code></li><li><code><a href=#roi-x0>"roi-x0"</a></code></li><li><code><a href=#roi-y0>"roi-y0"</a></code></li><li><code><a href=#roi-width>"roi-width"</a></code></li><li><code><a href=#roi-height>"roi-height"</a></code></li><li><code><a href=#roi-width-multiplier>"roi-width-multiplier"</a></code></li><li><code><a href=#roi-height-multiplier>"roi-height-multiplier"</a></code></li><li><code><a href=#has-streaming>"has-streaming"</a></code></li><li><code><a href=#has-camram-recording>"has-camram-recording"</a></code></li><li><code><a href=#transfer-asynchronously>"transfer-asynchronously"</a></code></li><li><code><a href=#is-recording>"is-recording"</a></code></li><li><code><a href=#is-readout>"is-readout"</a></code></li><li><code><a href=#sensor-extended>"sensor-extended"</a></code></li><li><code><a href=#sensor-width-extended>"sensor-width-extended"</a></code></li><li><code><a href=#sensor-height-extended>"sensor-height-extended"</a></code></li><li><code><a href=#sensor-temperature>"sensor-temperature"</a></code></li><li><code><a href=#sensor-pixelrates>"sensor-pixelrates"</a></code></li><li><code><a href=#sensor-pixelrate>"sensor-pixelrate"</a></code></li><li><code><a href=#sensor-adcs>"sensor-adcs"</a></code></li><li><code><a href=#sensor-max-adcs>"sensor-max-adcs"</a></code></li><li><code><a href=#delay-time>"delay-time"</a></code></li><li><code><a href=#has-double-image-mode>"has-double-image-mode"</a></code></li><li><code><a href=#double-image-mode>"double-image-mode"</a></code></li><li><code><a href=#offset-mode>"offset-mode"</a></code></li><li><code><a href=#record-mode>"record-mode"</a></code></li><li><code><a href=#acquire-mode>"acquire-mode"</a></code></li><li><code><a href=#cooling-point>"cooling-point"</a></code></li><li><code><a href=#cooling-point-min>"cooling-point-min"</a></code></li><li><code><a href=#cooling-point-max>"cooling-point-max"</a></code></li><li><code><a href=#cooling-point-default>"cooling-point-default"</a></code></li><li><code><a href=#noise-filter>"noise-filter"</a></code></li><li><code><a href=#timestamp-mode>"timestamp-mode"</a></code></li></ul><h2>Details</h2><dl><dt id="name"><a href="#toc">name</a></dt>
+<dd><pre><code class="prop-type">"name" : gchararray : Read-only</code></pre>
+<p>Name of the camera</p>
+</dd><dt id="sensor-width"><a href="#toc">sensor-width</a></dt>
+<dd><pre><code class="prop-type">"sensor-width" : guint : Read-only</code></pre>
+<p>Width of the sensor in pixels</p>
+</dd><dt id="sensor-height"><a href="#toc">sensor-height</a></dt>
+<dd><pre><code class="prop-type">"sensor-height" : guint : Read-only</code></pre>
+<p>Height of the sensor in pixels</p>
+</dd><dt id="sensor-bitdepth"><a href="#toc">sensor-bitdepth</a></dt>
+<dd><pre><code class="prop-type">"sensor-bitdepth" : guint : Read-only</code></pre>
+<p>Number of bits per pixel</p>
+</dd><dt id="sensor-horizontal-binning"><a href="#toc">sensor-horizontal-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in horizontal direction</p>
+</dd><dt id="sensor-horizontal-binnings"><a href="#toc">sensor-horizontal-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in horizontal direction</p>
+</dd><dt id="sensor-vertical-binning"><a href="#toc">sensor-vertical-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in vertical direction</p>
+</dd><dt id="sensor-vertical-binnings"><a href="#toc">sensor-vertical-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in vertical direction</p>
+</dd><dt id="sensor-max-frame-rate"><a href="#toc">sensor-max-frame-rate</a></dt>
+<dd><pre><code class="prop-type">"sensor-max-frame-rate" : gfloat : Read-only</code></pre>
+<p>Maximum frame rate at full frame resolution</p>
+</dd><dt id="trigger-mode"><a href="#toc">trigger-mode</a></dt>
+<dd><pre><code class="prop-type">"trigger-mode" : UcaCameraTrigger : Read / Write</code></pre>
+<p>Trigger mode</p>
+</dd><dt id="exposure-time"><a href="#toc">exposure-time</a></dt>
+<dd><pre><code class="prop-type">"exposure-time" : gdouble : Read / Write</code></pre>
+<p>Exposure time in seconds</p>
+</dd><dt id="frames-per-second"><a href="#toc">frames-per-second</a></dt>
+<dd><pre><code class="prop-type">"frames-per-second" : gdouble : Read / Write</code></pre>
+<p>Frames per second</p>
+</dd><dt id="roi-x0"><a href="#toc">roi-x0</a></dt>
+<dd><pre><code class="prop-type">"roi-x0" : guint : Read / Write</code></pre>
+<p>Horizontal coordinate</p>
+</dd><dt id="roi-y0"><a href="#toc">roi-y0</a></dt>
+<dd><pre><code class="prop-type">"roi-y0" : guint : Read / Write</code></pre>
+<p>Vertical coordinate</p>
+</dd><dt id="roi-width"><a href="#toc">roi-width</a></dt>
+<dd><pre><code class="prop-type">"roi-width" : guint : Read / Write</code></pre>
+<p>Width of the region of interest</p>
+</dd><dt id="roi-height"><a href="#toc">roi-height</a></dt>
+<dd><pre><code class="prop-type">"roi-height" : guint : Read / Write</code></pre>
+<p>Height of the region of interest</p>
+</dd><dt id="roi-width-multiplier"><a href="#toc">roi-width-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-width-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of horizontal ROI</p>
+</dd><dt id="roi-height-multiplier"><a href="#toc">roi-height-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-height-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of vertical ROI</p>
+</dd><dt id="has-streaming"><a href="#toc">has-streaming</a></dt>
+<dd><pre><code class="prop-type">"has-streaming" : gboolean : Read-only</code></pre>
+<p>Is the camera able to stream the data</p>
+</dd><dt id="has-camram-recording"><a href="#toc">has-camram-recording</a></dt>
+<dd><pre><code class="prop-type">"has-camram-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera able to record the data in-camera</p>
+</dd><dt id="transfer-asynchronously"><a href="#toc">transfer-asynchronously</a></dt>
+<dd><pre><code class="prop-type">"transfer-asynchronously" : gboolean : Read / Write</code></pre>
+<p>Specify whether data should be transfered asynchronously using a specified callback</p>
+</dd><dt id="is-recording"><a href="#toc">is-recording</a></dt>
+<dd><pre><code class="prop-type">"is-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera currently recording</p>
+</dd><dt id="is-readout"><a href="#toc">is-readout</a></dt>
+<dd><pre><code class="prop-type">"is-readout" : gboolean : Read-only</code></pre>
+<p>Is camera in readout mode</p>
+</dd><dt id="sensor-extended"><a href="#toc">sensor-extended</a></dt>
+<dd><pre><code class="prop-type">"sensor-extended" : gboolean : Read / Write</code></pre>
+<p>Use extended sensor format</p>
+</dd><dt id="sensor-width-extended"><a href="#toc">sensor-width-extended</a></dt>
+<dd><pre><code class="prop-type">"sensor-width-extended" : guint : Read-only</code></pre>
+<p>Width of the extended sensor in pixels</p>
+</dd><dt id="sensor-height-extended"><a href="#toc">sensor-height-extended</a></dt>
+<dd><pre><code class="prop-type">"sensor-height-extended" : guint : Read-only</code></pre>
+<p>Height of the extended sensor in pixels</p>
+</dd><dt id="sensor-temperature"><a href="#toc">sensor-temperature</a></dt>
+<dd><pre><code class="prop-type">"sensor-temperature" : gdouble : Read-only</code></pre>
+<p>Temperature of the sensor in degree Celsius</p>
+</dd><dt id="sensor-pixelrates"><a href="#toc">sensor-pixelrates</a></dt>
+<dd><pre><code class="prop-type">"sensor-pixelrates" : GValueArray : Read-only</code></pre>
+<p>Array of possible sensor pixel rates</p>
+</dd><dt id="sensor-pixelrate"><a href="#toc">sensor-pixelrate</a></dt>
+<dd><pre><code class="prop-type">"sensor-pixelrate" : guint : Read / Write</code></pre>
+<p>Pixel rate</p>
+</dd><dt id="sensor-adcs"><a href="#toc">sensor-adcs</a></dt>
+<dd><pre><code class="prop-type">"sensor-adcs" : guint : Read / Write</code></pre>
+<p>Number of ADCs to use</p>
+</dd><dt id="sensor-max-adcs"><a href="#toc">sensor-max-adcs</a></dt>
+<dd><pre><code class="prop-type">"sensor-max-adcs" : guint : Read-only</code></pre>
+<p>Maximum number of ADCs that can be set with "sensor-adcs"</p>
+</dd><dt id="delay-time"><a href="#toc">delay-time</a></dt>
+<dd><pre><code class="prop-type">"delay-time" : gdouble : Read / Write</code></pre>
+<p>Delay before starting actual exposure</p>
+</dd><dt id="has-double-image-mode"><a href="#toc">has-double-image-mode</a></dt>
+<dd><pre><code class="prop-type">"has-double-image-mode" : gboolean : Read-only</code></pre>
+<p>Is double image mode supported by this model</p>
+</dd><dt id="double-image-mode"><a href="#toc">double-image-mode</a></dt>
+<dd><pre><code class="prop-type">"double-image-mode" : gboolean : Read / Write</code></pre>
+<p>Use double image mode</p>
+</dd><dt id="offset-mode"><a href="#toc">offset-mode</a></dt>
+<dd><pre><code class="prop-type">"offset-mode" : gboolean : Read / Write</code></pre>
+<p>Use offset mode</p>
+</dd><dt id="record-mode"><a href="#toc">record-mode</a></dt>
+<dd><pre><code class="prop-type">"record-mode" : UcaPcoCameraRecordMode : Read / Write</code></pre>
+<p>Record mode</p>
+</dd><dt id="acquire-mode"><a href="#toc">acquire-mode</a></dt>
+<dd><pre><code class="prop-type">"acquire-mode" : UcaPcoCameraAcquireMode : Read / Write</code></pre>
+<p>Acquire mode</p>
+</dd><dt id="cooling-point"><a href="#toc">cooling-point</a></dt>
+<dd><pre><code class="prop-type">"cooling-point" : gint : Read / Write</code></pre>
+<p>Cooling point of the camera in degree celsius</p>
+</dd><dt id="cooling-point-min"><a href="#toc">cooling-point-min</a></dt>
+<dd><pre><code class="prop-type">"cooling-point-min" : gint : Read-only</code></pre>
+<p>Minimum cooling point in degree celsius</p>
+</dd><dt id="cooling-point-max"><a href="#toc">cooling-point-max</a></dt>
+<dd><pre><code class="prop-type">"cooling-point-max" : gint : Read-only</code></pre>
+<p>Maximum cooling point in degree celsius</p>
+</dd><dt id="cooling-point-default"><a href="#toc">cooling-point-default</a></dt>
+<dd><pre><code class="prop-type">"cooling-point-default" : gint : Read-only</code></pre>
+<p>Default cooling point in degree celsius</p>
+</dd><dt id="noise-filter"><a href="#toc">noise-filter</a></dt>
+<dd><pre><code class="prop-type">"noise-filter" : gboolean : Read / Write</code></pre>
+<p>Noise filter</p>
+</dd><dt id="timestamp-mode"><a href="#toc">timestamp-mode</a></dt>
+<dd><pre><code class="prop-type">"timestamp-mode" : UcaPcoCameraTimestamp : Read / Write</code></pre>
+<p>Timestamp mode</p>
+</dd></dl></body></html>
diff --git a/docs/style.css b/docs/style.css
index a9fc9ca..beccf45 100644
--- a/docs/style.css
+++ b/docs/style.css
@@ -1,35 +1,34 @@
-
 /* --- Reset ------------------------------------------------------ */
 
 body, div, dl, dt, dd, ul, ol, li,
 h1, h2, h3, h4, h5, h6,
 pre, form, fieldset, input, textarea,
-p, blockquote, th, td { 
-  margin: 0;
+p, blockquote, th, td {
+    margin: 0;
     padding: 0;
 }
 table {
-  border-collapse: collapse;
+    border-collapse: collapse;
     border-spacing: 0;
 }
 fieldset, img {
-  border: 0;
-  }
-  address, caption, cite, dfn, th, var {
+    border: 0;
+}
+address, caption, cite, dfn, th, var {
     font-style: normal;
-  font-weight: normal;
-  }
-  caption, th {
+    font-weight: normal;
+}
+caption, th {
     text-align: left;
 }
 h1, h2, h3, h4, h5, h6 {
-  font-size: 100%;
+    font-size: 100%;
     font-weight: normal;
 }
 q:before, q:after {
-  content: '';
-  }
-  abbr, acronym {
+    content: '';
+}
+abbr, acronym {
     border: 0;
 }
 
@@ -52,10 +51,6 @@ p {
     margin-bottom: 24px;
 }
 
-/* p > code { */
-/*     font-size: 0.8em; */
-/* } */
-
 h1, h2, h3, h4, h5, h6 {
     margin-bottom: 24px;
     font-family: "Droid Sans", sans-serif;
@@ -65,6 +60,9 @@ h1, h2, h3, h4, h5, h6 {
 h1 {
     font-size: 1.5em;
     line-height: 1em;
+    margin-top: 2em;
+    padding-bottom: 0.5em;
+    border-bottom: 2px dotted #bbb;
 }
 
 h2 {
@@ -87,11 +85,29 @@ h5, h6 {
     line-height: 1.5em;
 }
 
-h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a {
-    color: black;
+h1 > a {
+    color: #555;
     text-decoration: none;
 }
 
+a {
+    color: #8e3557;
+    text-decoration: none;
+}
+
+a:hover {
+    color: #88a33e;
+}
+
+h1:hover :after,
+h2:hover :after,
+h3:hover :after,
+h4:hover :after,
+h5:hover :after,
+h6:hover :after {
+    content: " \2191";
+}
+
 pre {
     margin-bottom: 24px;
     line-height: 1.2em;
@@ -103,19 +119,62 @@ code {
 }
 
 ul, ol {
+    list-style-position: inside;
+    padding-left: 1em;
+    text-indent: -1em;
+    margin-left: 0;
     margin-bottom: 24px;
 }
 
+ul#toc {
+    list-style-type: none;
+}
+
+li + li {
+    margin-top: 0.1em;
+}
+
 ul ul,
 ol ol {
     margin: 0 0 0 24px;
 }
 
+table {
+    width: 100%;
+    margin-bottom: 24px;
+}
+
+th {
+    color: #555;
+    font-family: 'Droid Sans', sans-serif;
+    font-weight: bold;
+    border-bottom: 1px dotted #bbb;
+}
+
+td, th {
+    padding: 2px;
+}
+
+dl {
+    margin-bottom: 24px;
+}
+
+dt {
+    font-style: italic;
+}
+
+dd {
+    margin-top: 12px;
+    padding-left: 1em;
+}
+
 .title {
     font-size: xx-large;
+    color: #555;
 }
 
 .author {
     font-size: 1.25em;
     font-weight: normal;
+    color: #555;
 }
author	Mihael Koep <koep@schneide.com>	2012-10-19 17:03:49 +0200
committer	Mihael Koep <koep@schneide.com>	2012-10-19 17:03:49 +0200
commit	9866002f3f569f6da886d71964d3298183cd1646 (patch)
tree	968097e2f5fa11a094238ead6469739a725d8ce2 /docs
parent	37f48ae1b67b1205ba4884ec350afdf5ab7dd2d3 (diff)
parent	6f12303cf4c4130d544c30f8ad5e2445a1fa3e61 (diff)
download	uca-9866002f3f569f6da886d71964d3298183cd1646.tar.gz uca-9866002f3f569f6da886d71964d3298183cd1646.tar.bz2 uca-9866002f3f569f6da886d71964d3298183cd1646.tar.xz uca-9866002f3f569f6da886d71964d3298183cd1646.zip