Skip to content

get_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_paramT_get_framegrabber_param🔗

Short description🔗

get_framegrabber_paramGetFramegrabberParamGetFramegrabberParamget_framegrabber_paramT_get_framegrabber_param — Query specific parameters of an image acquisition device.

Signature🔗

get_framegrabber_param( framegrabber AcqHandle, string Param, out string Value )void GetFramegrabberParam( const HTuple& AcqHandle, const HTuple& Param, HTuple* Value )static void HOperatorSet.GetFramegrabberParam( HTuple acqHandle, HTuple param, out HTuple value )def get_framegrabber_param( acq_handle: HHandle, param: MaybeSequence[str] ) -> Sequence[HTupleElementType]

def get_framegrabber_param_s( acq_handle: HHandle, param: MaybeSequence[str] ) -> HTupleElementTypeHerror T_get_framegrabber_param( const Htuple AcqHandle, const Htuple Param, Htuple* Value )

HTuple HFramegrabber::GetFramegrabberParam( const HTuple& Param ) const

HTuple HFramegrabber::GetFramegrabberParam( const HString& Param ) const

HTuple HFramegrabber::GetFramegrabberParam( const char* Param ) const

HTuple HFramegrabber::GetFramegrabberParam( const wchar_t* Param ) const (Windows only)

HTuple HFramegrabber.GetFramegrabberParam( HTuple param )

HTuple HFramegrabber.GetFramegrabberParam( string param )

Description🔗

The operator get_framegrabber_paramGetFramegrabberParam returns specific parameter values for the image acquisition device specified by AcqHandleacqHandleacq_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" via info_framegrabberInfoFramegrabber.

Standard values for Paramparamparam, see open_framegrabberOpenFramegrabber:

  • 'name'"name" Name of the image acquisition interface.

  • 'horizontal_resolution'"horizontal_resolution" Horizontal resolution of the image acquisition device.

  • 'vertical_resolution'"vertical_resolution" Vertical resolution of the image acquisition device.

  • 'image_width'"image_width" Width of the specified image part.

  • 'image_height'"image_height" Height of the specified image part.

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

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

  • 'field'"field" Selected video field or full frame.

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

  • 'color_space'"color_space" Color space of resulting image.

  • 'generic'"generic" Generic value with device-specific meaning.

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

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

  • 'device'"device" Device name of the image acquisition device.

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

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

Attention🔗

For a multithreaded application, info_framegrabberInfoFramegrabber, open_framegrabberOpenFramegrabber, and close_framegrabberCloseFramegrabber are executed exclusively.

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

Execution information🔗

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🔗

AcqHandleacqHandleacq_handle (input_control) framegrabber → (handle)HTuple (HHandle)HFramegrabber, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the acquisition device to be used.

Paramparamparam (input_control) string(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Parameter of interest.

Default: 'revision'"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'"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"

Valuevaluevalue (output_control) string(-array) → (string / real / integer / handle)HTuple (HString / double / Hlong / HHandle)HTuple (string / double / int / long / HHandle)Sequence[HTupleElementType]Htuple (char* / double / Hlong / handle)

Parameter value.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_framegrabberOpenFramegrabber, set_framegrabber_paramSetFramegrabberParam

Possible successors

grab_imageGrabImage, grab_dataGrabData, grab_image_startGrabImageStart, grab_image_asyncGrabImageAsync, grab_data_asyncGrabDataAsync, set_framegrabber_paramSetFramegrabberParam, close_framegrabberCloseFramegrabber

See also

open_framegrabberOpenFramegrabber, info_framegrabberInfoFramegrabber, set_framegrabber_paramSetFramegrabberParam

Module🔗

Foundation