|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><title>Python: module harvesters.core</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
</head><body bgcolor="#f0f0f8">
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
<tr bgcolor="#7799ee">
|
|
<td valign=bottom> <br>
|
|
<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
|
|
><td align=right valign=bottom
|
|
><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>
|
|
<p><tt># ----------------------------------------------------------------------------<br>
|
|
#<br>
|
|
# Copyright 2018 EMVA<br>
|
|
#<br>
|
|
# Licensed under the Apache License, Version 2.0 (the "License");<br>
|
|
# you may not use this file except in compliance with the License.<br>
|
|
# You may obtain a copy of the License at<br>
|
|
#<br>
|
|
# <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
|
|
#<br>
|
|
# Unless required by applicable law or agreed to in writing, software<br>
|
|
# distributed under the License is distributed on an "AS IS" BASIS,<br>
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
|
|
# See the License for the specific language governing permissions and<br>
|
|
# limitations under the License.<br>
|
|
#<br>
|
|
# ----------------------------------------------------------------------------</tt></p>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#aa55cc">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="io.html">io</a><br>
|
|
<a href="numpy.html">numpy</a><br>
|
|
<a href="os.html">os</a><br>
|
|
</td><td width="25%" valign=top><a href="pathlib.html">pathlib</a><br>
|
|
<a href="signal.html">signal</a><br>
|
|
<a href="sys.html">sys</a><br>
|
|
</td><td width="25%" valign=top><a href="time.html">time</a><br>
|
|
<a href="weakref.html">weakref</a><br>
|
|
<a href="zipfile.html">zipfile</a><br>
|
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ee77aa">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
<td width="100%"><dl>
|
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="harvesters.core.html#Buffer">Buffer</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#ComponentBase">ComponentBase</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="harvesters.core.html#Component2DImage">Component2DImage</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#ComponentUnknown">ComponentUnknown</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
<dt><font face="helvetica, arial"><a href="harvesters.core.html#Harvester">Harvester</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#ImageAcquirer">ImageAcquirer</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#MutexLocker">MutexLocker</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadBase">PayloadBase</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadChunkOnly">PayloadChunkOnly</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadFile">PayloadFile</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadH264">PayloadH264</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadImage">PayloadImage</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadJPEG">PayloadJPEG</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadJPEG2000">PayloadJPEG2000</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadMultiPart">PayloadMultiPart</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadRawData">PayloadRawData</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="harvesters.core.html#PayloadUnknown">PayloadUnknown</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
<dt><font face="helvetica, arial"><a href="harvesters.core.html#ThreadBase">ThreadBase</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
</dl>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#Buffer">Buffer</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Is provided by an :class:`ImageAcquire` <a href="builtins.html#object">object</a> when you call its<br>
|
|
:meth:`~harvesters.core.<a href="#ImageAcquirer">ImageAcquirer</a>.fetch_buffer` method. It provides<br>
|
|
you a way to access acquired data and its relevant information.<br>
|
|
<br>
|
|
Note that it will never be necessary to create this <a href="builtins.html#object">object</a> by yourself<br>
|
|
in general.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Buffer-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="Buffer-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
|
|
|
|
<dl><dt><a name="Buffer-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Buffer-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
|
|
|
|
<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>
|
|
the buffer is queued, the :class:`<a href="#Buffer">Buffer</a>` <a href="builtins.html#object">object</a> will be obsolete.<br>
|
|
You'll have nothing to do with it.<br>
|
|
<br>
|
|
Note that you have to return the ownership of the fetched buffers to<br>
|
|
the :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a> before stopping image acquisition<br>
|
|
calling this method because the :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a> tries<br>
|
|
to clear the self-allocated buffers when it stops image acquisition.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload</strong></dt>
|
|
<dd><tt>:return: A containing object which derives from :class:`PayloadBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>:return: The payload type that the :class:`Buffer` object contains.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>timestamp</strong></dt>
|
|
<dd><tt>:return: The timestamp in the TL specific unit.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>timestamp_frequency</strong></dt>
|
|
<dd><tt>:return: The timestamp frequency which is used to represent a timestamp.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>timestamp_ns</strong></dt>
|
|
<dd><tt>:return: The timestamp in nano-second.</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#Component2DImage">Component2DImage</a>(*, buffer=None, part=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a data component that is classified as<br>
|
|
:const:`PART_DATATYPE_2D_IMAGE` by the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#Component2DImage">Component2DImage</a></dd>
|
|
<dd><a href="harvesters.core.html#ComponentBase">ComponentBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<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>
|
|
:param part:<br>
|
|
:param node_map:</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Component2DImage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
|
|
|
|
<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>
|
|
which is defined by PFNC, of the original image data.<br>
|
|
<br>
|
|
You may use the returned NumPy array for a calculation to map the<br>
|
|
original image to another format.<br>
|
|
<br>
|
|
:return: A NumPy array that represents the 2D pixel location.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>data_format</strong></dt>
|
|
<dd><tt>:return: The data type of the data component as string.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data_format_value</strong></dt>
|
|
<dd><tt>:return: The data type of the data component as integer value.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>delivered_image_height</strong></dt>
|
|
<dd><tt>:return: The image height of the data component.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>height</strong></dt>
|
|
<dd><tt>:return: The height of the data component in the buffer in number of pixels.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>num_components_per_pixel</strong></dt>
|
|
<dd><tt>:return: The number of data components per pixel.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>width</strong></dt>
|
|
<dd><tt>:return: The width of the data component in the buffer in number of pixels.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>x_offset</strong></dt>
|
|
<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>
|
|
</dl>
|
|
<dl><dt><strong>x_padding</strong></dt>
|
|
<dd><tt>Returns<br>
|
|
:return: The X padding of the data component in the buffer in number of pixels.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>y_offset</strong></dt>
|
|
<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>
|
|
</dl>
|
|
<dl><dt><strong>y_padding</strong></dt>
|
|
<dd><tt>:return: The Y padding of the data component in the buffer in number of pixels.</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#ComponentBase">ComponentBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data</strong></dt>
|
|
<dd><tt>:return: The component data.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data_format_namespace</strong></dt>
|
|
<dd><tt>:return: The data type namespace of the data component.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>source_id</strong></dt>
|
|
<dd><tt>:return: The source ID of the data component.</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#ComponentBase">ComponentBase</a>(*, buffer=None)<br>
|
|
<br>
|
|
Is a base class of various data component types.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="ComponentBase-__init__"><strong>__init__</strong></a>(self, *, buffer=None)</dt><dd><tt>:param buffer:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data</strong></dt>
|
|
<dd><tt>:return: The component data.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data_format</strong></dt>
|
|
<dd><tt>:return: The data type of the data component.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data_format_namespace</strong></dt>
|
|
<dd><tt>:return: The data type namespace of the data component.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>source_id</strong></dt>
|
|
<dd><tt>:return: The source ID of the data component.</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Represents a data component that is classified as<br>
|
|
:const:`PART_DATATYPE_UNKNOWN` by the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#ComponentUnknown">ComponentUnknown</a></dd>
|
|
<dd><a href="harvesters.core.html#ComponentBase">ComponentBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="ComponentUnknown-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>:param buffer:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#ComponentBase">ComponentBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data</strong></dt>
|
|
<dd><tt>:return: The component data.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data_format</strong></dt>
|
|
<dd><tt>:return: The data type of the data component.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>data_format_namespace</strong></dt>
|
|
<dd><tt>:return: The data type namespace of the data component.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>source_id</strong></dt>
|
|
<dd><tt>:return: The source ID of the data component.</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#Harvester">Harvester</a>(*, profile=False, logger=None)<br>
|
|
<br>
|
|
Is the class that works for you as <a href="#Harvester">Harvester</a> Core. Everything begins with<br>
|
|
this class.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Harvester-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="Harvester-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
|
|
|
|
<dl><dt><a name="Harvester-__init__"><strong>__init__</strong></a>(self, *, profile=False, logger=None)</dt><dd><tt>:param profile:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<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>
|
|
<br>
|
|
:param file_path: Set a file path to the target CTI file.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<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>
|
|
the created :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a>.<br>
|
|
<br>
|
|
:param list_index: (Optional) Set an item index of the list of :class:`DeviceInfo` objects.<br>
|
|
:param id_: (Optional) Set an index of the device information list.<br>
|
|
:param vendor: (Optional) Set a vendor name of the target device.<br>
|
|
:param model: (Optional) Set a model name of the target device.<br>
|
|
:param tl_type: (Optional) Set a transport layer type of the target device.<br>
|
|
:param user_defined_name: (Optional) Set a user defined name string of the target device.<br>
|
|
:param serial_number: (Optional) Set a serial number string of the target device.<br>
|
|
:param version: (Optional) Set a version number string of the target device.<br>
|
|
:param sleep_duration: (Optional) Set a sleep duration in second that is inserted after the image acquisition worker is executed.<br>
|
|
: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>
|
|
:param privilege: (Optional) Set an access privilege. `exclusive`, `contorl`, and `read_only` are supported. The default is `exclusive`.<br>
|
|
<br>
|
|
:return: An :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` <a href="builtins.html#object">object</a> that associates with the specified device.<br>
|
|
<br>
|
|
Note that you have to close it when you are ready to release the<br>
|
|
device that you have been controlled. As long as you hold it, the<br>
|
|
controlled device will be not available from other clients.</tt></dd></dl>
|
|
|
|
<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>
|
|
<br>
|
|
:param file_path: Set a file path to the target CTI file.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<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>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Harvester-reset"><strong>reset</strong></a>(self)</dt></dl>
|
|
|
|
<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>
|
|
every time you added CTI files or plugged/unplugged devices.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>cti_files</strong></dt>
|
|
<dd><tt>:return: A :class:`list` object containing :class:`str` objects.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>device_info_list</strong></dt>
|
|
<dd><tt>:return: A :class:`list` object containing :class:`DeviceInfo` objects</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>has_revised_device_info_list</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>timeout_for_update</strong></dt>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<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>
|
|
<br>
|
|
Manages everything you need to acquire images from the connecting device.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="ImageAcquirer-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="ImageAcquirer-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
|
|
|
|
<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>
|
|
:param device:<br>
|
|
:param profiler:<br>
|
|
:param logger:<br>
|
|
:param sleep_duration:<br>
|
|
: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>
|
|
|
|
<dl><dt><a name="ImageAcquirer-destroy"><strong>destroy</strong></a>(self)</dt></dl>
|
|
|
|
<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>
|
|
<br>
|
|
:param timeout: Set timeout value in second.<br>
|
|
:param is_raw: Set :const:`True` if you need a raw GenTL <a href="#Buffer">Buffer</a> module.<br>
|
|
<br>
|
|
:return: A :class:`<a href="#Buffer">Buffer</a>` <a href="builtins.html#object">object</a>.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="ImageAcquirer-start_image_acquisition"><strong>start_image_acquisition</strong></a>(self)</dt><dd><tt>Starts image acquisition.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="ImageAcquirer-stop_image_acquisition"><strong>stop_image_acquisition</strong></a>(self)</dt><dd><tt>Stops image acquisition.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>device</strong></dt>
|
|
<dd><tt>:return: The proxy :class:`Device` module object of the connecting remote device.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>interface</strong></dt>
|
|
<dd><tt>:return: The parent :class:`Interface` module object of the connecting remote device.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>is_acquiring_images</strong></dt>
|
|
<dd><tt>:return: :const:`True` if it's acquiring images. Otherwise :const:`False`.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>keep_latest</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>min_num_buffers</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>num_buffers</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>num_filled_buffers_to_hold</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>num_holding_filled_buffers</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>on_new_buffer_arrival</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>signal_stop_image_acquisition</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>statistics</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>system</strong></dt>
|
|
<dd><tt>:return: The parent :class:`System` module object of the connecting remote device.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>thread_image_acquisition</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>timeout_for_image_acquisition</strong></dt>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#MutexLocker">MutexLocker</a>(thread: harvesters.core.<a href="#ThreadBase">ThreadBase</a> = None)<br>
|
|
<br>
|
|
<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="MutexLocker-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="MutexLocker-__exit__"><strong>__exit__</strong></a>(self, exc_type, exc_val, exc_tb)</dt></dl>
|
|
|
|
<dl><dt><a name="MutexLocker-__init__"><strong>__init__</strong></a>(self, thread: harvesters.core.ThreadBase = None)</dt><dd><tt>:param thread:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadBase">PayloadBase</a>(*, buffer=None, logger=None)<br>
|
|
<br>
|
|
Is a base class of various payload types. The types are defined by the<br>
|
|
GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="PayloadBase-__init__"><strong>__init__</strong></a>(self, *, buffer=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadChunkOnly">PayloadChunkOnly</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as<br>
|
|
:const:`PAYLOAD_TYPE_CHUNK_ONLY` by the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadChunkOnly">PayloadChunkOnly</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadChunkOnly-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadFile">PayloadFile</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_FILE` by<br>
|
|
the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadFile">PayloadFile</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadFile-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadH264">PayloadH264</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_H264` by<br>
|
|
the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadH264">PayloadH264</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadH264-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadImage">PayloadImage</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_IMAGE` by<br>
|
|
the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadImage">PayloadImage</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadImage-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<dl><dt><a name="PayloadImage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadJPEG">PayloadJPEG</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_JPEG` by<br>
|
|
the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadJPEG">PayloadJPEG</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadJPEG-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadJPEG2000">PayloadJPEG2000</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_JPEG2000`<br>
|
|
by the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadJPEG2000">PayloadJPEG2000</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadJPEG2000-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadMultiPart">PayloadMultiPart</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as<br>
|
|
:const:`PAYLOAD_TYPE_MULTI_PART` by the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadMultiPart">PayloadMultiPart</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadMultiPart-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<dl><dt><a name="PayloadMultiPart-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadRawData">PayloadRawData</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_RAW_DATA`<br>
|
|
by the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadRawData">PayloadRawData</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadRawData-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#PayloadUnknown">PayloadUnknown</a>(*, buffer=None, node_map=None, logger=None)<br>
|
|
<br>
|
|
Represents a payload that is classified as :const:`PAYLOAD_TYPE_UNKNOWN`<br>
|
|
by the GenTL Standard.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="harvesters.core.html#PayloadUnknown">PayloadUnknown</a></dd>
|
|
<dd><a href="harvesters.core.html#PayloadBase">PayloadBase</a></dd>
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="PayloadUnknown-__init__"><strong>__init__</strong></a>(self, *, buffer=None, node_map=None, logger=None)</dt><dd><tt>:param buffer:<br>
|
|
:param node_map:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="harvesters.core.html#PayloadBase">PayloadBase</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>components</strong></dt>
|
|
<dd><tt>:return: A :class:`list` containing objects that derive from :const:`ComponentBase` class.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>payload_type</strong></dt>
|
|
<dd><tt>TODO:<br>
|
|
:return:</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#ThreadBase">ThreadBase</a>(*, mutex=None, logger=None)<br>
|
|
<br>
|
|
By default, :class:`<a href="#ImageAcquirer">ImageAcquirer</a>` class internally uses Python's<br>
|
|
built-in :mod:`threading` module. However, you may want to use your<br>
|
|
preferred threading module such as :class:`QThread` of PyQt for some<br>
|
|
technical reasons. To allow us your preferred threading module, <a href="#Harvester">Harvester</a><br>
|
|
provides you a base proxy class to allow you implementing your threading<br>
|
|
functionality.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="ThreadBase-__init__"><strong>__init__</strong></a>(self, *, mutex=None, logger=None)</dt><dd><tt>:param mutex:<br>
|
|
:param logger:</tt></dd></dl>
|
|
|
|
<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>
|
|
<br>
|
|
Acquires a mutex.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<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>
|
|
<br>
|
|
Releases the acquired mutex.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="ThreadBase-start"><strong>start</strong></a>(self)</dt><dd><tt>:return: None.</tt></dd></dl>
|
|
|
|
<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>
|
|
<br>
|
|
Stops its worker running.<br>
|
|
<br>
|
|
:return: None.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>id_</strong></dt>
|
|
<dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
|
<br>
|
|
:return: None.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>is_running</strong></dt>
|
|
<dd><tt>:return: :const:`True` if the worker is still running. Otherwise :const:`False`.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>mutex</strong></dt>
|
|
<dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
|
<br>
|
|
:return: None.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>worker</strong></dt>
|
|
<dd><tt>This method is abstract and should be reimplemented in any sub-class.<br>
|
|
<br>
|
|
:return: None.</tt></dd>
|
|
</dl>
|
|
</td></tr></table></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#eeaa77">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
|
<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>
|
|
(allocate() is an obsolete synonym)<br>
|
|
<br>
|
|
Create a new lock <a href="builtins.html#object">object</a>. See help(type(threading.<a href="#-Lock">Lock</a>())) for<br>
|
|
information about locks.</tt></dd></dl>
|
|
</td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#55aa55">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
|
<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>
|
|
<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>
|
|
<strong>float32_formats</strong> = ['Coord3D_A32f', 'Coord3D_B32f', 'Coord3D_C32f', 'Coord3D_ABC32f', 'Coord3D_ABC32f_Planar', 'Coord3D_AC32f', 'Coord3D_AC32f_Planar', 'Confidence32f']<br>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<strong>lmno_4444_location_formats</strong> = ['RGBa8', 'RGBa10', 'RGBa12', 'RGBa14', 'RGBa16', 'BGRa8', 'BGRa10', 'BGRa12', 'BGRa14', 'BGRa16']<br>
|
|
<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>
|
|
<strong>symbolics</strong> = {16842807: 'Mono1p', 16842949: 'Confidence1p', 16908344: 'Mono2p', 17039417: 'Mono4p', 17301505: 'Mono8', 17301506: 'Mono8s', 17301512: 'BayerGR8', 17301513: 'BayerRG8', 17301514: 'BayerGB8', 17301515: 'BayerBG8', ...}<br>
|
|
<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>
|
|
<strong>uint32_formats</strong> = ['Mono32']<br>
|
|
<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>
|
|
</body></html>
|