info_framegrabber (Operator)

Name

info_framegrabber — Query information about the specified image acquisition interface.

Synopsis

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

Description

The operator info_framegrabber returns information about the image acquisition device Name. The desired information is specified via Query. A textual description according to the selected topic is returned in Information. If applicable, ValueList 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_framegrabber.
'camera_type'        Description and list of all supported values for the 
                     parameter 'CameraType', see open_framegrabber.
'color_space'        List of all supported values for the parameter 
                     'ColorSpace', see open_framegrabber.
'defaults'           Interface-specific default values in 
                     ValueList, see open_framegrabber.
'device'             List of all supported values for the parameter 
                     'Device', see open_framegrabber.
'external_trigger'   List of all supported values for the parameter 
                     'ExternalTrigger', see open_framegrabber.
'field'              List of all supported values for the parameter 
                     'Field', see open_framegrabber.
'general'            General information (in Information).
'generic'            Generic value with device-specific meaning, 
                     see open_framegrabber.
'horizontal_resolution' List of all supported values for the 
                     parameter 'HorizontalResolution', see 
                     open_framegrabber.
'image_height'       List of all supported values for the parameter 
                     'ImageHeight', see open_framegrabber.
'image_width'        List of all supported values for the parameter 
                     'ImageWidth', see open_framegrabber.
'info_boards'        Information about actually installed boards
		       or cameras. This data is especially useful for the 
                     auto-detect mechansim of ActivVisionTools and 
                     for the Image Acquisition Assistant in HDevelop.
'line_in'            List of all supported values for the parameter 
                     'LineIn', see open_framegrabber.
'parameters'         List of all interface-specific parameters which 
		       are accessible via set_framegrabber_param 
		       or get_framegrabber_param.
'parameters_readonly'  List of all interface-specific parameters
		       which are only accessible via 
		       get_framegrabber_param.
'parameters_writeonly' List of all interface-specific parameters
		       which are only accessible via 
		       set_framegrabber_param.
'port'               List of all supported values for the
		       parameter 'Port', see open_framegrabber.
'revision'           Version number of the image acquisition interface.
'start_column'       List of all supported values for the parameter 
                     'StartColumn', see open_framegrabber.
'start_row'          List of all supported values for the parameter 
                     'StartRow', see open_framegrabber.
'vertical_resolution' List of all supported values for the 
                     parameter 'VerticalResolution', see 
                     open_framegrabber.

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

Parameters

Name (input_control)	string → (string)
HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/UNIX).
Default value: 'File'
Suggested values: '1394IIDC', 'ABS', 'BaumerFCAM', 'BitFlow', 'Crevis', 'DahengCAM', 'DFG-LC', 'DirectFile', 'DirectShow', 'eneo', 'eXcite', 'FALCON', 'File', 'FlashBusMX', 'GigEVision', 'Ginga++', 'GingaDG', 'INSPECTA', 'INSPECTA5', 'Leutron', 'LinX', 'LuCam', 'MatrixVisionAcquire', 'MILLite', 'mEnableIII', 'mEnableIV', 'mEnableVisualApplets', 'MultiCam', 'Opteon', 'p3i2', 'p3i4', 'PixeLINK', 'PX', 'PXC', 'PXD', 'PXR', 'pylon', 'RangerC', 'RangerE', 'SaperaLT', 'SonyXCI', 'SonyXCI-2', 'TAG', 'TWAIN', 'uEye', 'VRmUsbCam'

Query (input_control)	string → (string)
Name of the chosen query.
Default value: 'info_boards'
List of values: 'defaults', 'general', 'info_boards', 'parameters', 'parameters_readonly', 'parameters_writeonly', 'revision', 'bits_per_channel', 'camera_type', 'color_space', 'device', 'external_trigger', 'field', 'generic', 'horizontal_resolution', 'image_height', 'image_width', 'port', 'start_column', 'start_row', 'vertical_resolution'

Information (output_control)	string → (string)
Textual information (according to Query).

ValueList (output_control)	string-array → (string / integer / real)
List of values (according to Query).

Example

* Select a suitable image acquisition interface name AcqName
info_framegrabber(AcqName,'port',Information,Values)
* Choose the port P and the input line L your camera is connected to
open_framegrabber(AcqName,1,1,0,0,0,0,'default',-1,'default',-1.0, \
                  'default','default','default',P,L,AcqHandle)
grab_image(Image,AcqHandle)
close_framegrabber(AcqHandle)

Result

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

Parallelization Information

info_framegrabber is processed completely exclusively without parallelization.

Possible Predecessors

open_framegrabber

Possible Successors

open_framegrabber

See also

open_framegrabber

Module

Foundation