set_framegrabber_paramSetFramegrabberParamSetFramegrabberParamset_framegrabber_paramT_set_framegrabber_param

HALCON ScriptCpp++.NETPythonC

Short description

set_framegrabber_paramSetFramegrabberParamSetFramegrabberParamset_framegrabber_paramT_set_framegrabber_param — Set specific parameters of an image acquisition device.

Signature

set_framegrabber_param( framegrabber AcqHandle, string Param, string Value )void SetFramegrabberParam( const HTuple& AcqHandle, const HTuple& Param, const HTuple& Value )static void HOperatorSet.SetFramegrabberParam( HTuple acqHandle, HTuple param, HTuple value )def set_framegrabber_param( acq_handle: HHandle, param: MaybeSequence[str], value: HTupleType ) -> None

Herror T_set_framegrabber_param( const Htuple AcqHandle, const Htuple Param, const Htuple Value )

void HFramegrabber::SetFramegrabberParam( const HTuple& Param, const HTuple& Value ) const

void HFramegrabber::SetFramegrabberParam( const HString& Param, const HString& Value ) const

void HFramegrabber::SetFramegrabberParam( const char* Param, const char* Value ) const

void HFramegrabber::SetFramegrabberParam( const wchar_t* Param, const wchar_t* Value ) const (Windows only)

void HFramegrabber.SetFramegrabberParam( HTuple param, HTuple value )

void HFramegrabber.SetFramegrabberParam( string param, string value )

Description

The operator set_framegrabber_paramSetFramegrabberParam sets specific parameters for the image acquisition device specified by AcqHandleacqHandleacq_handle. Additional information for a specific image acquisition device is available via info_framegrabberInfoFramegrabber. A comprehensive documentation of all image acquisition device-specific parameters can be found in the corresponding interface documentation in the directory doc/html/reference/acquisition.

Attention

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

set_framegrabber_paramSetFramegrabberParam 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.

This operator modifies the state of the following input parameter:

• AcqHandleacqHandleacq_handle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

AcqHandleacqHandleacq_handle (input_control, state is modified) 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 name.

Suggested values: 'color_space', 'continuous_grabbing', 'external_trigger', 'grab_timeout', 'image_height', 'image_width', 'port', 'start_column', 'start_row', 'volatile'"color_space", "continuous_grabbing", "external_trigger", "grab_timeout", "image_height", "image_width", "port", "start_column", "start_row", "volatile"

Valuevaluevalue (input_control) string(-array) → (string / real / integer / handle)HTuple (HString / double / Hlong / HHandle)HTuple (string / double / int / long / HHandle)HTupleTypeHtuple (char* / double / Hlong / handle)

Parameter value to be set.

Result

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

Combinations with other operators

Combinations

Possible predecessors

open_framegrabberOpenFramegrabber

Possible successors

grab_imageGrabImage, grab_dataGrabData, grab_image_startGrabImageStart, grab_image_asyncGrabImageAsync, grab_data_asyncGrabDataAsync, get_framegrabber_paramGetFramegrabberParam

See also

open_framegrabberOpenFramegrabber, info_framegrabberInfoFramegrabber, get_framegrabber_paramGetFramegrabberParam

Module

Foundation