summaryrefslogtreecommitdiffstats
path: root/docs/file.rst
blob: f698d78f0c418f2b1020c3b128ce22b9f047cca9 (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

file
====

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-source**
    Trigger source

    | *Default:* <enum UCA_CAMERA_TRIGGER_SOURCE_AUTO of type UcaCameraTriggerSource>

None **trigger-type**
    Trigger type

    | *Default:* <enum UCA_CAMERA_TRIGGER_TYPE_EDGE of type UcaCameraTriggerType>

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]

string **path**
    Path to directory containing TIFF files

    | *Default:* .