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

get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamget_framegrabber_paramGetFramegrabberParamGetFramegrabberParam (Operator)

Name

get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamget_framegrabber_paramGetFramegrabberParamGetFramegrabberParam — Query specific parameters of an image acquisition device.

Signature

get_framegrabber_param( : : AcqHandle, Param : Value)

Herror get_framegrabber_param(const Hlong AcqHandle, const char* Param, char* Value)

Herror T_get_framegrabber_param(const Htuple AcqHandle, const Htuple Param, Htuple* Value)

Herror get_framegrabber_param(const HTuple& AcqHandle, const HTuple& Param, char* Value)

Herror get_framegrabber_param(const HTuple& AcqHandle, const HTuple& Param, HTuple* Value)

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

void GetFramegrabberParam(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

void HOperatorSetX.GetFramegrabberParam(
[in] VARIANT AcqHandle, [in] VARIANT Param, [out] VARIANT* Value)

VARIANT HFramegrabberX.GetFramegrabberParam([in] VARIANT Param)

static void HOperatorSet.GetFramegrabberParam(HTuple acqHandle, HTuple param, out HTuple value)

HTuple HFramegrabber.GetFramegrabberParam(HTuple param)

HTuple HFramegrabber.GetFramegrabberParam(string param)

Description

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

Standard values for ParamParamParamParamParamparam, see open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber:

'name'"name""name""name""name""name"

Name of the image acquisition interface.

'horizontal_resolution'"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"

Vertical resolution of the image acquisition device.

'image_width'"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""image_height"

Height of the specified image part.

'start_row'"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""start_column"

Column coordinate of upper left corner of specified image part.

'field'"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""bits_per_channel"

Number of transferred bits per pixel and image channel.

'color_space'"color_space""color_space""color_space""color_space""color_space"

Color space of resulting image.

'generic'"generic""generic""generic""generic""generic"

Generic value with device-specific meaning.

'external_trigger'"external_trigger""external_trigger""external_trigger""external_trigger""external_trigger"

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

'camera_type'"camera_type""camera_type""camera_type""camera_type""camera_type"

Type of used camera (interface-specific).

'device'"device""device""device""device""device"

Device name of the image acquistion device.

'port'"port""port""port""port""port"

Port the image acquisition device is connected to.

'line_in'"line_in""line_in""line_in""line_in""line_in"

Camera input line of multiplexer (optional).

Attention

Basically an image acquisition handle AcqHandleAcqHandleAcqHandleAcqHandleAcqHandleacqHandle cannot be used in multiple threads. However, possible exceptions are described in the specific reference documentation of the respective image acquisition interface. Different image acquisition handles can be used safely with different threads for each handle.

For a multithreaded application all image acquisition operators (as listed in open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber) are an own group in which info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberclose_framegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbers are executed exclusively.

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

Parallelization

Parameters

AcqHandleAcqHandleAcqHandleAcqHandleAcqHandleacqHandle (input_control)  framegrabber → HFramegrabber, HTupleHTupleHFramegrabber, HTupleHFramegrabberX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the acquisition device to be used.

ParamParamParamParamParamparam (input_control)  string(-array) → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Parameter of interest.

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

Suggested values: 'bits_per_channel'"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""camera_type", 'color_space'"color_space""color_space""color_space""color_space""color_space", 'continuous_grabbing'"continuous_grabbing""continuous_grabbing""continuous_grabbing""continuous_grabbing""continuous_grabbing", 'device'"device""device""device""device""device", 'external_trigger'"external_trigger""external_trigger""external_trigger""external_trigger""external_trigger", 'field'"field""field""field""field""field", 'generic'"generic""generic""generic""generic""generic", 'grab_timeout'"grab_timeout""grab_timeout""grab_timeout""grab_timeout""grab_timeout", 'horizontal_resolution'"horizontal_resolution""horizontal_resolution""horizontal_resolution""horizontal_resolution""horizontal_resolution", 'image_available'"image_available""image_available""image_available""image_available""image_available", 'image_height'"image_height""image_height""image_height""image_height""image_height", 'image_width'"image_width""image_width""image_width""image_width""image_width", 'line_in'"line_in""line_in""line_in""line_in""line_in", 'name'"name""name""name""name""name", 'port'"port""port""port""port""port", 'revision'"revision""revision""revision""revision""revision", 'start_column'"start_column""start_column""start_column""start_column""start_column", 'start_row'"start_row""start_row""start_row""start_row""start_row", 'vertical_resolution'"vertical_resolution""vertical_resolution""vertical_resolution""vertical_resolution""vertical_resolution", 'volatile'"volatile""volatile""volatile""volatile""volatile"

ValueValueValueValueValuevalue (output_control)  string(-array) → HTupleHTupleHTupleVARIANTHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong) (BSTR / double / Hlong) (char* / double / Hlong)

Parameter value.

Result

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

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam

Possible Successors

grab_imagegrab_imageGrabImagegrab_imageGrabImageGrabImage, grab_datagrab_dataGrabDatagrab_dataGrabDataGrabData, grab_image_startgrab_image_startGrabImageStartgrab_image_startGrabImageStartGrabImageStart, grab_image_asyncgrab_image_asyncGrabImageAsyncgrab_image_asyncGrabImageAsyncGrabImageAsync, grab_data_asyncgrab_data_asyncGrabDataAsyncgrab_data_asyncGrabDataAsyncGrabDataAsync, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam, close_framegrabberclose_framegrabberCloseFramegrabberclose_framegrabberCloseFramegrabberCloseFramegrabber

See also

open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber, info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam

Module

Foundation

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 11.0.5 Copyright © 1996-2015 MVTec Software GmbH