HALCON Website / HALCON Operator Reference / Image / Acquisition
ClassesClassesClassesClasses | | | | Operators

info_framegrabberT_info_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber (Operator)

Name

info_framegrabberT_info_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber — 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)

Herror 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)

void HOperatorSetX.InfoFramegrabber(
[in] VARIANT Name, [in] VARIANT Query, [out] VARIANT* Information, [out] VARIANT* ValueList)

BSTR HInfoX.InfoFramegrabber(
[in] BSTR Name, [in] BSTR Query, [out] VARIANT* ValueList)

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)

Description

The operator info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber returns information about the image acquisition device NameNameNameNameNamename. The desired information is specified via QueryQueryQueryQueryQueryquery. A textual description according to the selected topic is returned in InformationInformationInformationInformationInformationinformation. If applicable, ValueListValueListValueListValueListValueListvalueList contains a list of supported values. Up to now, the following queries are possible:

'bits_per_channel':

List of all supported values for the parameter 'BitsPerChannel', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'camera_type':

Description and list of all supported values for the parameter 'CameraType', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'color_space':

List of all supported values for the parameter 'ColorSpace', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'defaults':

Interface-specific default values in ValueListValueListValueListValueListValueListvalueList, see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'device':

List of all supported values for the parameter 'Device', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'external_trigger':

List of all supported values for the parameter 'ExternalTrigger', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'field':

List of all supported values for the parameter 'Field', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'general':

General information (in InformationInformationInformationInformationInformationinformation).

'generic':

Generic value with device-specific meaning, see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'horizontal_resolution':

List of all supported values for the parameter 'HorizontalResolution', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'image_height':

List of all supported values for the parameter 'ImageHeight', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'image_width':

List of all supported values for the parameter 'ImageWidth', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'info_boards':

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

'line_in':

List of all supported values for the parameter 'LineIn', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'parameters':

List of all interface-specific parameters which are accessible via set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam or get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamget_framegrabber_paramGetFramegrabberParamGetFramegrabberParam.

'parameters_readonly':

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

'parameters_writeonly':

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

'port':

List of all supported values for the parameter 'Port', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'revision':

Version number of the image acquisition interface.

'start_column':

List of all supported values for the parameter 'StartColumn', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'start_row':

List of all supported values for the parameter 'StartRow', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

'vertical_resolution':

List of all supported values for the parameter 'VerticalResolution', see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber.

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

Attention

For a multithreaded application all image acquisition operators (as listed in open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber) are an own group in which info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberclose_framegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbers are executed exclusively.

Thus, info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberclose_framegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbers block the concurrent execution of all other operators within this group, but run in parallel with all non-exclusive operators outside of this group.

Parallelization

Parameters

