Project

General

Profile

12-bit Pixel Format using Python Harvester ยป harvesters.core.html

Will Van Hyning, 07/09/2019 06:31 PM

 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
<html><head><title>Python: module harvesters.core</title>
3
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4
</head><body bgcolor="#f0f0f8">
5

    
6
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7
<tr bgcolor="#7799ee">
8
<td valign=bottom>&nbsp;<br>
9
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="harvesters.html"><font color="#ffffff">harvesters</font></a>.core</strong></big></big></font></td
10
><td align=right valign=bottom
11
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Cspace%20rangers%5C.conda%5Cenvs%5Cgenicam%5Clib%5Csite-packages%5Charvesters%5Ccore.py">c:\users\space rangers\.conda\envs\genicam\lib\site-packages\harvesters\core.py</a></font></td></tr></table>
12
    <p><tt>#&nbsp;----------------------------------------------------------------------------<br>
13
#<br>
14
#&nbsp;Copyright&nbsp;2018&nbsp;EMVA<br>
15
#<br>
16
#&nbsp;Licensed&nbsp;under&nbsp;the&nbsp;Apache&nbsp;License,&nbsp;Version&nbsp;2.0&nbsp;(the&nbsp;"License");<br>
17
#&nbsp;you&nbsp;may&nbsp;not&nbsp;use&nbsp;this&nbsp;file&nbsp;except&nbsp;in&nbsp;compliance&nbsp;with&nbsp;the&nbsp;License.<br>
18
#&nbsp;You&nbsp;may&nbsp;obtain&nbsp;a&nbsp;copy&nbsp;of&nbsp;the&nbsp;License&nbsp;at<br>
19
#<br>
20
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
21
#<br>
22
#&nbsp;Unless&nbsp;required&nbsp;by&nbsp;applicable&nbsp;law&nbsp;or&nbsp;agreed&nbsp;to&nbsp;in&nbsp;writing,&nbsp;software<br>
23
#&nbsp;distributed&nbsp;under&nbsp;the&nbsp;License&nbsp;is&nbsp;distributed&nbsp;on&nbsp;an&nbsp;"AS&nbsp;IS"&nbsp;BASIS,<br>
24
#&nbsp;WITHOUT&nbsp;WARRANTIES&nbsp;OR&nbsp;CONDITIONS&nbsp;OF&nbsp;ANY&nbsp;KIND,&nbsp;either&nbsp;express&nbsp;or&nbsp;implied.<br>
25
#&nbsp;See&nbsp;the&nbsp;License&nbsp;for&nbsp;the&nbsp;specific&nbsp;language&nbsp;governing&nbsp;permissions&nbsp;and<br>
26
#&nbsp;limitations&nbsp;under&nbsp;the&nbsp;License.<br>
27
#<br>
28
#&nbsp;----------------------------------------------------------------------------</tt></p>
29
<p>
30
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
31
<tr bgcolor="#aa55cc">
32
<td colspan=3 valign=bottom>&nbsp;<br>
33
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
34
    
35
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
36
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="io.html">io</a><br>
37
<a href="numpy.html">numpy</a><br>
38
<a href="os.html">os</a><br>
39
</td><td width="25%" valign=top><a href="pathlib.html">pathlib</a><br>
40
<a href="signal.html">signal</a><br>
41
<a href="sys.html">sys</a><br>
42
</td><td width="25%" valign=top><a href="time.html">time</a><br>
43
<a href="weakref.html">weakref</a><br>
44
<a href="zipfile.html">zipfile</a><br>
45
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
46
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
47
<tr bgcolor="#ee77aa">
48
<td colspan=3 valign=bottom>&nbsp;<br>
49
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
50
    
51
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
52
<td width="100%"><dl>
53
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
54
</font></dt><dd>
55
<dl>
56
<dt><font face="helvetica, arial"><a href="harvesters.core.html#Buffer">Buffer</a>
57
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#ComponentBase">ComponentBase</a>
58
</font></dt><dd>
59
<dl>
60
<dt><font face="helvetica, arial"><a href="harvesters.core.html#Component2DImage">Component2DImage</a>
61
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#ComponentUnknown">ComponentUnknown</a>
62
</font></dt></dl>
63
</dd>
64
<dt><font face="helvetica, arial"><a href="harvesters.core.html#Harvester">Harvester</a>
65
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#ImageAcquirer">ImageAcquirer</a>
66
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#MutexLocker">MutexLocker</a>
67
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadBase">PayloadBase</a>
68
</font></dt><dd>
69
<dl>
70
<dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadChunkOnly">PayloadChunkOnly</a>
71
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadFile">PayloadFile</a>
72
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadH264">PayloadH264</a>
73
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadImage">PayloadImage</a>
74
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadJPEG">PayloadJPEG</a>
75
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadJPEG2000">PayloadJPEG2000</a>
76
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadMultiPart">PayloadMultiPart</a>
77
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadRawData">PayloadRawData</a>
78
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadUnknown">PayloadUnknown</a>
79
</font></dt></dl>
80
</dd>
81
<dt><font face="helvetica, arial"><a href="harvesters.core.html#ThreadBase">ThreadBase</a>
82
</font></dt></dl>
83
</dd>
84
</dl>
85
 <p>
86
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
87
<tr bgcolor="#ffc8d8">
88
<td colspan=3 valign=bottom>&nbsp;<br>
89
<font color="#000000" face="helvetica, arial"><a name="Buffer">class <strong>Buffer</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
90
    
91
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
92
<td colspan=2><tt><a href="#Buffer">Buffer</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
93
&nbsp;<br>
94
Is&nbsp;provided&nbsp;by&nbsp;an&nbsp;:class:`ImageAcquire`&nbsp;<a href="builtins.html#object">object</a>&nbsp;when&nbsp;you&nbsp;call&nbsp;its<br>
95
:meth:`~harvesters.core.<a href="#ImageAcquirer">ImageAcquirer</a>.fetch_buffer`&nbsp;method.&nbsp;It&nbsp;provides<br>
96
you&nbsp;a&nbsp;way&nbsp;to&nbsp;access&nbsp;acquired&nbsp;data&nbsp;and&nbsp;its&nbsp;relevant&nbsp;information.<br>
97
&nbsp;<br>
98
Note&nbsp;that&nbsp;it&nbsp;will&nbsp;never&nbsp;be&nbsp;necessary&nbsp;to&nbsp;create&nbsp;this&nbsp;<a href="builtins.html#object">object</a>&nbsp;by&nbsp;yourself<br>
99
in&nbsp;general.<br>&nbsp;</tt></td></tr>
100
<tr><td>&nbsp;</td>
101
<td width="100%">Methods defined here:<br>
102
<dl><dt><a name="Buffer-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
103

    
104
<dl><dt><a name="Buffer-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
105

    
106
<dl><dt><a name="Buffer-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
107
:param&nbsp;node_map:<br>
108
:param&nbsp;logger:</tt></dd></dl>
109

    
110
<dl><dt><a name="Buffer-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>
111

    
112
<dl><dt><a name="Buffer-queue"><strong>queue</strong></a>(self)</dt><dd><tt>Queues&nbsp;the&nbsp;buffer&nbsp;to&nbsp;prepare&nbsp;for&nbsp;the&nbsp;upcoming&nbsp;image&nbsp;acquisition.&nbsp;Once<br>
113
the&nbsp;buffer&nbsp;is&nbsp;queued,&nbsp;the&nbsp;:class:`<a href="#Buffer">Buffer</a>`&nbsp;<a href="builtins.html#object">object</a>&nbsp;will&nbsp;be&nbsp;obsolete.<br>
114
You'll&nbsp;have&nbsp;nothing&nbsp;to&nbsp;do&nbsp;with&nbsp;it.<br>
115
&nbsp;<br>
116
Note&nbsp;that&nbsp;you&nbsp;have&nbsp;to&nbsp;return&nbsp;the&nbsp;ownership&nbsp;of&nbsp;the&nbsp;fetched&nbsp;buffers&nbsp;to<br>
117
the&nbsp;:class:`<a href="#ImageAcquirer">ImageAcquirer</a>`&nbsp;<a href="builtins.html#object">object</a>&nbsp;before&nbsp;stopping&nbsp;image&nbsp;acquisition<br>
118
calling&nbsp;this&nbsp;method&nbsp;because&nbsp;the&nbsp;:class:`<a href="#ImageAcquirer">ImageAcquirer</a>`&nbsp;<a href="builtins.html#object">object</a>&nbsp;tries<br>
119
to&nbsp;clear&nbsp;the&nbsp;self-allocated&nbsp;buffers&nbsp;when&nbsp;it&nbsp;stops&nbsp;image&nbsp;acquisition.</tt></dd></dl>
120

    
121
<hr>
122
Data descriptors defined here:<br>
123
<dl><dt><strong>__dict__</strong></dt>
124
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
125
</dl>
126
<dl><dt><strong>__weakref__</strong></dt>
127
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
128
</dl>
129
<dl><dt><strong>payload</strong></dt>
130
<dd><tt>:return:&nbsp;A&nbsp;containing&nbsp;object&nbsp;which&nbsp;derives&nbsp;from&nbsp;:class:`PayloadBase`&nbsp;class.</tt></dd>
131
</dl>
132
<dl><dt><strong>payload_type</strong></dt>
133
<dd><tt>:return:&nbsp;The&nbsp;payload&nbsp;type&nbsp;that&nbsp;the&nbsp;:class:`Buffer`&nbsp;object&nbsp;contains.</tt></dd>
134
</dl>
135
<dl><dt><strong>timestamp</strong></dt>
136
<dd><tt>:return:&nbsp;The&nbsp;timestamp&nbsp;in&nbsp;the&nbsp;TL&nbsp;specific&nbsp;unit.</tt></dd>
137
</dl>
138
<dl><dt><strong>timestamp_frequency</strong></dt>
139
<dd><tt>:return:&nbsp;The&nbsp;timestamp&nbsp;frequency&nbsp;which&nbsp;is&nbsp;used&nbsp;to&nbsp;represent&nbsp;a&nbsp;timestamp.</tt></dd>
140
</dl>
141
<dl><dt><strong>timestamp_ns</strong></dt>
142
<dd><tt>:return:&nbsp;The&nbsp;timestamp&nbsp;in&nbsp;nano-second.</tt></dd>
143
</dl>
144
</td></tr></table> <p>
145
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
146
<tr bgcolor="#ffc8d8">
147
<td colspan=3 valign=bottom>&nbsp;<br>
148
<font color="#000000" face="helvetica, arial"><a name="Component2DImage">class <strong>Component2DImage</strong></a>(<a href="harvesters.core.html#ComponentBase">ComponentBase</a>)</font></td></tr>
149
    
