diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@gmail.com> | 2012-10-18 11:59:24 +0200 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@gmail.com> | 2012-10-18 11:59:24 +0200 |
| commit | e16087fbe25df8901e9221602570c074ae887450 (patch) | |
| tree | e18398799fa279306f4f8e92f45d9ce1aa553fcc /docs | |
| parent | a1ab005916ba3aa50923294c5be3da0ded16fbc0 (diff) | |
| download | libuca-e16087fbe25df8901e9221602570c074ae887450.tar.gz libuca-e16087fbe25df8901e9221602570c074ae887450.tar.bz2 libuca-e16087fbe25df8901e9221602570c074ae887450.tar.xz libuca-e16087fbe25df8901e9221602570c074ae887450.zip | |
Add pco property documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual.md | 2 | ||||
| -rw-r--r-- | docs/pco.html | 130 |
2 files changed, 132 insertions, 0 deletions
diff --git a/docs/manual.md b/docs/manual.md index 8bf38aa..a68400e 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -260,9 +260,11 @@ The following cameras are supported: ## 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 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 — 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> |