NameNameNameNameNamename (input_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

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

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

Suggested values: '1394IIDC'"1394IIDC""1394IIDC""1394IIDC""1394IIDC""1394IIDC", '1394IIDC-2'"1394IIDC-2""1394IIDC-2""1394IIDC-2""1394IIDC-2""1394IIDC-2", 'ABS'"ABS""ABS""ABS""ABS""ABS", 'ADLINK'"ADLINK""ADLINK""ADLINK""ADLINK""ADLINK", 'Andor'"Andor""Andor""Andor""Andor""Andor", 'BitFlow'"BitFlow""BitFlow""BitFlow""BitFlow""BitFlow", 'Crevis'"Crevis""Crevis""Crevis""Crevis""Crevis", 'DahengCAM'"DahengCAM""DahengCAM""DahengCAM""DahengCAM""DahengCAM", 'DirectFile'"DirectFile""DirectFile""DirectFile""DirectFile""DirectFile", 'DirectShow'"DirectShow""DirectShow""DirectShow""DirectShow""DirectShow", 'Ensenso-NxLib'"Ensenso-NxLib""Ensenso-NxLib""Ensenso-NxLib""Ensenso-NxLib""Ensenso-NxLib", 'File'"File""File""File""File""File", 'GenICamTL'"GenICamTL""GenICamTL""GenICamTL""GenICamTL""GenICamTL", 'GigEVision'"GigEVision""GigEVision""GigEVision""GigEVision""GigEVision", 'Ginga++'"Ginga++""Ginga++""Ginga++""Ginga++""Ginga++", 'GingaDG'"GingaDG""GingaDG""GingaDG""GingaDG""GingaDG", 'INSPECTA'"INSPECTA""INSPECTA""INSPECTA""INSPECTA""INSPECTA", 'INSPECTA5'"INSPECTA5""INSPECTA5""INSPECTA5""INSPECTA5""INSPECTA5", 'LinX'"LinX""LinX""LinX""LinX""LinX", 'LPS36'"LPS36""LPS36""LPS36""LPS36""LPS36", 'LuCam'"LuCam""LuCam""LuCam""LuCam""LuCam", 'MatrixVisionAcquire'"MatrixVisionAcquire""MatrixVisionAcquire""MatrixVisionAcquire""MatrixVisionAcquire""MatrixVisionAcquire", 'MILLite'"MILLite""MILLite""MILLite""MILLite""MILLite", 'MultiCam'"MultiCam""MultiCam""MultiCam""MultiCam""MultiCam", 'OpenNI'"OpenNI""OpenNI""OpenNI""OpenNI""OpenNI", 'Opteon'"Opteon""Opteon""Opteon""Opteon""Opteon", 'p3i2'"p3i2""p3i2""p3i2""p3i2""p3i2", 'PcEyeCL'"PcEyeCL""PcEyeCL""PcEyeCL""PcEyeCL""PcEyeCL", 'PixeLINK'"PixeLINK""PixeLINK""PixeLINK""PixeLINK""PixeLINK", 'pylon'"pylon""pylon""pylon""pylon""pylon", 'SaperaLT'"SaperaLT""SaperaLT""SaperaLT""SaperaLT""SaperaLT", 'Sentech'"Sentech""Sentech""Sentech""Sentech""Sentech", 'ShapeDrive'"ShapeDrive""ShapeDrive""ShapeDrive""ShapeDrive""ShapeDrive", 'SICK-3DCamera'"SICK-3DCamera""SICK-3DCamera""SICK-3DCamera""SICK-3DCamera""SICK-3DCamera", 'SiliconSoftware'"SiliconSoftware""SiliconSoftware""SiliconSoftware""SiliconSoftware""SiliconSoftware", 'SonyXCI-2'"SonyXCI-2""SonyXCI-2""SonyXCI-2""SonyXCI-2""SonyXCI-2", 'SwissRanger'"SwissRanger""SwissRanger""SwissRanger""SwissRanger""SwissRanger", 'TWAIN'"TWAIN""TWAIN""TWAIN""TWAIN""TWAIN", 'uEye'"uEye""uEye""uEye""uEye""uEye", 'USB3Vision'"USB3Vision""USB3Vision""USB3Vision""USB3Vision""USB3Vision", 'Video4Linux2'"Video4Linux2""Video4Linux2""Video4Linux2""Video4Linux2""Video4Linux2", 'VRmUsbCam'"VRmUsbCam""VRmUsbCam""VRmUsbCam""VRmUsbCam""VRmUsbCam"

QueryQueryQueryQueryQueryquery (input_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the chosen query.

Default value: 'info_boards' "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""bits_per_channel", 'camera_type'"camera_type""camera_type""camera_type""camera_type""camera_type", 'color_space'"color_space""color_space""color_space""color_space""color_space", 'defaults'"defaults""defaults""defaults""defaults""defaults", 'device'"device""device""device""device""device", 'external_trigger'"external_trigger""external_trigger""external_trigger""external_trigger""external_trigger", 'field'"field""field""field""field""field", 'general'"general""general""general""general""general", 'generic'"generic""generic""generic""generic""generic", 'horizontal_resolution'"horizontal_resolution""horizontal_resolution""horizontal_resolution""horizontal_resolution""horizontal_resolution", 'image_height'"image_height""image_height""image_height""image_height""image_height", 'image_width'"image_width""image_width""image_width""image_width""image_width", 'info_boards'"info_boards""info_boards""info_boards""info_boards""info_boards", 'parameters'"parameters""parameters""parameters""parameters""parameters", 'parameters_readonly'"parameters_readonly""parameters_readonly""parameters_readonly""parameters_readonly""parameters_readonly", 'parameters_writeonly'"parameters_writeonly""parameters_writeonly""parameters_writeonly""parameters_writeonly""parameters_writeonly", 'port'"port""port""port""port""port", 'revision'"revision""revision""revision""revision""revision", 'start_column'"start_column""start_column""start_column""start_column""start_column", 'start_row'"start_row""start_row""start_row""start_row""start_row", 'vertical_resolution'"vertical_resolution""vertical_resolution""vertical_resolution""vertical_resolution""vertical_resolution"

InformationInformationInformationInformationInformationinformation (output_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Textual information (according to QueryQueryQueryQueryQueryquery).

ValueListValueListValueListValueListValueListvalueList (output_control)  string-array → HTupleHTupleHTupleVARIANTHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double) (BSTR / Hlong / double) (char* / Hlong / double)

List of values (according to QueryQueryQueryQueryQueryquery).

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)

Example (C)

/* 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) ;

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)

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)

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)

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 acquistion interface is available, info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber

Possible Successors

open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber

See also

open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber

Module

Foundation

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 11.0.5 Copyright © 1996-2015 MVTec Software GmbH