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> <br>
|
9
|
<font color="#ffffff" face="helvetica, arial"> <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># ----------------------------------------------------------------------------<br>
|
13
|
#<br>
|
14
|
# Copyright 2018 EMVA<br>
|
15
|
#<br>
|
16
|
# Licensed under the Apache License, Version 2.0 (the "License");<br>
|
17
|
# you may not use this file except in compliance with the License.<br>
|
18
|
# You may obtain a copy of the License at<br>
|
19
|
#<br>
|
20
|
# <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
|
21
|
#<br>
|
22
|
# Unless required by applicable law or agreed to in writing, software<br>
|
23
|
# distributed under the License is distributed on an "AS IS" BASIS,<br>
|
24
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
|
25
|
# See the License for the specific language governing permissions and<br>
|
26
|
# limitations under the License.<br>
|
27
|
#<br>
|
28
|
# ----------------------------------------------------------------------------</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> <br>
|
33
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
34
|
|
35
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </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> <br>
|
49
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
50
|
|
51
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </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> <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> </tt></td>
|
92
|
<td colspan=2><tt><a href="#Buffer">Buffer</a>(*, buffer=None, node_map=None, logger=None)<br>
|
93
|
<br>
|
94
|
Is provided by an :class:`ImageAcquire` <a href="builtins.html#object">object</a> when you call its<br>
|
95
|
:meth:`~harvesters.core.<a href="#ImageAcquirer">ImageAcquirer</a>.fetch_buffer` method. It provides<br>
|
96
|
you a way to access acquired data and its relevant information.<br>
|
97
|
<br>
|
98
|
Note that it will never be necessary to create this <a href="builtins.html#object">object</a> by yourself<br>
|
99
|
in general.<br> </tt></td></tr>
|
100
|
<tr><td> </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 buffer:<br>
|
107
|
:param node_map:<br>
|
108
|
:param logger:</tt></dd></dl>
|
109
|
|
110
|
<dl><dt><a name="Buffer-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
|
111
|
|
112
|
<dl><dt><a name="Buffer-queue"><strong>queue</strong></a>(self)</dt><dd><tt>Queues the buffer to prepare for the upcoming image acquisition. Once<br>
|
113
|
the buffer is queued, the :class:`<a href="#Buffer">Buffer</a>` <a href="builtins.html#object">object</a> will be obsolete.<br>
|
114
|
You'll have nothing to do with it.<br>
|
115
|
<br>
|
116
|
Note that you have to return the ownership of the fetched buffers to<br>
|
117
|
the :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a> before stopping image acquisition<br>
|
118
|
calling this method because the :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a> tries<br>
|
119
|
to clear the self-allocated buffers when it stops image acquisition.</tt></dd></dl>
|
120
|
|
121
|
<hr>
|
122
|
Data descriptors defined here:<br>
|
123
|
<dl><dt><strong>__dict__</strong></dt>
|
124
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
125
|
</dl>
|
126
|
<dl><dt><strong>__weakref__</strong></dt>
|
127
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
128
|
</dl>
|
129
|
<dl><dt><strong>payload</strong></dt>
|
130
|
<dd><tt>:return: A containing object which derives from :class:`PayloadBase` class.</tt></dd>
|
131
|
</dl>
|
132
|
<dl><dt><strong>payload_type</strong></dt>
|
133
|
<dd><tt>:return: The payload type that the :class:`Buffer` object contains.</tt></dd>
|
134
|
</dl>
|
135
|
<dl><dt><strong>timestamp</strong></dt>
|
136
|
<dd><tt>:return: The timestamp in the TL specific unit.</tt></dd>
|
137
|
</dl>
|
138
|
<dl><dt><strong>timestamp_frequency</strong></dt>
|
139
|
<dd><tt>:return: The timestamp frequency which is used to represent a timestamp.</tt></dd>
|
140
|
</dl>
|
141
|
<dl><dt><strong>timestamp_ns</strong></dt>
|
142
|
<dd><tt>:return: The timestamp in 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> <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> </tt></td>
|
151
|
<td colspan=2><tt><a href="#Component2DImage">Component2DImage</a>(*, buffer=None, part=None, node_map=None, logger=None)<br>
|
152
|
<br>
|
153
|
Represents a data component that is classified as<br>
|
154
|
:const:`PART_DATATYPE_2D_IMAGE` by the GenTL Standard.<br> </tt></td></tr>
|
155
|
<tr><td> </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 buffer:<br>
|
164
|
:param part:<br>
|
165
|
:param node_map:</tt></dd></dl>
|
166
|
|
167
|
<dl><dt><a name="Component2DImage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return 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 a NumPy array that represents the 2D pixel location,<br>
|
170
|
which is defined by PFNC, of the original image data.<br>
|
171
|
<br>
|
172
|
You may use the returned NumPy array for a calculation to map the<br>
|
173
|
original image to another format.<br>
|
174
|
<br>
|
175
|
:return: A NumPy array that represents the 2D pixel 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: The data type of the data component as string.</tt></dd>
|
181
|
</dl>
|
182
|
<dl><dt><strong>data_format_value</strong></dt>
|
183
|
<dd><tt>:return: The data type of the data component as integer value.</tt></dd>
|
184
|
</dl>
|
185
|
<dl><dt><strong>delivered_image_height</strong></dt>
|
186
|
<dd><tt>:return: The image height of the data component.</tt></dd>
|
187
|
</dl>
|
188
|
<dl><dt><strong>height</strong></dt>
|
189
|
<dd><tt>:return: The height of the data component in the buffer in number of pixels.</tt></dd>
|
190
|
</dl>
|
191
|
<dl><dt><strong>num_components_per_pixel</strong></dt>
|
192
|
<dd><tt>:return: The number of data components per pixel.</tt></dd>
|
193
|
</dl>
|
194
|
<dl><dt><strong>width</strong></dt>
|
195
|
<dd><tt>:return: The width of the data component in the buffer in number of pixels.</tt></dd>
|
196
|
</dl>
|
197
|
<dl><dt><strong>x_offset</strong></dt>
|
198
|
<dd><tt>:return: The X offset of the data in the buffer in number of pixels from the image origin to handle areas of interest.</tt></dd>
|
199
|
</dl>
|
200
|
<dl><dt><strong>x_padding</strong></dt>
|
201
|
<dd><tt>Returns<br>
|
202
|
:return: The X padding of the data component in the buffer in number of pixels.</tt></dd>
|
203
|
</dl>
|
204
|
<dl><dt><strong>y_offset</strong></dt>
|
205
|
<dd><tt>:return: The Y offset of the data in the buffer in number of pixels from the image origin to handle areas of interest.</tt></dd>
|
206
|
</dl>
|
207
|
<dl><dt><strong>y_padding</strong></dt>
|
208
|
<dd><tt>:return: The Y padding of the data component in the buffer in number of 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 for instance variables (if defined)</tt></dd>
|
214
|
</dl>
|
215
|
<dl><dt><strong>__weakref__</strong></dt>
|
216
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
217
|
</dl>
|
218
|
<dl><dt><strong>data</strong></dt>
|
219
|
<dd><tt>:return: The component data.</tt></dd>
|
220
|
</dl>
|
221
|
<dl><dt><strong>data_format_namespace</strong></dt>
|
222
|
<dd><tt>:return: The data type namespace of the data component.</tt></dd>
|
223
|
</dl>
|
224
|
<dl><dt><strong>source_id</strong></dt>
|
225
|
<dd><tt>:return: The source ID of the data 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> <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> </tt></td>
|
234
|
<td colspan=2><tt><a href="#ComponentBase">ComponentBase</a>(*, buffer=None)<br>
|
235
|
<br>
|
236
|
Is a base class of various data component types.<br> </tt></td></tr>
|
237
|
<tr><td> </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 buffer:</tt></dd></dl>
|
240
|
|
241
|
<hr>
|
242
|
Data descriptors defined here:<br>
|
243
|
<dl><dt><strong>__dict__</strong></dt>
|
244
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
245
|
</dl>
|
246
|
<dl><dt><strong>__weakref__</strong></dt>
|
247
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
248
|
</dl>
|
249
|
<dl><dt><strong>data</strong></dt>
|
250
|
<dd><tt>:return: The component data.</tt></dd>
|
251
|
</dl>
|
252
|
<dl><dt><strong>data_format</strong></dt>
|
253
|
<dd><tt>:return: The data type of the data component.</tt></dd>
|
254
|
</dl>
|
255
|
<dl><dt><strong>data_format_namespace</strong></dt>
|
256
|
<dd><tt>:return: The data type namespace of the data component.</tt></dd>
|
257
|
</dl>
|
258
|
<dl><dt><strong>source_id</strong></dt>
|
259
|
<dd><tt>:return: The source ID of the data 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> <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> </tt></td>
|
268
|
<td colspan=2><tt>Represents a data component that is classified as<br>
|
269
|
:const:`PART_DATATYPE_UNKNOWN` by the GenTL Standard.<br> </tt></td></tr>
|
270
|
<tr><td> </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 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 for instance variables (if defined)</tt></dd>
|
284
|
</dl>
|
285
|
<dl><dt><strong>__weakref__</strong></dt>
|
286
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
287
|
</dl>
|
288
|
<dl><dt><strong>data</strong></dt>
|
289
|
<dd><tt>:return: The component data.</tt></dd>
|
290
|
</dl>
|
291
|
<dl><dt><strong>data_format</strong></dt>
|
292
|
<dd><tt>:return: The data type of the data component.</tt></dd>
|
293
|
</dl>
|
294
|
<dl><dt><strong>data_format_namespace</strong></dt>
|
295
|
<dd><tt>:return: The data type namespace of the data component.</tt></dd>
|
296
|
</dl>
|
297
|
<dl><dt><strong>source_id</strong></dt>
|
298
|
<dd><tt>:return: The source ID of the data 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> <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> </tt></td>
|
307
|
<td colspan=2><tt><a href="#Harvester">Harvester</a>(*, profile=False, logger=None)<br>
|
308
|
<br>
|
309
|
Is the class that works for you as <a href="#Harvester">Harvester</a> Core. Everything begins with<br>
|
310
|
this class.<br> </tt></td></tr>
|
311
|
<tr><td> </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 profile:<br>
|
318
|
:param 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 a CTI file to work with to the CTI file list.<br>
|
321
|
<br>
|
322
|
:param file_path: Set a file path to the target CTI file.<br>
|
323
|
<br>
|
324
|
:return: 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 an image acquirer for the specified remote device and return<br>
|
327
|
the created :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a>.<br>
|
328
|
<br>
|
329
|
:param list_index: (Optional) Set an item index of the list of :class:`DeviceInfo` objects.<br>
|
330
|
:param id_: (Optional) Set an index of the device information list.<br>
|
331
|
:param vendor: (Optional) Set a vendor name of the target device.<br>
|
332
|
:param model: (Optional) Set a model name of the target device.<br>
|
333
|
:param tl_type: (Optional) Set a transport layer type of the target device.<br>
|
334
|
:param user_defined_name: (Optional) Set a user defined name string of the target device.<br>
|
335
|
:param serial_number: (Optional) Set a serial number string of the target device.<br>
|
336
|
:param version: (Optional) Set a version number string of the target device.<br>
|
337
|
:param sleep_duration: (Optional) Set a sleep duration in second that is inserted after the image acquisition worker is executed.<br>
|
338
|
:param file_path: (Optional) Set a path to camera description file which you want to load on the target node map instead of the one which the device declares.<br>
|
339
|
:param privilege: (Optional) Set an access privilege. `exclusive`, `contorl`, and `read_only` are supported. The default is `exclusive`.<br>
|
340
|
<br>
|
341
|
:return: An :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a> that associates with the specified device.<br>
|
342
|
<br>
|
343
|
Note that you have to close it when you are ready to release the<br>
|
344
|
device that you have been controlled. As long as you hold it, the<br>
|
345
|
controlled device will be not available from other 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 the specified CTI file from the CTI file list.<br>
|
348
|
<br>
|
349
|
:param file_path: Set a file path to the target CTI file.<br>
|
350
|
<br>
|
351
|
:return: 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 all CTI files in the CTI file list.<br>
|
354
|
<br>
|
355
|
:return: 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 the device information list. You'll have to call this method<br>
|
360
|
every time you added CTI files or plugged/unplugged devices.<br>
|
361
|
<br>
|
362
|
:return: None.</tt></dd></dl>
|
363
|
|
364
|
<hr>
|
365
|
Data descriptors defined here:<br>
|
366
|
<dl><dt><strong>__dict__</strong></dt>
|
367
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
368
|
</dl>
|
369
|
<dl><dt><strong>__weakref__</strong></dt>
|
370
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
371
|
</dl>
|
372
|
<dl><dt><strong>cti_files</strong></dt>
|
373
|
<dd><tt>:return: A :class:`list` object containing :class:`str` objects.</tt></dd>
|
374
|
</dl>
|
375
|
<dl><dt><strong>device_info_list</strong></dt>
|
376
|
<dd><tt>:return: A :class:`list` object containing :class:`DeviceInfo` 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> <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> </tt></td>
|
389
|
<td colspan=2><tt><a href="#ImageAcquirer">ImageAcquirer</a>(*, parent=None, device=None, profiler=None, logger=None, sleep_duration=1e-06, file_path=None)<br>
|
390
|
<br>
|
391
|
Manages everything you need to acquire images from the connecting device.<br> </tt></td></tr>
|
392
|
<tr><td> </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 parent:<br>
|
399
|
:param device:<br>
|
400
|
:param profiler:<br>
|
401
|
:param logger:<br>
|
402
|
:param sleep_duration:<br>
|
403
|
:param file_path: (Optional) Set a path to camera description file which you want to load on the target node map instead of the one which the device 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 the latest :class:`<a href="#Buffer">Buffer</a>` <a href="builtins.html#object">object</a> and returns it.<br>
|
408
|
<br>
|
409
|
:param timeout: Set timeout value in second.<br>
|
410
|
:param is_raw: Set :const:`True` if you need a raw GenTL <a href="#Buffer">Buffer</a> module.<br>
|
411
|
<br>
|
412
|
:return: A :class:`<a href="#Buffer">Buffer</a>` <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 image acquisition.<br>
|
415
|
<br>
|
416
|
:return: 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 image acquisition.<br>
|
419
|
<br>
|
420
|
:return: None.</tt></dd></dl>
|
421
|
|
422
|
<hr>
|
423
|
Data descriptors defined here:<br>
|
424
|
<dl><dt><strong>__dict__</strong></dt>
|
425
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
426
|
</dl>
|
427
|
<dl><dt><strong>__weakref__</strong></dt>
|
428
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
429
|
</dl>
|
430
|
<dl><dt><strong>device</strong></dt>
|
431
|
<dd><tt>:return: The proxy :class:`Device` module object of the connecting remote device.</tt></dd>
|
432
|
</dl>
|
433
|
<dl><dt><strong>interface</strong></dt>
|
434
|
<dd><tt>:return: The parent :class:`Interface` module object of the connecting remote device.</tt></dd>
|
435
|
</dl>
|
436
|
<dl><dt><strong>is_acquiring_images</strong></dt>
|
437
|
<dd><tt>:return: :const:`True` if it's acquiring images. Otherwise :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: The parent :class:`System` module object of the connecting remote 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> <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> </tt></td>
|
469
|
<td colspan=2><tt><a href="#MutexLocker">MutexLocker</a>(thread: harvesters.core.<a href="#ThreadBase">ThreadBase</a> = None)<br>
|
470
|
<br>
|
471
|
<br> </tt></td></tr>
|
472
|
<tr><td> </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 thread:</tt></dd></dl>
|
479
|
|
480
|
<hr>
|
481
|
Data descriptors defined here:<br>
|
482
|
<dl><dt><strong>__dict__</strong></dt>
|
483
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
484
|
</dl>
|
485
|
<dl><dt><strong>__weakref__</strong></dt>
|
486
|
<dd><tt>list of weak references to the object (if 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> <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> </tt></td>
|
495
|
<td colspan=2><tt><a href="#PayloadBase">PayloadBase</a>(*, buffer=None, logger=None)<br>
|
496
|
<br>
|
497
|
Is a base class of various payload types. The types are defined by the<br>
|
498
|
GenTL Standard.<br> </tt></td></tr>
|
499
|
<tr><td> </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 buffer:<br>
|
502
|
:param logger:</tt></dd></dl>
|
503
|
|
504
|
<hr>
|
505
|
Data descriptors defined here:<br>
|
506
|
<dl><dt><strong>__dict__</strong></dt>
|
507
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
508
|
</dl>
|
509
|
<dl><dt><strong>__weakref__</strong></dt>
|
510
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
511
|
</dl>
|
512
|
<dl><dt><strong>components</strong></dt>
|
513
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
526
|
<td colspan=2><tt><a href="#PayloadChunkOnly">PayloadChunkOnly</a>(*, buffer=None, node_map=None, logger=None)<br>
|
527
|
<br>
|
528
|
Represents a payload that is classified as<br>
|
529
|
:const:`PAYLOAD_TYPE_CHUNK_ONLY` by the GenTL Standard.<br> </tt></td></tr>
|
530
|
<tr><td> </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 buffer:<br>
|
539
|
:param 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 for instance variables (if defined)</tt></dd>
|
545
|
</dl>
|
546
|
<dl><dt><strong>__weakref__</strong></dt>
|
547
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
548
|
</dl>
|
549
|
<dl><dt><strong>components</strong></dt>
|
550
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
563
|
<td colspan=2><tt><a href="#PayloadFile">PayloadFile</a>(*, buffer=None, node_map=None, logger=None)<br>
|
564
|
<br>
|
565
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_FILE` by<br>
|
566
|
the GenTL Standard.<br> </tt></td></tr>
|
567
|
<tr><td> </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 buffer:<br>
|
576
|
:param node_map:<br>
|
577
|
:param 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 for instance variables (if defined)</tt></dd>
|
583
|
</dl>
|
584
|
<dl><dt><strong>__weakref__</strong></dt>
|
585
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
586
|
</dl>
|
587
|
<dl><dt><strong>components</strong></dt>
|
588
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
601
|
<td colspan=2><tt><a href="#PayloadH264">PayloadH264</a>(*, buffer=None, node_map=None, logger=None)<br>
|
602
|
<br>
|
603
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_H264` by<br>
|
604
|
the GenTL Standard.<br> </tt></td></tr>
|
605
|
<tr><td> </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 buffer:<br>
|
614
|
:param node_map:<br>
|
615
|
:param 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 for instance variables (if defined)</tt></dd>
|
621
|
</dl>
|
622
|
<dl><dt><strong>__weakref__</strong></dt>
|
623
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
624
|
</dl>
|
625
|
<dl><dt><strong>components</strong></dt>
|
626
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
639
|
<td colspan=2><tt><a href="#PayloadImage">PayloadImage</a>(*, buffer=None, node_map=None, logger=None)<br>
|
640
|
<br>
|
641
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_IMAGE` by<br>
|
642
|
the GenTL Standard.<br> </tt></td></tr>
|
643
|
<tr><td> </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 buffer:<br>
|
652
|
:param node_map:<br>
|
653
|
:param logger:</tt></dd></dl>
|
654
|
|
655
|
<dl><dt><a name="PayloadImage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return 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 for instance variables (if defined)</tt></dd>
|
661
|
</dl>
|
662
|
<dl><dt><strong>__weakref__</strong></dt>
|
663
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
664
|
</dl>
|
665
|
<dl><dt><strong>components</strong></dt>
|
666
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
679
|
<td colspan=2><tt><a href="#PayloadJPEG">PayloadJPEG</a>(*, buffer=None, node_map=None, logger=None)<br>
|
680
|
<br>
|
681
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_JPEG` by<br>
|
682
|
the GenTL Standard.<br> </tt></td></tr>
|
683
|
<tr><td> </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 buffer:<br>
|
692
|
:param node_map:<br>
|
693
|
:param 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 for instance variables (if defined)</tt></dd>
|
699
|
</dl>
|
700
|
<dl><dt><strong>__weakref__</strong></dt>
|
701
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
702
|
</dl>
|
703
|
<dl><dt><strong>components</strong></dt>
|
704
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
717
|
<td colspan=2><tt><a href="#PayloadJPEG2000">PayloadJPEG2000</a>(*, buffer=None, node_map=None, logger=None)<br>
|
718
|
<br>
|
719
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_JPEG2000`<br>
|
720
|
by the GenTL Standard.<br> </tt></td></tr>
|
721
|
<tr><td> </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 buffer:<br>
|
730
|
:param node_map:<br>
|
731
|
:param 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 for instance variables (if defined)</tt></dd>
|
737
|
</dl>
|
738
|
<dl><dt><strong>__weakref__</strong></dt>
|
739
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
740
|
</dl>
|
741
|
<dl><dt><strong>components</strong></dt>
|
742
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
755
|
<td colspan=2><tt><a href="#PayloadMultiPart">PayloadMultiPart</a>(*, buffer=None, node_map=None, logger=None)<br>
|
756
|
<br>
|
757
|
Represents a payload that is classified as<br>
|
758
|
:const:`PAYLOAD_TYPE_MULTI_PART` by the GenTL Standard.<br> </tt></td></tr>
|
759
|
<tr><td> </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 buffer:<br>
|
768
|
:param node_map:<br>
|
769
|
:param logger:</tt></dd></dl>
|
770
|
|
771
|
<dl><dt><a name="PayloadMultiPart-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return 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 for instance variables (if defined)</tt></dd>
|
777
|
</dl>
|
778
|
<dl><dt><strong>__weakref__</strong></dt>
|
779
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
780
|
</dl>
|
781
|
<dl><dt><strong>components</strong></dt>
|
782
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
795
|
<td colspan=2><tt><a href="#PayloadRawData">PayloadRawData</a>(*, buffer=None, node_map=None, logger=None)<br>
|
796
|
<br>
|
797
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_RAW_DATA`<br>
|
798
|
by the GenTL Standard.<br> </tt></td></tr>
|
799
|
<tr><td> </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 buffer:<br>
|
808
|
:param node_map:<br>
|
809
|
:param 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 for instance variables (if defined)</tt></dd>
|
815
|
</dl>
|
816
|
<dl><dt><strong>__weakref__</strong></dt>
|
817
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
818
|
</dl>
|
819
|
<dl><dt><strong>components</strong></dt>
|
820
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
833
|
<td colspan=2><tt><a href="#PayloadUnknown">PayloadUnknown</a>(*, buffer=None, node_map=None, logger=None)<br>
|
834
|
<br>
|
835
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_UNKNOWN`<br>
|
836
|
by the GenTL Standard.<br> </tt></td></tr>
|
837
|
<tr><td> </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 buffer:<br>
|
846
|
:param node_map:<br>
|
847
|
:param 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 for instance variables (if defined)</tt></dd>
|
853
|
</dl>
|
854
|
<dl><dt><strong>__weakref__</strong></dt>
|
855
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
856
|
</dl>
|
857
|
<dl><dt><strong>components</strong></dt>
|
858
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` 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> <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> </tt></td>
|
871
|
<td colspan=2><tt><a href="#ThreadBase">ThreadBase</a>(*, mutex=None, logger=None)<br>
|
872
|
<br>
|
873
|
By default, :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` class internally uses Python's<br>
|
874
|
built-in :mod:`threading` module. However, you may want to use your<br>
|
875
|
preferred threading module such as :class:`QThread` of PyQt for some<br>
|
876
|
technical reasons. To allow us your preferred threading module, <a href="#Harvester">Harvester</a><br>
|
877
|
provides you a base proxy class to allow you implementing your threading<br>
|
878
|
functionality.<br> </tt></td></tr>
|
879
|
<tr><td> </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 mutex:<br>
|
882
|
:param logger:</tt></dd></dl>
|
883
|
|
884
|
<dl><dt><a name="ThreadBase-acquire"><strong>acquire</strong></a>(self)</dt><dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
885
|
<br>
|
886
|
Acquires a mutex.<br>
|
887
|
<br>
|
888
|
:return: None.</tt></dd></dl>
|
889
|
|
890
|
<dl><dt><a name="ThreadBase-release"><strong>release</strong></a>(self)</dt><dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
891
|
<br>
|
892
|
Releases the acquired mutex.<br>
|
893
|
<br>
|
894
|
:return: None.</tt></dd></dl>
|
895
|
|
896
|
<dl><dt><a name="ThreadBase-start"><strong>start</strong></a>(self)</dt><dd><tt>:return: None.</tt></dd></dl>
|
897
|
|
898
|
<dl><dt><a name="ThreadBase-stop"><strong>stop</strong></a>(self)</dt><dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
899
|
<br>
|
900
|
Stops its worker running.<br>
|
901
|
<br>
|
902
|
:return: None.</tt></dd></dl>
|
903
|
|
904
|
<hr>
|
905
|
Data descriptors defined here:<br>
|
906
|
<dl><dt><strong>__dict__</strong></dt>
|
907
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
908
|
</dl>
|
909
|
<dl><dt><strong>__weakref__</strong></dt>
|
910
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
911
|
</dl>
|
912
|
<dl><dt><strong>id_</strong></dt>
|
913
|
<dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
914
|
<br>
|
915
|
:return: None.</tt></dd>
|
916
|
</dl>
|
917
|
<dl><dt><strong>is_running</strong></dt>
|
918
|
<dd><tt>:return: :const:`True` if the worker is still running. Otherwise :const:`False`.</tt></dd>
|
919
|
</dl>
|
920
|
<dl><dt><strong>mutex</strong></dt>
|
921
|
<dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
922
|
<br>
|
923
|
:return: None.</tt></dd>
|
924
|
</dl>
|
925
|
<dl><dt><strong>worker</strong></dt>
|
926
|
<dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
927
|
<br>
|
928
|
:return: 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> <br>
|
934
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
935
|
|
936
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
937
|
<td width="100%"><dl><dt><a name="-Lock"><strong>Lock</strong></a> = allocate_lock(...)</dt><dd><tt>allocate_lock() -> lock <a href="builtins.html#object">object</a><br>
|
938
|
(allocate() is an obsolete synonym)<br>
|
939
|
<br>
|
940
|
Create a new lock <a href="builtins.html#object">object</a>. See help(type(threading.<a href="#-Lock">Lock</a>())) for<br>
|
941
|
information about 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> <br>
|
946
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
947
|
|
948
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </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>
|