HALCON Website / HALCON Operator Reference / Image / Acquisition
ClassesClasses | | Operators

set_framegrabber_paramT_set_framegrabber_paramSetFramegrabberParamSetFramegrabberParam (Operator)

Name

set_framegrabber_paramT_set_framegrabber_paramSetFramegrabberParamSetFramegrabberParam — Set specific parameters of an image acquistion device.

Signature

set_framegrabber_param( : : AcqHandle, Param, Value : )

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

void SetFramegrabberParam(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)

static void HOperatorSet.SetFramegrabberParam(HTuple acqHandle, HTuple param, HTuple value)

void HFramegrabber.SetFramegrabberParam(HTuple param, HTuple value)

void HFramegrabber.SetFramegrabberParam(string param, string value)

Description

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

Attention

For a multithreaded application all image acquisition operators (as listed in open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber) are an own group in which info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbersCloseAllFramegrabbers are executed exclusively.

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

Execution Information

This operator modifies the state of the following input parameter:

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

Parameters

AcqHandleAcqHandleAcqHandleAcqHandleacqHandle (input_control, state is modified)  framegrabber → HFramegrabber, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the acquisition device to be used.

ParamParamParamParamparam (input_control)  string(-array) → HTupleHTupleHtuple (string) (string) (HString) (char*)

Parameter name.

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

ValueValueValueValuevalue (input_control)  string(-array) → HTupleHTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)

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_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParam returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber

Possible Successors

grab_imagegrab_imageGrabImageGrabImageGrabImage, grab_datagrab_dataGrabDataGrabDataGrabData, grab_image_startgrab_image_startGrabImageStartGrabImageStartGrabImageStart, grab_image_asyncgrab_image_asyncGrabImageAsyncGrabImageAsyncGrabImageAsync, grab_data_asyncgrab_data_asyncGrabDataAsyncGrabDataAsyncGrabDataAsync, get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamGetFramegrabberParam

See also

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber, get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamGetFramegrabberParamGetFramegrabberParam

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 19.11.0.0 Copyright © 1996-2019 MVTec Software GmbH