get_framegrabber

get_framegrabber_param ( : : AcqHandle, Param : Value )

Query specific parameters of a image acquisition device.

The operator get_framegrabber_param returns specific parameter values for the image acquisition device specified by AcqHandle. The standard parameters listed below are available for all image acquisition devices. Additional parameters may be supported by a specific image acquisition device. A list of those parameters can be obtained with the query 'parameter' via info_framegrabber.

Standard values for Param, see open_framegrabber:

'name'         Name of the image acquisition interface.

'horizontal_resolution'
               Horizontal resolution of the image acquisition device.

'vertical_resolution'
               Vertical resolution of the image acquisition device.

'image_width'  Width of the speicfied image part.

'image_height' Height of the speicfied image part.

'start_row'    Row coordinate of upper left corner of specified image part.

'start_column' Column coordinate of upper left corner of specified image part.

'field'        Selected video field or full frame.

'bits_per_channel'
               Number of transferred bits per pixel and image channel.

'color_space'  Color space of resulting image.

'generic'      Generic value with device-specific meaning.

'external_trigger'  
               External triggering ('true' / 'false').

'camera_type'  Type of used camera (interface-specific).

'device'       Device name of the image acquistion device.

'port'         Port the image acquisition device is connected to.

'line_in'      Camera input line of multiplexer (optional).

Parameters

`AcqHandle` (input_control)	framegrabber `->` integer
Handle of the acquisition device to be used.

`Param` (input_control)	string(-array) `->` string
Parameter of interest.
Default value: 'revision'
Suggested values: 'bits_per_channel', 'camera_type', 'color_space', 'continuous_grabbing', 'device', 'external_trigger', 'field', 'generic', 'grab_timeout', 'horizontal_resolution', 'image_available', 'image_height', 'image_width', 'line_in', 'name', 'port', 'revision', 'start_column', 'start_row', 'vertical_resolution', 'volatile'

`Value` (output_control)	string(-array) `->` string / real / integer
Parameter value.

Result

If the image acquisition device is open and the specified parameter is supported, the operator set_framegrabber_param returns the value 2 (H_MSG_TRUE). Otherwise an exception handling is raised.

Parallelization Information

get_framegrabber_param is reentrant and processed without parallelization.

Possible Predecessors

open_framegrabber, set_framegrabber_param

Possible Successors

grab_image, grab_data, grab_image_start, grab_image_async, grab_data_async, set_framegrabber_param, close_framegrabber

Module

Foundation

Up: Image/Acquisition Top: HALCON Operators