get_framegrabber

get_framegrabber_param ( : : FGHandle, Param : Value )

Get specific parameters for a frame grabber.

The operator get_framegrabber_param returns specific parameter values for the frame grabber specified by FGHandle. The standard parameters listed below are available for all frame grabbers. Additional parameters may be supported by specific frame grabbers. A list of those can be obtained with the query 'parameter' via info_framegrabber.

Standard values for Param, see open_framegrabber:

'name'         Name of the frame grabber interface.

'horizontal_resolution'
               Horizontal image resolution of the frame grabber.
 
'vertical_resolution'
               Vertical image resolution of the frame grabber.

'image_width'  Width of the desired image part.

'image_height' Height of the desired image part.

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

'start_column' Column coordinate of upper left corner of desired 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.

'gain'         Amplification factor for video amplifier.

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

'camera_type'  Type of used camera (frame grabber specific).

'device'       Device the frame grabber board is linked to.

'port'         Port of the frame grabber the video input is linked to.

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

Parameters

`FGHandle` (input_control)	framegrabber `->` integer
Handle of the frame grabber to be used.

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

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

Result

If the frame grabber is open and the specified parameter is supported by the frame grabber, the operator get_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

Possible Successors

grab_image, grab_region, grab_image_start, grab_image_async, grab_region_async, close_framegrabber

Module

Image / region / XLD management