summaryrefslogtreecommitdiffstats
path: root/docs/pco.rst
blob: 6d29226ad6f31b1187a91139a296697ede9d8c6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

pco
===

string **name**
    Name of the camera

    | *Default:* 

unsigned int **sensor-width**
    Width of the sensor in pixels

    | *Default:* 1
    | *Range:* [1, 4294967295]

unsigned int **sensor-height**
    Height of the sensor in pixels

    | *Default:* 1
    | *Range:* [1, 4294967295]

double **sensor-pixel-width**
    Width of sensor pixel in meters

    | *Default:* 1e-05
    | *Range:* [2.22507385851e-308, 1.79769313486e+308]

double **sensor-pixel-height**
    Height of sensor pixel in meters

    | *Default:* 1e-05
    | *Range:* [2.22507385851e-308, 1.79769313486e+308]

unsigned int **sensor-bitdepth**
    Number of bits per pixel

    | *Default:* 1
    | *Range:* [1, 32]

unsigned int **sensor-horizontal-binning**
    Number of sensor ADCs that are combined to one pixel in horizontal direction

    | *Default:* 1
    | *Range:* [1, 4294967295]

None **sensor-horizontal-binnings**
    Array of possible binnings in horizontal direction

    | *Default:* None

unsigned int **sensor-vertical-binning**
    Number of sensor ADCs that are combined to one pixel in vertical direction

    | *Default:* 1
    | *Range:* [1, 4294967295]

None **sensor-vertical-binnings**
    Array of possible binnings in vertical direction

    | *Default:* None

None **trigger-mode**
    Trigger mode

    | *Default:* <enum UCA_CAMERA_TRIGGER_AUTO of type UcaCameraTrigger>

double **exposure-time**
    Exposure time in seconds

    | *Default:* 1.0
    | *Range:* [0.0, 1.79769313486e+308]

double **frames-per-second**
    Frames per second

    | *Default:* 1.0
    | *Range:* [2.22507385851e-308, 1.79769313486e+308]

unsigned int **roi-x0**
    Horizontal coordinate

    | *Default:* 0
    | *Range:* [0, 4294967295]

unsigned int **roi-y0**
    Vertical coordinate

    | *Default:* 0
    | *Range:* [0, 4294967295]

unsigned int **roi-width**
    Width of the region of interest

    | *Default:* 1
    | *Range:* [1, 4294967295]

unsigned int **roi-height**
    Height of the region of interest

    | *Default:* 1
    | *Range:* [1, 4294967295]

unsigned int **roi-width-multiplier**
    Minimum possible step size of horizontal ROI

    | *Default:* 1
    | *Range:* [1, 4294967295]

unsigned int **roi-height-multiplier**
    Minimum possible step size of vertical ROI

    | *Default:* 1
    | *Range:* [1, 4294967295]

bool **has-streaming**
    Is the camera able to stream the data

    | *Default:* True

bool **has-camram-recording**
    Is the camera able to record the data in-camera

    | *Default:* False

unsigned int **recorded-frames**
    Number of frames recorded into internal camera memory

    | *Default:* 0
    | *Range:* [0, 4294967295]

bool **transfer-asynchronously**
    Specify whether data should be transfered asynchronously using a specified callback

    | *Default:* False

bool **is-recording**
    Is the camera currently recording

    | *Default:* False

bool **is-readout**
    Is camera in readout mode

    | *Default:* False

bool **buffered**
    TRUE if libuca should buffer frames

    | *Default:* False

unsigned int **num-buffers**
    Number of frame buffers in the ring buffer 

    | *Default:* 4
    | *Range:* [0, 4294967295]

bool **sensor-extended**
    Use extended sensor format

    | *Default:* False

unsigned int **sensor-width-extended**
    Width of the extended sensor in pixels

    | *Default:* 1
    | *Range:* [1, 4294967295]

unsigned int **sensor-height-extended**
    Height of the extended sensor in pixels

    | *Default:* 1
    | *Range:* [1, 4294967295]

double **sensor-temperature**
    Temperature of the sensor in degree Celsius

    | *Default:* 0.0
    | *Range:* [-1.79769313486e+308, 1.79769313486e+308]

None **sensor-pixelrates**
    Array of possible sensor pixel rates

    | *Default:* None

unsigned int **sensor-pixelrate**
    Pixel rate

    | *Default:* 1
    | *Range:* [1, 4294967295]

unsigned int **sensor-adcs**
    Number of ADCs to use

    | *Default:* 1
    | *Range:* [1, 2]

unsigned int **sensor-max-adcs**
    Maximum number of ADCs that can be set with "sensor-adcs"

    | *Default:* 1
    | *Range:* [1, 4294967295]

bool **has-double-image-mode**
    Is double image mode supported by this model

    | *Default:* False

bool **double-image-mode**
    Use double image mode

    | *Default:* False

bool **offset-mode**
    Use offset mode

    | *Default:* False

None **record-mode**
    Record mode

    | *Default:* <enum UCA_PCO_CAMERA_RECORD_MODE_SEQUENCE of type UcaPcoCameraRecordMode>

None **storage-mode**
    Storage mode

    | *Default:* <enum UCA_PCO_CAMERA_STORAGE_MODE_FIFO_BUFFER of type UcaPcoCameraStorageMode>

None **acquire-mode**
    Acquire mode

    | *Default:* <enum UCA_PCO_CAMERA_ACQUIRE_MODE_AUTO of type UcaPcoCameraAcquireMode>

bool **fast-scan**
    Use fast scan mode with less dynamic range

    | *Default:* False

int **cooling-point**
    Cooling point of the camera in degree celsius

    | *Default:* 5
    | *Range:* [0, 10]

int **cooling-point-min**
    Minimum cooling point in degree celsius

    | *Default:* 0
    | *Range:* [-2147483648, 2147483647]

int **cooling-point-max**
    Maximum cooling point in degree celsius

    | *Default:* 0
    | *Range:* [-2147483648, 2147483647]

int **cooling-point-default**
    Default cooling point in degree celsius

    | *Default:* 0
    | *Range:* [-2147483648, 2147483647]

bool **noise-filter**
    Noise filter

    | *Default:* False

None **timestamp-mode**
    Timestamp mode

    | *Default:* <enum UCA_PCO_CAMERA_TIMESTAMP_NONE of type UcaPcoCameraTimestamp>

string **version**
    Camera version given as `serial number, hardware major.minor, firmware major.minor'

    | *Default:* 0, 0.0, 0.0

bool **global-shutter**
    Global shutter enabled

    | *Default:* False