info_framegrabberT_info_framegrabberInfoFramegrabberInfoFramegrabber (Operator)
Name
info_framegrabberT_info_framegrabberInfoFramegrabberInfoFramegrabber — Query information about the specified image acquisition interface.
Signature
Description
The operator info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber 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,
ValueListValueListValueListValueListvalueList 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_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'camera_type':
Description and list of all supported values for the
parameter 'CameraType', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'color_space':
List of all supported values for the parameter
'ColorSpace', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'defaults':
Interface-specific default values
in ValueListValueListValueListValueListvalueList, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'device':
List of all supported values for the parameter
'Device', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'external_trigger':
List of all supported values for the parameter
'ExternalTrigger', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'field':
List of all supported values for the parameter
'Field', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'general':
General information (in InformationInformationInformationInformationinformation).
- 'generic':
Generic value with device-specific meaning,
see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'horizontal_resolution':
List of all supported values for the
parameter 'HorizontalResolution', see
open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'image_height':
List of all supported values for the parameter
'ImageHeight', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'image_width':
List of all supported values for the parameter
'ImageWidth', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- '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':
List of all supported values for the parameter
'LineIn', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'parameters':
List of all interface-specific parameters which
are accessible via set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParam
or get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamGetFramegrabberParam.
- 'parameters_readonly':
List of all interface-specific parameters
which are only accessible via
get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamGetFramegrabberParam.
- 'parameters_writeonly':
List of all interface-specific parameters
which are only accessible via
set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParam.
- 'port':
List of all supported values for the
parameter 'Port', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'revision':
Version number of the image acquisition interface.
- 'start_column':
List of all supported values for the parameter
'StartColumn', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'start_row':
List of all supported values for the parameter
'StartRow', see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
- 'vertical_resolution':
List of all supported values for the
parameter 'VerticalResolution', see
open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber.
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"
for documentation about specific image grabber interfaces.
Attention
For a multithreaded application all image acquisition operators
(as listed in open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber) are an own group in which
info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber,
close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbersCloseAllFramegrabbers are
executed exclusively.
Thus, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber,
close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbersCloseAllFramegrabbers block the
concurrent execution of all other operators within this group, 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
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
NameNameNameNamename (input_control) string → HTupleHTupleHtuple (string) (string) (HString) (char*)
HALCON image acquisition interface name, i.e.,
name of the corresponding DLL (Windows) or
shared library (Linux/macOS).
Default value:
'File'
"File"
"File"
"File"
"File"
Suggested values: 'ABS'"ABS""ABS""ABS""ABS", 'ADLINK'"ADLINK""ADLINK""ADLINK""ADLINK", '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", 'FocalSpecCLI'"FocalSpecCLI""FocalSpecCLI""FocalSpecCLI""FocalSpecCLI", 'GenICamTL'"GenICamTL""GenICamTL""GenICamTL""GenICamTL", 'GigEVision2'"GigEVision2""GigEVision2""GigEVision2""GigEVision2", 'Ginga++'"Ginga++""Ginga++""Ginga++""Ginga++", 'GingaDG'"GingaDG""GingaDG""GingaDG""GingaDG", 'heliCamC3'"heliCamC3""heliCamC3""heliCamC3""heliCamC3", 'LinX'"LinX""LinX""LinX""LinX", 'LPS36'"LPS36""LPS36""LPS36""LPS36", 'LuCam'"LuCam""LuCam""LuCam""LuCam", 'MatrixVisionAcquire'"MatrixVisionAcquire""MatrixVisionAcquire""MatrixVisionAcquire""MatrixVisionAcquire", '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", 'pylon'"pylon""pylon""pylon""pylon", '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", '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 → HTupleHTupleHtuple (string) (string) (HString) (char*)
Name of the chosen query.
Default value:
'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 → HTupleHTupleHtuple (string) (string) (HString) (char*)
Textual information (according to QueryQueryQueryQueryquery).
ValueListValueListValueListValueListvalueList (output_control) string-array → HTupleHTupleHtuple (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 acquistion
interface is available, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber returns the value
2 (H_MSG_TRUE). Otherwise an exception is raised.
Possible Predecessors
open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber
Possible Successors
open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber
See also
open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber
Module
Foundation