Skip to content

info_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabberT_info_framegrabber🔗

Short description🔗

info_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabberT_info_framegrabber — Query information about the specified image acquisition interface.

Signature🔗

info_framegrabber( string Name, string Query, out string Information, out string ValueList )void InfoFramegrabber( const HTuple& Name, const HTuple& Query, HTuple* Information, HTuple* ValueList )static void HOperatorSet.InfoFramegrabber( HTuple name, HTuple query, out HTuple information, out HTuple valueList )def info_framegrabber( name: str, query: str ) -> Tuple[str, Sequence[Union[str, int, float]]]

Herror T_info_framegrabber( const Htuple Name, const Htuple Query, Htuple* Information, Htuple* ValueList )

static HString HInfo::InfoFramegrabber( const HString& Name, const HString& Query, HTuple* ValueList )

static HString HInfo::InfoFramegrabber( const char* Name, const char* Query, HTuple* ValueList )

static HString HInfo::InfoFramegrabber( const wchar_t* Name, const wchar_t* Query, HTuple* ValueList ) (Windows only)

static string HInfo.InfoFramegrabber( string name, string query, out HTuple valueList )

Description🔗

The operator info_framegrabberInfoFramegrabber returns information about the image acquisition device Namenamename. The desired information is specified via Queryqueryquery. A textual description according to the selected topic is returned in Informationinformationinformation. If applicable, ValueListvalueListvalue_list contains a list of supported values. Up to now, the following queries are possible:

Please check also the directory doc/html/reference/acquisition for documentation about specific image grabber interfaces.

Attention🔗

For a multithreaded application, info_framegrabberInfoFramegrabber, open_framegrabberOpenFramegrabber, and close_framegrabberCloseFramegrabber are executed exclusively. Thus, they block the concurrent execution of each other, but run in parallel with all non-exclusive operators outside of this group.

On Windows Systems, error dialog boxes from the operating system can occur when dependency modules of the interface are not found, e.g., the according SDK was not installed. The occurrence of the error boxes can be controlled by setting Windows’ Error Mode. Please refer to the description of SetErrorMode within the Windows MSDN documentation.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

Namenamename (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux).

Default: 'File'"File"
Suggested values: 'ABS', 'ADLINK', 'AlkUSB3', 'Andor', 'BitFlow', 'Crevis', 'DahengCAM', 'DirectFile', 'DirectShow', 'Ensenso-NxLib', 'File', 'FocalSpecLCI', 'GenICamTL', 'GigEVision2', 'GingaDG', 'Ginga++', 'GStreamer', 'heliCamC3', 'KeyenceLJ', 'KeyenceVJ', 'LinX', 'LPS36', 'LuCam', 'MatrixVisionAcquire', 'MediaFoundation', 'Metavision', 'MILLite', 'MultiCam', 'O3D3xx', 'Opteon', 'PhoXi', 'PixeLINK', 'RealSense', 'SaperaLT', 'Sentech', 'SICK-3DCamera', 'SICK-ScanningRuler', 'SiliconSoftware', 'TWAIN', 'uEye', 'USB3Vision', 'Video4Linux2', 'VRmUsbCam'"ABS", "ADLINK", "AlkUSB3", "Andor", "BitFlow", "Crevis", "DahengCAM", "DirectFile", "DirectShow", "Ensenso-NxLib", "File", "FocalSpecLCI", "GenICamTL", "GigEVision2", "GingaDG", "Ginga++", "GStreamer", "heliCamC3", "KeyenceLJ", "KeyenceVJ", "LinX", "LPS36", "LuCam", "MatrixVisionAcquire", "MediaFoundation", "Metavision", "MILLite", "MultiCam", "O3D3xx", "Opteon", "PhoXi", "PixeLINK", "RealSense", "SaperaLT", "Sentech", "SICK-3DCamera", "SICK-ScanningRuler", "SiliconSoftware", "TWAIN", "uEye", "USB3Vision", "Video4Linux2", "VRmUsbCam"

Queryqueryquery (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the chosen query.

Default: 'info_boards'"info_boards"
List of values: 'bits_per_channel', 'camera_type', 'color_space', 'defaults', 'device', 'external_trigger', 'field', 'general', 'generic', 'horizontal_resolution', 'image_height', 'image_width', 'info_boards', 'parameters', 'parameters_readonly', 'parameters_writeonly', 'port', 'revision', 'start_column', 'start_row', 'vertical_resolution'"bits_per_channel", "camera_type", "color_space", "defaults", "device", "external_trigger", "field", "general", "generic", "horizontal_resolution", "image_height", "image_width", "info_boards", "parameters", "parameters_readonly", "parameters_writeonly", "port", "revision", "start_column", "start_row", "vertical_resolution"

Informationinformationinformation (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Textual information (according to Queryqueryquery).

ValueListvalueListvalue_list (output_control) string-array → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)Sequence[Union[str, int, float]]Htuple (char* / Hlong / double)

List of values (according to Queryqueryquery).

Example🔗

(HDevelop)

* Select a suitable image acquisition interface name AcqName
info_framegrabber(AcqName,'port',Information,Values)
* Open image acquisition device using the default settings, see
* documentation of the actually used interface for more details
open_framegrabber(AcqName,1,1,0,0,0,0,'default',-1,'default',-1.0, \
                  'default','default','default',-1,-1,AcqHandle)
grab_image(Image,AcqHandle)
close_framegrabber(AcqHandle)

Result🔗

If the parameter values are correct and the specified image acquisition interface is available, info_framegrabberInfoFramegrabber returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

open_framegrabberOpenFramegrabber

Possible successors

open_framegrabberOpenFramegrabber

See also

open_framegrabberOpenFramegrabber

Module🔗

Foundation