info_framegrabberT_info_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber (Operator)

Name

info_framegrabberT_info_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber — Query information about the specified image acquisition interface.

Signature

Description

The operator info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber 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, ValueListValueListValueListValueListvalueListvalue_list 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 BitsPerChannelBitsPerChannelBitsPerChannelBitsPerChannelbitsPerChannelbits_per_channel, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'camera_type':

Description and list of all supported values for the parameter CameraTypeCameraTypeCameraTypeCameraTypecameraTypecamera_type, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'color_space':

List of all supported values for the parameter ColorSpaceColorSpaceColorSpaceColorSpacecolorSpacecolor_space, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'defaults':

Interface-specific default values in ValueListValueListValueListValueListvalueListvalue_list, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'device':

List of all supported values for the parameter DeviceDeviceDeviceDevicedevicedevice, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'external_trigger':

List of all supported values for the parameter ExternalTriggerExternalTriggerExternalTriggerExternalTriggerexternalTriggerexternal_trigger, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'field':

List of all supported values for the parameter FieldFieldFieldFieldfieldfield, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'general':

General information (in InformationInformationInformationInformationinformationinformation).

'generic':

Generic value with device-specific meaning, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'horizontal_resolution':

List of all supported values for the parameter HorizontalResolutionHorizontalResolutionHorizontalResolutionHorizontalResolutionhorizontalResolutionhorizontal_resolution, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'image_height':

List of all supported values for the parameter ImageHeightImageHeightImageHeightImageHeightimageHeightimage_height, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'image_width':

List of all supported values for the parameter ImageWidthImageWidthImageWidthImageWidthimageWidthimage_width, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'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 LineInLineInLineInLineInlineInline_in, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'parameters':

List of all interface-specific parameters which are accessible via set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParamset_framegrabber_param or get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamGetFramegrabberParamget_framegrabber_param.

'parameters_readonly':

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

'parameters_writeonly':

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

'port':

List of all supported values for the parameter PortPortPortPortportport, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'revision':

Version number of the image acquisition interface.

'start_column':

List of all supported values for the parameter StartColumnStartColumnStartColumnStartColumnstartColumnstart_column, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'start_row':

List of all supported values for the parameter StartRowStartRowStartRowStartRowstartRowstart_row, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

'vertical_resolution':

List of all supported values for the parameter VerticalResolutionVerticalResolutionVerticalResolutionVerticalResolutionverticalResolutionvertical_resolution, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber.

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

Attention

For a multithreaded application, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, and close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabberclose_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

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

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

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber

Possible Successors

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber

See also

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber

Module

Foundation