get_framegrabber_paramT_get_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_param (Operator)

Name

get_framegrabber_paramT_get_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_param — Query specific parameters of an image acquisition device.

Signature

get_framegrabber_param( : : AcqHandle, Param : Value)

Description

The operator get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_param returns specific parameter values for the image acquisition device specified by AcqHandleAcqHandleAcqHandleacqHandleacq_handle. 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'"parameter""parameter""parameter""parameter" via info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber.

Standard values for ParamParamParamparamparam, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber:

'name'"name""name""name""name": Name of the image acquisition interface.
'horizontal_resolution'"horizontal_resolution""horizontal_resolution""horizontal_resolution""horizontal_resolution": Horizontal resolution of the image acquisition device.
'vertical_resolution'"vertical_resolution""vertical_resolution""vertical_resolution""vertical_resolution": Vertical resolution of the image acquisition device.
'image_width'"image_width""image_width""image_width""image_width": Width of the specified image part.
'image_height'"image_height""image_height""image_height""image_height": Height of the specified image part.
'start_row'"start_row""start_row""start_row""start_row": Row coordinate of upper left corner of specified image part.
'start_column'"start_column""start_column""start_column""start_column": Column coordinate of upper left corner of specified image part.
'field'"field""field""field""field": Selected video field or full frame.
'bits_per_channel'"bits_per_channel""bits_per_channel""bits_per_channel""bits_per_channel": Number of transferred bits per pixel and image channel.
'color_space'"color_space""color_space""color_space""color_space": Color space of resulting image.
'generic'"generic""generic""generic""generic": Generic value with device-specific meaning.
'external_trigger'"external_trigger""external_trigger""external_trigger""external_trigger": External triggering ('true'"true""true""true""true"/ 'false'"false""false""false""false").
'camera_type'"camera_type""camera_type""camera_type""camera_type": Type of used camera (interface-specific).
'device'"device""device""device""device": Device name of the image acquisition device.
'port'"port""port""port""port": Port the image acquisition device is connected to.
'line_in'"line_in""line_in""line_in""line_in": Camera input line of multiplexer (optional).

Attention

For a multithreaded application, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, and close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber are executed exclusively.

get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_param runs in parallel with all non-exclusive operators inside and outside of this group.

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

AcqHandleAcqHandleAcqHandleacqHandleacq_handle (input_control) framegrabber → (handle)

Handle of the acquisition device to be used.

ParamParamParamparamparam (input_control) string(-array) → (string)

Parameter of interest.

Default: 'revision' "revision" "revision" "revision" "revision"

Suggested 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", 'continuous_grabbing'"continuous_grabbing""continuous_grabbing""continuous_grabbing""continuous_grabbing", 'device'"device""device""device""device", 'external_trigger'"external_trigger""external_trigger""external_trigger""external_trigger", 'field'"field""field""field""field", 'generic'"generic""generic""generic""generic", 'grab_timeout'"grab_timeout""grab_timeout""grab_timeout""grab_timeout", 'horizontal_resolution'"horizontal_resolution""horizontal_resolution""horizontal_resolution""horizontal_resolution", 'image_available'"image_available""image_available""image_available""image_available", 'image_height'"image_height""image_height""image_height""image_height", 'image_width'"image_width""image_width""image_width""image_width", 'line_in'"line_in""line_in""line_in""line_in", 'name'"name""name""name""name", '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", 'volatile'"volatile""volatile""volatile""volatile"

ValueValueValuevaluevalue (output_control) string(-array) → (string / real / integer / handle)

Parameter value.

Result

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

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamset_framegrabber_param

Possible Successors

grab_imagegrab_imageGrabImageGrabImagegrab_image, grab_datagrab_dataGrabDataGrabDatagrab_data, grab_image_startgrab_image_startGrabImageStartGrabImageStartgrab_image_start, grab_image_asyncgrab_image_asyncGrabImageAsyncGrabImageAsyncgrab_image_async, grab_data_asyncgrab_data_asyncGrabDataAsyncGrabDataAsyncgrab_data_async, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamset_framegrabber_param, close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber

Module

Foundation

Operators