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

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)

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

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

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

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

HTuple HFramegrabber.GetFramegrabberParam(HTuple param)

HTuple HFramegrabber.GetFramegrabberParam(string param)

def get_framegrabber_param(acq_handle: HHandle, param: MaybeSequence[str]) -> Sequence[Union[str, float, int]]

def get_framegrabber_param_s(acq_handle: HHandle, param: MaybeSequence[str]) -> Union[str, float, int]

Description

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

Standard values for ParamParamParamParamparamparam, see open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber:

'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'"true""true""true""true""true"/ 'false'"false""false""false""false""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 acquisition 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

For a multithreaded application all image acquisition operators (as listed in open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber) are an own group in which info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbersCloseAllFramegrabbersclose_all_framegrabbers are executed exclusively.

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

Execution Information

Parameters

AcqHandleAcqHandleAcqHandleAcqHandleacqHandleacq_handle (input_control)  framegrabber → HFramegrabber, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the acquisition device to be used.

ParamParamParamParamparamparam (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (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) → HTupleSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / 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_paramGetFramegrabberParamGetFramegrabberParamGetFramegrabberParamget_framegrabber_param returns the value TRUE. Otherwise an exception is raised.

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParamset_framegrabber_param

Possible Successors

grab_imagegrab_imageGrabImageGrabImageGrabImagegrab_image, grab_datagrab_dataGrabDataGrabDataGrabDatagrab_data, grab_image_startgrab_image_startGrabImageStartGrabImageStartGrabImageStartgrab_image_start, grab_image_asyncgrab_image_asyncGrabImageAsyncGrabImageAsyncGrabImageAsyncgrab_image_async, grab_data_asyncgrab_data_asyncGrabDataAsyncGrabDataAsyncGrabDataAsyncgrab_data_async, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParamset_framegrabber_param, close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber

See also

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber, set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParamset_framegrabber_param

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 21.05.0.0 Copyright © 1996-2021 MVTec Software GmbH
Follow us on