HALCON 24.11.1.0 / HALCON Operator Reference / Image / Acquisition
ClassesClasses | | Operators

info_framegrabberT_info_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber (Operator)

Name

info_framegrabberT_info_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber — Query information about the specified image acquisition interface.

Signature

info_framegrabber( : : Name, Query : Information, ValueList)

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

void InfoFramegrabber(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 void HOperatorSet.InfoFramegrabber(HTuple name, HTuple query, out HTuple information, out HTuple valueList)

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

def info_framegrabber(name: str, query: str) -> Tuple[str, Sequence[Union[str, int, float]]]

Description

The operator info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber returns information about the image acquisition device NameNameNamenamename. The desired information is specified via QueryQueryQueryqueryquery. A textual description according to the selected topic is returned in InformationInformationInformationinformationinformation. If applicable, ValueListValueListValueListvalueListvalue_list contains a list of supported values. Up to now, the following queries are possible:

'bits_per_channel'"bits_per_channel""bits_per_channel""bits_per_channel""bits_per_channel":

List of all supported values for the parameter BitsPerChannelBitsPerChannelBitsPerChannelbitsPerChannelbits_per_channel, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'camera_type'"camera_type""camera_type""camera_type""camera_type":

Description and list of all supported values for the parameter CameraTypeCameraTypeCameraTypecameraTypecamera_type, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'color_space'"color_space""color_space""color_space""color_space":

List of all supported values for the parameter ColorSpaceColorSpaceColorSpacecolorSpacecolor_space, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'defaults'"defaults""defaults""defaults""defaults":

Interface-specific default values in ValueListValueListValueListvalueListvalue_list, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'device'"device""device""device""device":

List of all supported values for the parameter DeviceDeviceDevicedevicedevice, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'external_trigger'"external_trigger""external_trigger""external_trigger""external_trigger":

List of all supported values for the parameter ExternalTriggerExternalTriggerExternalTriggerexternalTriggerexternal_trigger, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'field'"field""field""field""field":

List of all supported values for the parameter FieldFieldFieldfieldfield, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'general'"general""general""general""general":

General information (in InformationInformationInformationinformationinformation).

'generic'"generic""generic""generic""generic":

Generic value with device-specific meaning, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'horizontal_resolution'"horizontal_resolution""horizontal_resolution""horizontal_resolution""horizontal_resolution":

List of all supported values for the parameter HorizontalResolutionHorizontalResolutionHorizontalResolutionhorizontalResolutionhorizontal_resolution, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'image_height'"image_height""image_height""image_height""image_height":

List of all supported values for the parameter ImageHeightImageHeightImageHeightimageHeightimage_height, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'image_width'"image_width""image_width""image_width""image_width":

List of all supported values for the parameter ImageWidthImageWidthImageWidthimageWidthimage_width, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'info_boards'"info_boards""info_boards""info_boards""info_boards":

Information about actually installed boards or cameras. This data is especially useful for the auto-detect mechanism of the Image Acquisition Assistant in HDevelop.

'line_in'"line_in""line_in""line_in""line_in":

List of all supported values for the parameter LineInLineInLineInlineInline_in, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'parameters'"parameters""parameters""parameters""parameters":

List of all interface-specific parameters which are accessible via set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamset_framegrabber_param or get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_param.

'parameters_readonly'"parameters_readonly""parameters_readonly""parameters_readonly""parameters_readonly":

List of all interface-specific parameters which are only accessible via get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_param.

'parameters_writeonly'"parameters_writeonly""parameters_writeonly""parameters_writeonly""parameters_writeonly":

List of all interface-specific parameters which are only accessible via set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamset_framegrabber_param.

'port'"port""port""port""port":

List of all supported values for the parameter PortPortPortportport, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'revision'"revision""revision""revision""revision":

Version number of the image acquisition interface.

'start_column'"start_column""start_column""start_column""start_column":

List of all supported values for the parameter StartColumnStartColumnStartColumnstartColumnstart_column, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'start_row'"start_row""start_row""start_row""start_row":

List of all supported values for the parameter StartRowStartRowStartRowstartRowstart_row, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'vertical_resolution'"vertical_resolution""vertical_resolution""vertical_resolution""vertical_resolution":

List of all supported values for the parameter VerticalResolutionVerticalResolutionVerticalResolutionverticalResolutionvertical_resolution, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

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

Attention

For a multithreaded application, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, and close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber 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

Parameters

NameNameNamenamename (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

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

Default: 'File' "File" "File" "File" "File"

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

QueryQueryQueryqueryquery (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the chosen query.

Default: 'info_boards' "info_boards" "info_boards" "info_boards" "info_boards"

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

InformationInformationInformationinformationinformation (output_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Textual information (according to QueryQueryQueryqueryquery).

ValueListValueListValueListvalueListvalue_list (output_control)  string-array → HTupleSequence[Union[str, int, float]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

List of values (according to QueryQueryQueryqueryquery).

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_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber

Possible Successors

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber

See also

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 24.11.1.0 Copyright © 1996-2024 MVTec Software GmbH