150
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
151
<td colspan=2><tt><a href="#Component2DImage">Component2DImage</a>(*,&nbsp;buffer=None,&nbsp;part=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
152
&nbsp;<br>
153
Represents&nbsp;a&nbsp;data&nbsp;component&nbsp;that&nbsp;is&nbsp;classified&nbsp;as<br>
154
:const:`PART_DATATYPE_2D_IMAGE`&nbsp;by&nbsp;the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
155
<tr><td>&nbsp;</td>
156
<td width="100%"><dl><dt>Method resolution order:</dt>
157
<dd><a href="harvesters.core.html#Component2DImage">Component2DImage</a></dd>
158
<dd><a href="harvesters.core.html#ComponentBase">ComponentBase</a></dd>
159
<dd><a href="builtins.html#object">builtins.object</a></dd>
160
</dl>
161
<hr>
162
Methods defined here:<br>
163
<dl><dt><a name="Component2DImage-__init__"><strong>__init__</strong></a>(self, *, buffer=None, part=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
164
:param&nbsp;part:<br>
165
:param&nbsp;node_map:</tt></dd></dl>
166

    
167
<dl><dt><a name="Component2DImage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>
168

    
169
<dl><dt><a name="Component2DImage-represent_pixel_location"><strong>represent_pixel_location</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;NumPy&nbsp;array&nbsp;that&nbsp;represents&nbsp;the&nbsp;2D&nbsp;pixel&nbsp;location,<br>
170
which&nbsp;is&nbsp;defined&nbsp;by&nbsp;PFNC,&nbsp;of&nbsp;the&nbsp;original&nbsp;image&nbsp;data.<br>
171
&nbsp;<br>
172
You&nbsp;may&nbsp;use&nbsp;the&nbsp;returned&nbsp;NumPy&nbsp;array&nbsp;for&nbsp;a&nbsp;calculation&nbsp;to&nbsp;map&nbsp;the<br>
173
original&nbsp;image&nbsp;to&nbsp;another&nbsp;format.<br>
174
&nbsp;<br>
175
:return:&nbsp;A&nbsp;NumPy&nbsp;array&nbsp;that&nbsp;represents&nbsp;the&nbsp;2D&nbsp;pixel&nbsp;location.</tt></dd></dl>
176

    
177
<hr>
178
Data descriptors defined here:<br>
179
<dl><dt><strong>data_format</strong></dt>
180
<dd><tt>:return:&nbsp;The&nbsp;data&nbsp;type&nbsp;of&nbsp;the&nbsp;data&nbsp;component&nbsp;as&nbsp;string.</tt></dd>
181
</dl>
182
<dl><dt><strong>data_format_value</strong></dt>
183
<dd><tt>:return:&nbsp;The&nbsp;data&nbsp;type&nbsp;of&nbsp;the&nbsp;data&nbsp;component&nbsp;as&nbsp;integer&nbsp;value.</tt></dd>
184
</dl>
185
<dl><dt><strong>delivered_image_height</strong></dt>
186
<dd><tt>:return:&nbsp;The&nbsp;image&nbsp;height&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
187
</dl>
188
<dl><dt><strong>height</strong></dt>
189
<dd><tt>:return:&nbsp;The&nbsp;height&nbsp;of&nbsp;the&nbsp;data&nbsp;component&nbsp;in&nbsp;the&nbsp;buffer&nbsp;in&nbsp;number&nbsp;of&nbsp;pixels.</tt></dd>
190
</dl>
191
<dl><dt><strong>num_components_per_pixel</strong></dt>
192
<dd><tt>:return:&nbsp;The&nbsp;number&nbsp;of&nbsp;data&nbsp;components&nbsp;per&nbsp;pixel.</tt></dd>
193
</dl>
194
<dl><dt><strong>width</strong></dt>
195
<dd><tt>:return:&nbsp;The&nbsp;width&nbsp;of&nbsp;the&nbsp;data&nbsp;component&nbsp;in&nbsp;the&nbsp;buffer&nbsp;in&nbsp;number&nbsp;of&nbsp;pixels.</tt></dd>
196
</dl>
197
<dl><dt><strong>x_offset</strong></dt>
198
<dd><tt>:return:&nbsp;The&nbsp;X&nbsp;offset&nbsp;of&nbsp;the&nbsp;data&nbsp;in&nbsp;the&nbsp;buffer&nbsp;in&nbsp;number&nbsp;of&nbsp;pixels&nbsp;from&nbsp;the&nbsp;image&nbsp;origin&nbsp;to&nbsp;handle&nbsp;areas&nbsp;of&nbsp;interest.</tt></dd>
199
</dl>
200
<dl><dt><strong>x_padding</strong></dt>
201
<dd><tt>Returns<br>
202
:return:&nbsp;The&nbsp;X&nbsp;padding&nbsp;of&nbsp;the&nbsp;data&nbsp;component&nbsp;in&nbsp;the&nbsp;buffer&nbsp;in&nbsp;number&nbsp;of&nbsp;pixels.</tt></dd>
203
</dl>
204
<dl><dt><strong>y_offset</strong></dt>
205
<dd><tt>:return:&nbsp;The&nbsp;Y&nbsp;offset&nbsp;of&nbsp;the&nbsp;data&nbsp;in&nbsp;the&nbsp;buffer&nbsp;in&nbsp;number&nbsp;of&nbsp;pixels&nbsp;from&nbsp;the&nbsp;image&nbsp;origin&nbsp;to&nbsp;handle&nbsp;areas&nbsp;of&nbsp;interest.</tt></dd>
206
</dl>
207
<dl><dt><strong>y_padding</strong></dt>
208
<dd><tt>:return:&nbsp;The&nbsp;Y&nbsp;padding&nbsp;of&nbsp;the&nbsp;data&nbsp;component&nbsp;in&nbsp;the&nbsp;buffer&nbsp;in&nbsp;number&nbsp;of&nbsp;pixels.</tt></dd>
209
</dl>
210
<hr>
211
Data descriptors inherited from <a href="harvesters.core.html#ComponentBase">ComponentBase</a>:<br>
212
<dl><dt><strong>__dict__</strong></dt>
213
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
214
</dl>
215
<dl><dt><strong>__weakref__</strong></dt>
216
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
217
</dl>
218
<dl><dt><strong>data</strong></dt>
219
<dd><tt>:return:&nbsp;The&nbsp;component&nbsp;data.</tt></dd>
220
</dl>
221
<dl><dt><strong>data_format_namespace</strong></dt>
222
<dd><tt>:return:&nbsp;The&nbsp;data&nbsp;type&nbsp;namespace&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
223
</dl>
224
<dl><dt><strong>source_id</strong></dt>
225
<dd><tt>:return:&nbsp;The&nbsp;source&nbsp;ID&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
226
</dl>
227
</td></tr></table> <p>
228
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
229
<tr bgcolor="#ffc8d8">
230
<td colspan=3 valign=bottom>&nbsp;<br>
231
<font color="#000000" face="helvetica, arial"><a name="ComponentBase">class <strong>ComponentBase</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
232
    
233
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
234
<td colspan=2><tt><a href="#ComponentBase">ComponentBase</a>(*,&nbsp;buffer=None)<br>
235
&nbsp;<br>
236
Is&nbsp;a&nbsp;base&nbsp;class&nbsp;of&nbsp;various&nbsp;data&nbsp;component&nbsp;types.<br>&nbsp;</tt></td></tr>
237
<tr><td>&nbsp;</td>
238
<td width="100%">Methods defined here:<br>
239
<dl><dt><a name="ComponentBase-__init__"><strong>__init__</strong></a>(self, *, buffer=None)</dt><dd><tt>:param&nbsp;buffer:</tt></dd></dl>
240

    
241
<hr>
242
Data descriptors defined here:<br>
243
<dl><dt><strong>__dict__</strong></dt>
244
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
245
</dl>
246
<dl><dt><strong>__weakref__</strong></dt>
247
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
248
</dl>
249
<dl><dt><strong>data</strong></dt>
250
<dd><tt>:return:&nbsp;The&nbsp;component&nbsp;data.</tt></dd>
251
</dl>
252
<dl><dt><strong>data_format</strong></dt>
253
<dd><tt>:return:&nbsp;The&nbsp;data&nbsp;type&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
254
</dl>
255
<dl><dt><strong>data_format_namespace</strong></dt>
256
<dd><tt>:return:&nbsp;The&nbsp;data&nbsp;type&nbsp;namespace&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
257
</dl>
258
<dl><dt><strong>source_id</strong></dt>
259
<dd><tt>:return:&nbsp;The&nbsp;source&nbsp;ID&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
260
</dl>
261
</td></tr></table> <p>
262
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
263
<tr bgcolor="#ffc8d8">
264
<td colspan=3 valign=bottom>&nbsp;<br>
265
<font color="#000000" face="helvetica, arial"><a name="ComponentUnknown">class <strong>ComponentUnknown</strong></a>(<a href="harvesters.core.html#ComponentBase">ComponentBase</a>)</font></td></tr>
266
    
267
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
268
<td colspan=2><tt>Represents&nbsp;a&nbsp;data&nbsp;component&nbsp;that&nbsp;is&nbsp;classified&nbsp;as<br>
269
:const:`PART_DATATYPE_UNKNOWN`&nbsp;by&nbsp;the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
270
<tr><td>&nbsp;</td>
271
<td width="100%"><dl><dt>Method resolution order:</dt>
272
<dd><a href="harvesters.core.html#ComponentUnknown">ComponentUnknown</a></dd>
273
<dd><a href="harvesters.core.html#ComponentBase">ComponentBase</a></dd>
274
<dd><a href="builtins.html#object">builtins.object</a></dd>
275
</dl>
276
<hr>
277
Methods defined here:<br>
278
<dl><dt><a name="ComponentUnknown-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>:param&nbsp;buffer:</tt></dd></dl>
279

    
280
<hr>
281
Data descriptors inherited from <a href="harvesters.core.html#ComponentBase">ComponentBase</a>:<br>
282
<dl><dt><strong>__dict__</strong></dt>
283
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
284
</dl>
285
<dl><dt><strong>__weakref__</strong></dt>
286
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
287
</dl>
288
<dl><dt><strong>data</strong></dt>
289
<dd><tt>:return:&nbsp;The&nbsp;component&nbsp;data.</tt></dd>
290
</dl>
291
<dl><dt><strong>data_format</strong></dt>
292
<dd><tt>:return:&nbsp;The&nbsp;data&nbsp;type&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
293
</dl>
294
<dl><dt><strong>data_format_namespace</strong></dt>
295
<dd><tt>:return:&nbsp;The&nbsp;data&nbsp;type&nbsp;namespace&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
296
</dl>
297
<dl><dt><strong>source_id</strong></dt>
298
<dd><tt>:return:&nbsp;The&nbsp;source&nbsp;ID&nbsp;of&nbsp;the&nbsp;data&nbsp;component.</tt></dd>
299
</dl>
300
</td></tr></table> <p>
301
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
302
<tr bgcolor="#ffc8d8">
303
<td colspan=3 valign=bottom>&nbsp;<br>
304
<font color="#000000" face="helvetica, arial"><a name="Harvester">class <strong>Harvester</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
305
    
306
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
307
<td colspan=2><tt><a href="#Harvester">Harvester</a>(*,&nbsp;profile=False,&nbsp;logger=None)<br>
308
&nbsp;<br>
309
Is&nbsp;the&nbsp;class&nbsp;that&nbsp;works&nbsp;for&nbsp;you&nbsp;as&nbsp;<a href="#Harvester">Harvester</a>&nbsp;Core.&nbsp;Everything&nbsp;begins&nbsp;with<br>
310
this&nbsp;class.<br>&nbsp;</tt></td></tr>
311
<tr><td>&nbsp;</td>
312
<td width="100%">Methods defined here:<br>
313
<dl><dt><a name="Harvester-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
314

    
315
<dl><dt><a name="Harvester-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
316

    
317
<dl><dt><a name="Harvester-__init__"><strong>__init__</strong></a>(self, *, profile=False, logger=None)</dt><dd><tt>:param&nbsp;profile:<br>
318
:param&nbsp;logger:</tt></dd></dl>
319

    
320
<dl><dt><a name="Harvester-add_cti_file"><strong>add_cti_file</strong></a>(self, file_path: str)</dt><dd><tt>Adds&nbsp;a&nbsp;CTI&nbsp;file&nbsp;to&nbsp;work&nbsp;with&nbsp;to&nbsp;the&nbsp;CTI&nbsp;file&nbsp;list.<br>
321
&nbsp;<br>
322
:param&nbsp;file_path:&nbsp;Set&nbsp;a&nbsp;file&nbsp;path&nbsp;to&nbsp;the&nbsp;target&nbsp;CTI&nbsp;file.<br>
323
&nbsp;<br>
324
:return:&nbsp;None.</tt></dd></dl>
325

    
326
<dl><dt><a name="Harvester-create_image_acquirer"><strong>create_image_acquirer</strong></a>(self, list_index=None, *, id_=None, vendor=None, model=None, tl_type=None, user_defined_name=None, serial_number=None, version=None, sleep_duration=1e-06, file_path=None, privilege='exclusive')</dt><dd><tt>Creates&nbsp;an&nbsp;image&nbsp;acquirer&nbsp;for&nbsp;the&nbsp;specified&nbsp;remote&nbsp;device&nbsp;and&nbsp;return<br>
327
the&nbsp;created&nbsp;:class:`<a href="#ImageAcquirer">ImageAcquirer</a>`&nbsp;<a href="builtins.html#object">object</a>.<br>
328
&nbsp;<br>
329
:param&nbsp;list_index:&nbsp;(Optional)&nbsp;Set&nbsp;an&nbsp;item&nbsp;index&nbsp;of&nbsp;the&nbsp;list&nbsp;of&nbsp;:class:`DeviceInfo`&nbsp;objects.<br>
330
:param&nbsp;id_:&nbsp;(Optional)&nbsp;Set&nbsp;an&nbsp;index&nbsp;of&nbsp;the&nbsp;device&nbsp;information&nbsp;list.<br>
331
:param&nbsp;vendor:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;vendor&nbsp;name&nbsp;of&nbsp;the&nbsp;target&nbsp;device.<br>
332
:param&nbsp;model:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;model&nbsp;name&nbsp;of&nbsp;the&nbsp;target&nbsp;device.<br>
333
:param&nbsp;tl_type:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;transport&nbsp;layer&nbsp;type&nbsp;of&nbsp;the&nbsp;target&nbsp;device.<br>
334
:param&nbsp;user_defined_name:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;user&nbsp;defined&nbsp;name&nbsp;string&nbsp;of&nbsp;the&nbsp;target&nbsp;device.<br>
335
:param&nbsp;serial_number:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;serial&nbsp;number&nbsp;string&nbsp;of&nbsp;the&nbsp;target&nbsp;device.<br>
336
:param&nbsp;version:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;version&nbsp;number&nbsp;string&nbsp;of&nbsp;the&nbsp;target&nbsp;device.<br>
337
:param&nbsp;sleep_duration:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;sleep&nbsp;duration&nbsp;in&nbsp;second&nbsp;that&nbsp;is&nbsp;inserted&nbsp;after&nbsp;the&nbsp;image&nbsp;acquisition&nbsp;worker&nbsp;is&nbsp;executed.<br>
338
:param&nbsp;file_path:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;path&nbsp;to&nbsp;camera&nbsp;description&nbsp;file&nbsp;which&nbsp;you&nbsp;want&nbsp;to&nbsp;load&nbsp;on&nbsp;the&nbsp;target&nbsp;node&nbsp;map&nbsp;instead&nbsp;of&nbsp;the&nbsp;one&nbsp;which&nbsp;the&nbsp;device&nbsp;declares.<br>
339
:param&nbsp;privilege:&nbsp;(Optional)&nbsp;Set&nbsp;an&nbsp;access&nbsp;privilege.&nbsp;`exclusive`,&nbsp;`contorl`,&nbsp;and&nbsp;`read_only`&nbsp;are&nbsp;supported.&nbsp;The&nbsp;default&nbsp;is&nbsp;`exclusive`.<br>
340
&nbsp;<br>
341
:return:&nbsp;An&nbsp;:class:`<a href="#ImageAcquirer">ImageAcquirer</a>`&nbsp;<a href="builtins.html#object">object</a>&nbsp;that&nbsp;associates&nbsp;with&nbsp;the&nbsp;specified&nbsp;device.<br>
342
&nbsp;<br>
343
Note&nbsp;that&nbsp;you&nbsp;have&nbsp;to&nbsp;close&nbsp;it&nbsp;when&nbsp;you&nbsp;are&nbsp;ready&nbsp;to&nbsp;release&nbsp;the<br>
344
device&nbsp;that&nbsp;you&nbsp;have&nbsp;been&nbsp;controlled.&nbsp;As&nbsp;long&nbsp;as&nbsp;you&nbsp;hold&nbsp;it,&nbsp;the<br>
345
controlled&nbsp;device&nbsp;will&nbsp;be&nbsp;not&nbsp;available&nbsp;from&nbsp;other&nbsp;clients.</tt></dd></dl>
346

    
347
<dl><dt><a name="Harvester-remove_cti_file"><strong>remove_cti_file</strong></a>(self, file_path: str)</dt><dd><tt>Removes&nbsp;the&nbsp;specified&nbsp;CTI&nbsp;file&nbsp;from&nbsp;the&nbsp;CTI&nbsp;file&nbsp;list.<br>
348
&nbsp;<br>
349
:param&nbsp;file_path:&nbsp;Set&nbsp;a&nbsp;file&nbsp;path&nbsp;to&nbsp;the&nbsp;target&nbsp;CTI&nbsp;file.<br>
350
&nbsp;<br>
351
:return:&nbsp;None.</tt></dd></dl>
352

    
353
<dl><dt><a name="Harvester-remove_cti_files"><strong>remove_cti_files</strong></a>(self)</dt><dd><tt>Removes&nbsp;all&nbsp;CTI&nbsp;files&nbsp;in&nbsp;the&nbsp;CTI&nbsp;file&nbsp;list.<br>
354
&nbsp;<br>
355
:return:&nbsp;None.</tt></dd></dl>
356

    
357
<dl><dt><a name="Harvester-reset"><strong>reset</strong></a>(self)</dt></dl>
358

    
359
<dl><dt><a name="Harvester-update_device_info_list"><strong>update_device_info_list</strong></a>(self)</dt><dd><tt>Updates&nbsp;the&nbsp;device&nbsp;information&nbsp;list.&nbsp;You'll&nbsp;have&nbsp;to&nbsp;call&nbsp;this&nbsp;method<br>
360
every&nbsp;time&nbsp;you&nbsp;added&nbsp;CTI&nbsp;files&nbsp;or&nbsp;plugged/unplugged&nbsp;devices.<br>
361
&nbsp;<br>
362
:return:&nbsp;None.</tt></dd></dl>
363

    
364
<hr>
365
Data descriptors defined here:<br>
366
<dl><dt><strong>__dict__</strong></dt>
367
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
368
</dl>
369
<dl><dt><strong>__weakref__</strong></dt>
370
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
371
</dl>
372
<dl><dt><strong>cti_files</strong></dt>
373
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;object&nbsp;containing&nbsp;:class:`str`&nbsp;objects.</tt></dd>
374
</dl>
375
<dl><dt><strong>device_info_list</strong></dt>
376
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;object&nbsp;containing&nbsp;:class:`DeviceInfo`&nbsp;objects</tt></dd>
377
</dl>
378
<dl><dt><strong>has_revised_device_info_list</strong></dt>
379
</dl>
380
<dl><dt><strong>timeout_for_update</strong></dt>
381
</dl>
382
</td></tr></table> <p>
383
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
384
<tr bgcolor="#ffc8d8">
385
<td colspan=3 valign=bottom>&nbsp;<br>
386
<font color="#000000" face="helvetica, arial"><a name="ImageAcquirer">class <strong>ImageAcquirer</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
387
    
388
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
389
<td colspan=2><tt><a href="#ImageAcquirer">ImageAcquirer</a>(*,&nbsp;parent=None,&nbsp;device=None,&nbsp;profiler=None,&nbsp;logger=None,&nbsp;sleep_duration=1e-06,&nbsp;file_path=None)<br>
390
&nbsp;<br>
391
Manages&nbsp;everything&nbsp;you&nbsp;need&nbsp;to&nbsp;acquire&nbsp;images&nbsp;from&nbsp;the&nbsp;connecting&nbsp;device.<br>&nbsp;</tt></td></tr>
392
<tr><td>&nbsp;</td>
393
<td width="100%">Methods defined here:<br>
394
<dl><dt><a name="ImageAcquirer-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
395

    
396
<dl><dt><a name="ImageAcquirer-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
397

    
398
<dl><dt><a name="ImageAcquirer-__init__"><strong>__init__</strong></a>(self, *, parent=None, device=None, profiler=None, logger=None, sleep_duration=1e-06, file_path=None)</dt><dd><tt>:param&nbsp;parent:<br>
399
:param&nbsp;device:<br>
400
:param&nbsp;profiler:<br>
401
:param&nbsp;logger:<br>
402
:param&nbsp;sleep_duration:<br>
403
:param&nbsp;file_path:&nbsp;(Optional)&nbsp;Set&nbsp;a&nbsp;path&nbsp;to&nbsp;camera&nbsp;description&nbsp;file&nbsp;which&nbsp;you&nbsp;want&nbsp;to&nbsp;load&nbsp;on&nbsp;the&nbsp;target&nbsp;node&nbsp;map&nbsp;instead&nbsp;of&nbsp;the&nbsp;one&nbsp;which&nbsp;the&nbsp;device&nbsp;declares.</tt></dd></dl>
404

    
405
<dl><dt><a name="ImageAcquirer-destroy"><strong>destroy</strong></a>(self)</dt></dl>
406

    
407
<dl><dt><a name="ImageAcquirer-fetch_buffer"><strong>fetch_buffer</strong></a>(self, *, timeout=0, is_raw=False)</dt><dd><tt>Fetches&nbsp;the&nbsp;latest&nbsp;:class:`<a href="#Buffer">Buffer</a>`&nbsp;<a href="builtins.html#object">object</a>&nbsp;and&nbsp;returns&nbsp;it.<br>
408
&nbsp;<br>
409
:param&nbsp;timeout:&nbsp;Set&nbsp;timeout&nbsp;value&nbsp;in&nbsp;second.<br>
410
:param&nbsp;is_raw:&nbsp;Set&nbsp;:const:`True`&nbsp;if&nbsp;you&nbsp;need&nbsp;a&nbsp;raw&nbsp;GenTL&nbsp;<a href="#Buffer">Buffer</a>&nbsp;module.<br>
411
&nbsp;<br>
412
:return:&nbsp;A&nbsp;:class:`<a href="#Buffer">Buffer</a>`&nbsp;<a href="builtins.html#object">object</a>.</tt></dd></dl>
413

    
414
<dl><dt><a name="ImageAcquirer-start_image_acquisition"><strong>start_image_acquisition</strong></a>(self)</dt><dd><tt>Starts&nbsp;image&nbsp;acquisition.<br>
415
&nbsp;<br>
416
:return:&nbsp;None.</tt></dd></dl>
417

    
418
<dl><dt><a name="ImageAcquirer-stop_image_acquisition"><strong>stop_image_acquisition</strong></a>(self)</dt><dd><tt>Stops&nbsp;image&nbsp;acquisition.<br>
419
&nbsp;<br>
420
:return:&nbsp;None.</tt></dd></dl>
421

    
422
<hr>
423
Data descriptors defined here:<br>
424
<dl><dt><strong>__dict__</strong></dt>
425
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
426
</dl>
427
<dl><dt><strong>__weakref__</strong></dt>
428
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
429
</dl>
430
<dl><dt><strong>device</strong></dt>
431
<dd><tt>:return:&nbsp;The&nbsp;proxy&nbsp;:class:`Device`&nbsp;module&nbsp;object&nbsp;of&nbsp;the&nbsp;connecting&nbsp;remote&nbsp;device.</tt></dd>
432
</dl>
433
<dl><dt><strong>interface</strong></dt>
434
<dd><tt>:return:&nbsp;The&nbsp;parent&nbsp;:class:`Interface`&nbsp;module&nbsp;object&nbsp;of&nbsp;the&nbsp;connecting&nbsp;remote&nbsp;device.</tt></dd>
435
</dl>
436
<dl><dt><strong>is_acquiring_images</strong></dt>
437
<dd><tt>:return:&nbsp;:const:`True`&nbsp;if&nbsp;it's&nbsp;acquiring&nbsp;images.&nbsp;Otherwise&nbsp;:const:`False`.</tt></dd>
438
</dl>
439
<dl><dt><strong>keep_latest</strong></dt>
440
</dl>
441
<dl><dt><strong>min_num_buffers</strong></dt>
442
</dl>
443
<dl><dt><strong>num_buffers</strong></dt>
444
</dl>
445
<dl><dt><strong>num_filled_buffers_to_hold</strong></dt>
446
</dl>
447
<dl><dt><strong>num_holding_filled_buffers</strong></dt>
448
</dl>
449
<dl><dt><strong>on_new_buffer_arrival</strong></dt>
450
</dl>
451
<dl><dt><strong>signal_stop_image_acquisition</strong></dt>
452
</dl>
453
<dl><dt><strong>statistics</strong></dt>
454
</dl>
455
<dl><dt><strong>system</strong></dt>
456
<dd><tt>:return:&nbsp;The&nbsp;parent&nbsp;:class:`System`&nbsp;module&nbsp;object&nbsp;of&nbsp;the&nbsp;connecting&nbsp;remote&nbsp;device.</tt></dd>
457
</dl>
458
<dl><dt><strong>thread_image_acquisition</strong></dt>
459
</dl>
460
<dl><dt><strong>timeout_for_image_acquisition</strong></dt>
461
</dl>
462
</td></tr></table> <p>
463
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
464
<tr bgcolor="#ffc8d8">
465
<td colspan=3 valign=bottom>&nbsp;<br>
466
<font color="#000000" face="helvetica, arial"><a name="MutexLocker">class <strong>MutexLocker</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
467
    
468
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
469
<td colspan=2><tt><a href="#MutexLocker">MutexLocker</a>(thread:&nbsp;harvesters.core.<a href="#ThreadBase">ThreadBase</a>&nbsp;=&nbsp;None)<br>
470
&nbsp;<br>
471
<br>&nbsp;</tt></td></tr>
472
<tr><td>&nbsp;</td>
473
<td width="100%">Methods defined here:<br>
474
<dl><dt><a name="MutexLocker-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
475

    
476
<dl><dt><a name="MutexLocker-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
477

    
478
<dl><dt><a name="MutexLocker-__init__"><strong>__init__</strong></a>(self, thread: harvesters.core.ThreadBase = None)</dt><dd><tt>:param&nbsp;thread:</tt></dd></dl>
479

    
480
<hr>
481
Data descriptors defined here:<br>
482
<dl><dt><strong>__dict__</strong></dt>
483
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
484
</dl>
485
<dl><dt><strong>__weakref__</strong></dt>
486
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
487
</dl>
488
</td></tr></table> <p>
489
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
490
<tr bgcolor="#ffc8d8">
491
<td colspan=3 valign=bottom>&nbsp;<br>
492
<font color="#000000" face="helvetica, arial"><a name="PayloadBase">class <strong>PayloadBase</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
493
    
494
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
495
<td colspan=2><tt><a href="#PayloadBase">PayloadBase</a>(*,&nbsp;buffer=None,&nbsp;logger=None)<br>
496
&nbsp;<br>
497
Is&nbsp;a&nbsp;base&nbsp;class&nbsp;of&nbsp;various&nbsp;payload&nbsp;types.&nbsp;The&nbsp;types&nbsp;are&nbsp;defined&nbsp;by&nbsp;the<br>
498
GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
499
<tr><td>&nbsp;</td>
500
<td width="100%">Methods defined here:<br>
501
<dl><dt><a name="PayloadBase-__init__"><strong>__init__</strong></a>(self, *, buffer=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
502
:param&nbsp;logger:</tt></dd></dl>
503

    
504
<hr>
505
Data descriptors defined here:<br>
506
<dl><dt><strong>__dict__</strong></dt>
507
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
508
</dl>
509
<dl><dt><strong>__weakref__</strong></dt>
510
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
511
</dl>
512
<dl><dt><strong>components</strong></dt>
513
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
514
</dl>
515
<dl><dt><strong>payload_type</strong></dt>
516
<dd><tt>TODO:<br>
517
:return:</tt></dd>
518
</dl>
519
</td></tr></table> <p>
520
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
521
<tr bgcolor="#ffc8d8">
522
<td colspan=3 valign=bottom>&nbsp;<br>
523
<font color="#000000" face="helvetica, arial"><a name="PayloadChunkOnly">class <strong>PayloadChunkOnly</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
524
    
525
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
526
<td colspan=2><tt><a href="#PayloadChunkOnly">PayloadChunkOnly</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
527
&nbsp;<br>
528
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as<br>
529
:const:`PAYLOAD_TYPE_CHUNK_ONLY`&nbsp;by&nbsp;the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
530
<tr><td>&nbsp;</td>
531
<td width="100%"><dl><dt>Method resolution order:</dt>
532
<dd><a href="harvesters.core.html#PayloadChunkOnly">PayloadChunkOnly</a></dd>
533
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
534
<dd><a href="builtins.html#object">builtins.object</a></dd>
535
</dl>
536
<hr>
537
Methods defined here:<br>
538
<dl><dt><a name="PayloadChunkOnly-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
539
:param&nbsp;logger:</tt></dd></dl>
540

    
541
<hr>
542
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
543
<dl><dt><strong>__dict__</strong></dt>
544
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
545
</dl>
546
<dl><dt><strong>__weakref__</strong></dt>
547
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
548
</dl>
549
<dl><dt><strong>components</strong></dt>
550
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
551
</dl>
552
<dl><dt><strong>payload_type</strong></dt>
553
<dd><tt>TODO:<br>
554
:return:</tt></dd>
555
</dl>
556
</td></tr></table> <p>
557
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
558
<tr bgcolor="#ffc8d8">
559
<td colspan=3 valign=bottom>&nbsp;<br>
560
<font color="#000000" face="helvetica, arial"><a name="PayloadFile">class <strong>PayloadFile</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
561
    
562
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
563
<td colspan=2><tt><a href="#PayloadFile">PayloadFile</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
564
&nbsp;<br>
565
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as&nbsp;:const:`PAYLOAD_TYPE_FILE`&nbsp;by<br>
566
the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
567
<tr><td>&nbsp;</td>
568
<td width="100%"><dl><dt>Method resolution order:</dt>
569
<dd><a href="harvesters.core.html#PayloadFile">PayloadFile</a></dd>
570
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
571
<dd><a href="builtins.html#object">builtins.object</a></dd>
572
</dl>
573
<hr>
574
Methods defined here:<br>
575
<dl><dt><a name="PayloadFile-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
576
:param&nbsp;node_map:<br>
577
:param&nbsp;logger:</tt></dd></dl>
578

    
579
<hr>
580
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
581
<dl><dt><strong>__dict__</strong></dt>
582
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
583
</dl>
584
<dl><dt><strong>__weakref__</strong></dt>
585
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
586
</dl>
587
<dl><dt><strong>components</strong></dt>
588
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
589
</dl>
590
<dl><dt><strong>payload_type</strong></dt>
591
<dd><tt>TODO:<br>
592
:return:</tt></dd>
593
</dl>
594
</td></tr></table> <p>
595
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
596
<tr bgcolor="#ffc8d8">
597
<td colspan=3 valign=bottom>&nbsp;<br>
598
<font color="#000000" face="helvetica, arial"><a name="PayloadH264">class <strong>PayloadH264</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
599
    
600
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
601
<td colspan=2><tt><a href="#PayloadH264">PayloadH264</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
602
&nbsp;<br>
603
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as&nbsp;:const:`PAYLOAD_TYPE_H264`&nbsp;by<br>
604
the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
605
<tr><td>&nbsp;</td>
606
<td width="100%"><dl><dt>Method resolution order:</dt>
607
<dd><a href="harvesters.core.html#PayloadH264">PayloadH264</a></dd>
608
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
609
<dd><a href="builtins.html#object">builtins.object</a></dd>
610
</dl>
611
<hr>
612
Methods defined here:<br>
613
<dl><dt><a name="PayloadH264-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
614
:param&nbsp;node_map:<br>
615
:param&nbsp;logger:</tt></dd></dl>
616

    
617
<hr>
618
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
619
<dl><dt><strong>__dict__</strong></dt>
620
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
621
</dl>
622
<dl><dt><strong>__weakref__</strong></dt>
623
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
624
</dl>
625
<dl><dt><strong>components</strong></dt>
626
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
627
</dl>
628
<dl><dt><strong>payload_type</strong></dt>
629
<dd><tt>TODO:<br>
630
:return:</tt></dd>
631
</dl>
632
</td></tr></table> <p>
633
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
634
<tr bgcolor="#ffc8d8">
635
<td colspan=3 valign=bottom>&nbsp;<br>
636
<font color="#000000" face="helvetica, arial"><a name="PayloadImage">class <strong>PayloadImage</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
637
    
638
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
639
<td colspan=2><tt><a href="#PayloadImage">PayloadImage</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
640
&nbsp;<br>
641
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as&nbsp;:const:`PAYLOAD_TYPE_IMAGE`&nbsp;by<br>
642
the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
643
<tr><td>&nbsp;</td>
644
<td width="100%"><dl><dt>Method resolution order:</dt>
645
<dd><a href="harvesters.core.html#PayloadImage">PayloadImage</a></dd>
646
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
647
<dd><a href="builtins.html#object">builtins.object</a></dd>
648
</dl>
649
<hr>
650
Methods defined here:<br>
651
<dl><dt><a name="PayloadImage-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
652
:param&nbsp;node_map:<br>
653
:param&nbsp;logger:</tt></dd></dl>
654

    
655
<dl><dt><a name="PayloadImage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>
656

    
657
<hr>
658
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
659
<dl><dt><strong>__dict__</strong></dt>
660
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
661
</dl>
662
<dl><dt><strong>__weakref__</strong></dt>
663
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
664
</dl>
665
<dl><dt><strong>components</strong></dt>
666
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
667
</dl>
668
<dl><dt><strong>payload_type</strong></dt>
669
<dd><tt>TODO:<br>
670
:return:</tt></dd>
671
</dl>
672
</td></tr></table> <p>
673
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
674
<tr bgcolor="#ffc8d8">
675
<td colspan=3 valign=bottom>&nbsp;<br>
676
<font color="#000000" face="helvetica, arial"><a name="PayloadJPEG">class <strong>PayloadJPEG</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
677
    
678
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
679
<td colspan=2><tt><a href="#PayloadJPEG">PayloadJPEG</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
680
&nbsp;<br>
681
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as&nbsp;:const:`PAYLOAD_TYPE_JPEG`&nbsp;by<br>
682
the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
683
<tr><td>&nbsp;</td>
684
<td width="100%"><dl><dt>Method resolution order:</dt>
685
<dd><a href="harvesters.core.html#PayloadJPEG">PayloadJPEG</a></dd>
686
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
687
<dd><a href="builtins.html#object">builtins.object</a></dd>
688
</dl>
689
<hr>
690
Methods defined here:<br>
691
<dl><dt><a name="PayloadJPEG-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
692
:param&nbsp;node_map:<br>
693
:param&nbsp;logger:</tt></dd></dl>
694

    
695
<hr>
696
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
697
<dl><dt><strong>__dict__</strong></dt>
698
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
699
</dl>
700
<dl><dt><strong>__weakref__</strong></dt>
701
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
702
</dl>
703
<dl><dt><strong>components</strong></dt>
704
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
705
</dl>
706
<dl><dt><strong>payload_type</strong></dt>
707
<dd><tt>TODO:<br>
708
:return:</tt></dd>
709
</dl>
710
</td></tr></table> <p>
711
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
712
<tr bgcolor="#ffc8d8">
713
<td colspan=3 valign=bottom>&nbsp;<br>
714
<font color="#000000" face="helvetica, arial"><a name="PayloadJPEG2000">class <strong>PayloadJPEG2000</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
715
    
716
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
717
<td colspan=2><tt><a href="#PayloadJPEG2000">PayloadJPEG2000</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
718
&nbsp;<br>
719
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as&nbsp;:const:`PAYLOAD_TYPE_JPEG2000`<br>
720
by&nbsp;the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
721
<tr><td>&nbsp;</td>
722
<td width="100%"><dl><dt>Method resolution order:</dt>
723
<dd><a href="harvesters.core.html#PayloadJPEG2000">PayloadJPEG2000</a></dd>
724
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
725
<dd><a href="builtins.html#object">builtins.object</a></dd>
726
</dl>
727
<hr>
728
Methods defined here:<br>
729
<dl><dt><a name="PayloadJPEG2000-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
730
:param&nbsp;node_map:<br>
731
:param&nbsp;logger:</tt></dd></dl>
732

    
733
<hr>
734
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
735
<dl><dt><strong>__dict__</strong></dt>
736
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
737
</dl>
738
<dl><dt><strong>__weakref__</strong></dt>
739
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
740
</dl>
741
<dl><dt><strong>components</strong></dt>
742
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
743
</dl>
744
<dl><dt><strong>payload_type</strong></dt>
745
<dd><tt>TODO:<br>
746
:return:</tt></dd>
747
</dl>
748
</td></tr></table> <p>
749
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
750
<tr bgcolor="#ffc8d8">
751
<td colspan=3 valign=bottom>&nbsp;<br>
752
<font color="#000000" face="helvetica, arial"><a name="PayloadMultiPart">class <strong>PayloadMultiPart</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
753
    
754
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
755
<td colspan=2><tt><a href="#PayloadMultiPart">PayloadMultiPart</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
756
&nbsp;<br>
757
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as<br>
758
:const:`PAYLOAD_TYPE_MULTI_PART`&nbsp;by&nbsp;the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
759
<tr><td>&nbsp;</td>
760
<td width="100%"><dl><dt>Method resolution order:</dt>
761
<dd><a href="harvesters.core.html#PayloadMultiPart">PayloadMultiPart</a></dd>
762
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
763
<dd><a href="builtins.html#object">builtins.object</a></dd>
764
</dl>
765
<hr>
766
Methods defined here:<br>
767
<dl><dt><a name="PayloadMultiPart-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
768
:param&nbsp;node_map:<br>
769
:param&nbsp;logger:</tt></dd></dl>
770

    
771
<dl><dt><a name="PayloadMultiPart-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>
772

    
773
<hr>
774
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
775
<dl><dt><strong>__dict__</strong></dt>
776
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
777
</dl>
778
<dl><dt><strong>__weakref__</strong></dt>
779
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
780
</dl>
781
<dl><dt><strong>components</strong></dt>
782
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
783
</dl>
784
<dl><dt><strong>payload_type</strong></dt>
785
<dd><tt>TODO:<br>
786
:return:</tt></dd>
787
</dl>
788
</td></tr></table> <p>
789
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
790
<tr bgcolor="#ffc8d8">
791
<td colspan=3 valign=bottom>&nbsp;<br>
792
<font color="#000000" face="helvetica, arial"><a name="PayloadRawData">class <strong>PayloadRawData</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
793
    
794
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
795
<td colspan=2><tt><a href="#PayloadRawData">PayloadRawData</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
796
&nbsp;<br>
797
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as&nbsp;:const:`PAYLOAD_TYPE_RAW_DATA`<br>
798
by&nbsp;the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
799
<tr><td>&nbsp;</td>
800
<td width="100%"><dl><dt>Method resolution order:</dt>
801
<dd><a href="harvesters.core.html#PayloadRawData">PayloadRawData</a></dd>
802
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
803
<dd><a href="builtins.html#object">builtins.object</a></dd>
804
</dl>
805
<hr>
806
Methods defined here:<br>
807
<dl><dt><a name="PayloadRawData-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
808
:param&nbsp;node_map:<br>
809
:param&nbsp;logger:</tt></dd></dl>
810

    
811
<hr>
812
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
813
<dl><dt><strong>__dict__</strong></dt>
814
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
815
</dl>
816
<dl><dt><strong>__weakref__</strong></dt>
817
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
818
</dl>
819
<dl><dt><strong>components</strong></dt>
820
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
821
</dl>
822
<dl><dt><strong>payload_type</strong></dt>
823
<dd><tt>TODO:<br>
824
:return:</tt></dd>
825
</dl>
826
</td></tr></table> <p>
827
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
828
<tr bgcolor="#ffc8d8">
829
<td colspan=3 valign=bottom>&nbsp;<br>
830
<font color="#000000" face="helvetica, arial"><a name="PayloadUnknown">class <strong>PayloadUnknown</strong></a>(<a href="harvesters.core.html#PayloadBase">PayloadBase</a>)</font></td></tr>
831
    
832
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
833
<td colspan=2><tt><a href="#PayloadUnknown">PayloadUnknown</a>(*,&nbsp;buffer=None,&nbsp;node_map=None,&nbsp;logger=None)<br>
834
&nbsp;<br>
835
Represents&nbsp;a&nbsp;payload&nbsp;that&nbsp;is&nbsp;classified&nbsp;as&nbsp;:const:`PAYLOAD_TYPE_UNKNOWN`<br>
836
by&nbsp;the&nbsp;GenTL&nbsp;Standard.<br>&nbsp;</tt></td></tr>
837
<tr><td>&nbsp;</td>
838
<td width="100%"><dl><dt>Method resolution order:</dt>
839
<dd><a href="harvesters.core.html#PayloadUnknown">PayloadUnknown</a></dd>
840
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
841
<dd><a href="builtins.html#object">builtins.object</a></dd>
842
</dl>
843
<hr>
844
Methods defined here:<br>
845
<dl><dt><a name="PayloadUnknown-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param&nbsp;buffer:<br>
846
:param&nbsp;node_map:<br>
847
:param&nbsp;logger:</tt></dd></dl>
848

    
849
<hr>
850
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
851
<dl><dt><strong>__dict__</strong></dt>
852
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
853
</dl>
854
<dl><dt><strong>__weakref__</strong></dt>
855
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
856
</dl>
857
<dl><dt><strong>components</strong></dt>
858
<dd><tt>:return:&nbsp;A&nbsp;:class:`list`&nbsp;containing&nbsp;objects&nbsp;that&nbsp;derive&nbsp;from&nbsp;:const:`ComponentBase`&nbsp;class.</tt></dd>
859
</dl>
860
<dl><dt><strong>payload_type</strong></dt>
861
<dd><tt>TODO:<br>
862
:return:</tt></dd>
863
</dl>
864
</td></tr></table> <p>
865
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
866
<tr bgcolor="#ffc8d8">
867
<td colspan=3 valign=bottom>&nbsp;<br>
868
<font color="#000000" face="helvetica, arial"><a name="ThreadBase">class <strong>ThreadBase</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
869
    
870
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
871
<td colspan=2><tt><a href="#ThreadBase">ThreadBase</a>(*,&nbsp;mutex=None,&nbsp;logger=None)<br>
872
&nbsp;<br>
873
By&nbsp;default,&nbsp;:class:`<a href="#ImageAcquirer">ImageAcquirer</a>`&nbsp;class&nbsp;internally&nbsp;uses&nbsp;Python's<br>
874
built-in&nbsp;:mod:`threading`&nbsp;module.&nbsp;However,&nbsp;you&nbsp;may&nbsp;want&nbsp;to&nbsp;use&nbsp;your<br>
875
preferred&nbsp;threading&nbsp;module&nbsp;such&nbsp;as&nbsp;:class:`QThread`&nbsp;of&nbsp;PyQt&nbsp;for&nbsp;some<br>
876
technical&nbsp;reasons.&nbsp;To&nbsp;allow&nbsp;us&nbsp;your&nbsp;preferred&nbsp;threading&nbsp;module,&nbsp;<a href="#Harvester">Harvester</a><br>
877
provides&nbsp;you&nbsp;a&nbsp;base&nbsp;proxy&nbsp;class&nbsp;to&nbsp;allow&nbsp;you&nbsp;implementing&nbsp;your&nbsp;threading<br>
878
functionality.<br>&nbsp;</tt></td></tr>
879
<tr><td>&nbsp;</td>
880
<td width="100%">Methods defined here:<br>
881
<dl><dt><a name="ThreadBase-__init__"><strong>__init__</strong></a>(self, *, mutex=None, logger=None)</dt><dd><tt>:param&nbsp;mutex:<br>
882
:param&nbsp;logger:</tt></dd></dl>
883

    
884
<dl><dt><a name="ThreadBase-acquire"><strong>acquire</strong></a>(self)</dt><dd><tt>This&nbsp;method&nbsp;is&nbsp;abstract&nbsp;and&nbsp;should&nbsp;be&nbsp;reimplemented&nbsp;in&nbsp;any&nbsp;sub-class.<br>
885
&nbsp;<br>
886
Acquires&nbsp;a&nbsp;mutex.<br>
887
&nbsp;<br>
888
:return:&nbsp;None.</tt></dd></dl>
889

    
890
<dl><dt><a name="ThreadBase-release"><strong>release</strong></a>(self)</dt><dd><tt>This&nbsp;method&nbsp;is&nbsp;abstract&nbsp;and&nbsp;should&nbsp;be&nbsp;reimplemented&nbsp;in&nbsp;any&nbsp;sub-class.<br>
891
&nbsp;<br>
892
Releases&nbsp;the&nbsp;acquired&nbsp;mutex.<br>
893
&nbsp;<br>
894
:return:&nbsp;None.</tt></dd></dl>
895

    
896
<dl><dt><a name="ThreadBase-start"><strong>start</strong></a>(self)</dt><dd><tt>:return:&nbsp;None.</tt></dd></dl>
897

    
898
<dl><dt><a name="ThreadBase-stop"><strong>stop</strong></a>(self)</dt><dd><tt>This&nbsp;method&nbsp;is&nbsp;abstract&nbsp;and&nbsp;should&nbsp;be&nbsp;reimplemented&nbsp;in&nbsp;any&nbsp;sub-class.<br>
899
&nbsp;<br>
900
Stops&nbsp;its&nbsp;worker&nbsp;running.<br>
901
&nbsp;<br>
902
:return:&nbsp;None.</tt></dd></dl>
903

    
904
<hr>
905
Data descriptors defined here:<br>
906
<dl><dt><strong>__dict__</strong></dt>
907
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
908
</dl>
909
<dl><dt><strong>__weakref__</strong></dt>
910
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
911
</dl>
912
<dl><dt><strong>id_</strong></dt>
913
<dd><tt>This&nbsp;method&nbsp;is&nbsp;abstract&nbsp;and&nbsp;should&nbsp;be&nbsp;reimplemented&nbsp;in&nbsp;any&nbsp;sub-class.<br>
914
&nbsp;<br>
915
:return:&nbsp;None.</tt></dd>
916
</dl>
917
<dl><dt><strong>is_running</strong></dt>
918
<dd><tt>:return:&nbsp;:const:`True`&nbsp;if&nbsp;the&nbsp;worker&nbsp;is&nbsp;still&nbsp;running.&nbsp;Otherwise&nbsp;:const:`False`.</tt></dd>
919
</dl>
920
<dl><dt><strong>mutex</strong></dt>
921
<dd><tt>This&nbsp;method&nbsp;is&nbsp;abstract&nbsp;and&nbsp;should&nbsp;be&nbsp;reimplemented&nbsp;in&nbsp;any&nbsp;sub-class.<br>
922
&nbsp;<br>
923
:return:&nbsp;None.</tt></dd>
924
</dl>
925
<dl><dt><strong>worker</strong></dt>
926
<dd><tt>This&nbsp;method&nbsp;is&nbsp;abstract&nbsp;and&nbsp;should&nbsp;be&nbsp;reimplemented&nbsp;in&nbsp;any&nbsp;sub-class.<br>
927
&nbsp;<br>
928
:return:&nbsp;None.</tt></dd>
929
</dl>
930
</td></tr></table></td></tr></table><p>
931
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
932
<tr bgcolor="#eeaa77">
933
<td colspan=3 valign=bottom>&nbsp;<br>
934
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
935
    
936
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
937
<td width="100%"><dl><dt><a name="-Lock"><strong>Lock</strong></a> = allocate_lock(...)</dt><dd><tt>allocate_lock()&nbsp;-&gt;&nbsp;lock&nbsp;<a href="builtins.html#object">object</a><br>
938
(allocate()&nbsp;is&nbsp;an&nbsp;obsolete&nbsp;synonym)<br>
939
&nbsp;<br>
940
Create&nbsp;a&nbsp;new&nbsp;lock&nbsp;<a href="builtins.html#object">object</a>.&nbsp;See&nbsp;help(type(threading.<a href="#-Lock">Lock</a>()))&nbsp;for<br>
941
information&nbsp;about&nbsp;locks.</tt></dd></dl>
942
</td></tr></table><p>
943
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
944
<tr bgcolor="#55aa55">
945
<td colspan=3 valign=bottom>&nbsp;<br>
946
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
947
    
948
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
949
<td width="100%"><strong>bayer_location_formats</strong> = ['BayerGR8', 'BayerRG8', 'BayerGB8', 'BayerBG8', 'BayerGR10', 'BayerRG10', 'BayerGB10', 'BayerBG10', 'BayerGR12', 'BayerRG12', 'BayerGB12', 'BayerBG12', 'BayerGR16', 'BayerRG16', 'BayerGB16', 'BayerBG16']<br>
950
<strong>component_2d_formats</strong> = ['Mono8', 'Mono10', 'Mono12', 'Mono14', 'Mono16', 'RGB8', 'RGB10', 'RGB12', 'RGB14', 'RGB16', 'BGR8', 'BGR10', 'BGR12', 'BGR14', 'BGR16', 'RGBa8', 'RGBa10', 'RGBa12', 'RGBa14', 'RGBa16', ...]<br>
951
<strong>float32_formats</strong> = ['Coord3D_A32f', 'Coord3D_B32f', 'Coord3D_C32f', 'Coord3D_ABC32f', 'Coord3D_ABC32f_Planar', 'Coord3D_AC32f', 'Coord3D_AC32f_Planar', 'Confidence32f']<br>
952
<strong>lmn_411_location_formats</strong> = ['YUV411_8_UYYVYY', 'YCbCr411_8_CbYYCrYY', 'YCbCr601_411_8_CbYYCrYY', 'YCbCr709_411_8_CbYYCrYY', 'YCbCr411_8', 'YCbCr2020_411_8_CbYYCrYY']<br>
953
<strong>lmn_422_location_formats</strong> = ['YUV422_8_UYVY', 'YUV422_8', 'YCbCr422_8', 'YCbCr601_422_8', 'YCbCr709_422_8', 'YCbCr422_8_CbYCrY', 'YCbCr601_422_8_CbYCrY', 'YCbCr709_422_8_CbYCrY', 'YCbCr422_10', 'YCbCr422_12', 'YCbCr601_422_10', 'YCbCr601_422_12', 'YCbCr709_422_10', 'YCbCr709_422_12', 'YCbCr422_10_CbYCrY', 'YCbCr422_12_CbYCrY', 'YCbCr601_422_10_CbYCrY', 'YCbCr601_422_12_CbYCrY', 'YCbCr709_422_10_CbYCrY', 'YCbCr709_422_12_CbYCrY', ...]<br>
954
<strong>lmn_444_location_formats</strong> = ['RGB8', 'RGB10', 'RGB12', 'RGB14', 'RGB16', 'BGR8', 'BGR10', 'BGR12', 'BGR14', 'BGR16', 'Coord3D_ABC8', 'Coord3D_ABC8_Planar', 'Coord3D_ABC16', 'Coord3D_ABC16_Planar', 'Coord3D_ABC32f', 'Coord3D_ABC32f_Planar']<br>
955
<strong>lmno_4444_location_formats</strong> = ['RGBa8', 'RGBa10', 'RGBa12', 'RGBa14', 'RGBa16', 'BGRa8', 'BGRa10', 'BGRa12', 'BGRa14', 'BGRa16']<br>
956
<strong>mono_location_formats</strong> = ['Mono8', 'Mono8s', 'Mono10', 'Mono12', 'Mono14', 'Mono16', 'R8', 'R10', 'R12', 'R16', 'G8', 'G10', 'G12', 'G16', 'B8', 'B10', 'B12', 'B16', 'Coord3D_A8', 'Coord3D_B8', ...]<br>
957
<strong>symbolics</strong> = {16842807: 'Mono1p', 16842949: 'Confidence1p', 16908344: 'Mono2p', 17039417: 'Mono4p', 17301505: 'Mono8', 17301506: 'Mono8s', 17301512: 'BayerGR8', 17301513: 'BayerRG8', 17301514: 'BayerGB8', 17301515: 'BayerBG8', ...}<br>
958
<strong>uint16_formats</strong> = ['Mono10', 'Mono12', 'Mono14', 'Mono16', 'RGB10', 'RGB12', 'RGB14', 'RGB16', 'BGR10', 'BGR12', 'BGR14', 'BGR16', 'RGBa10', 'RGBa12', 'RGBa14', 'RGBa16', 'BGRa10', 'BGRa12', 'BGRa14', 'BGRa16', ...]<br>
959
<strong>uint32_formats</strong> = ['Mono32']<br>
960
<strong>uint8_formats</strong> = ['Mono8', 'RGB8', 'RGB8Packed', 'RGBa8', 'BGR8', 'BGRa8', 'BayerGR8', 'BayerGB8', 'BayerRG8', 'BayerBG8', 'Coord3D_A8', 'Coord3D_B8', 'Coord3D_C8', 'Coord3D_ABC8', 'Coord3D_ABC8_Planar', 'Coord3D_AC8', 'Coord3D_AC8_Planar', 'Confidence1', 'Confidence8']</td></tr></table>
961
</body></html>
    (1-1/1)
    Go to top
    Add picture from clipboard (Maximum size: 1 GB)