get_framegrabber_param¶
This operator is used to get interface parameters or to read directly out of the NxLib API Tree.
Parameters¶
get_framegrabber_param (AcqHandle, Parameter, Variable)
Parameter |
Description |
|---|---|
AcqHandle |
An acquisition handle obtained via ‘ open_framegrabber’. |
Parameter |
This can either be an interface parameter or an item path for direct tree item access. |
Variable |
A variable where the value to be read is stored. |
Halcon Interface Parameters¶
Parameter |
Values |
Default |
Type |
Description |
|---|---|---|---|---|
‘auto_grab_data’ |
‘true’, ‘false’ |
‘true’ |
string |
Get the ‘auto_grab_data’ flag for the given handle. |
‘parallel_execution’ |
‘true’, ‘false’ |
‘false’ |
string |
Get the ‘parallel_execution’ flag for the given handle. |
‘error_code’ |
<error_code> |
integer |
Retrieve the API error code. |
|
‘error_item’ |
‘<error_item_path>’ |
string |
Retrieve the path of the tree item which caused the error. |
|
‘error_text’ |
‘<error_text>’ |
string |
Retrieve the error text. |
|
‘generate_regions’ |
‘true’, ‘false’ |
‘true’ |
string |
Get the ‘generate_regions’ flag for the given handle. |
‘grab_data_items’ |
[‘<binary_node_path>’] |
string, tuple |
List of binary nodes which will be provided when using ‘grab_data’ on the given handle. |
|
‘replace_nans’ |
‘true’, ‘false’ |
‘true’ |
string |
Get the ‘replace_nans’ flag for the given handle. |
‘path’ |
‘<node_path>’ |
string |
Get the nxLib node path of the current handle. |
|
‘execute_node’ |
‘<node_path>’ |
‘/Execute’ |
string |
Get the path to the handle’s execute node. When parallel execution is disabled, this returns the path to the default execute node. |
‘debug_messages’ |
<messages> |
string |
Retrieve all buffered debug messages. |
Tree Item Access¶
get_framegrabber_param(AcqHandle, ItemPath, Variable)
Parameter |
Description |
|---|---|
AcqHandle |
An acquisition handle obtained via ‘ open_framegrabber’. |
ItemPath |
A path to a tree item to be read. The item path is relative to the path with which the handle is associated. Note: This operator can’t be used to read binary nodes. For this purpose use ‘ grab_data’ instead. |
Variable |
A variable where the value to be read is stored. |
You can prefix the item path with ‘type:’ to get the item’s type instead of its value. The type is returned as a string and can be ‘Null’, ‘Number’, ‘String’, ‘Bool’, ‘Array’, ‘Object’ or ‘Inexistent’ (when the given path does not exist).
Example¶
* Open default stereo camera
open_framegrabber('Ensenso-NxLib', 0, 0, 0, 0, 0, 0, 'default', 0, 'Raw', -1, 'false', 'Stereo', '', 0, 0, AcqHandle)
* Read Handle Parameter
get_framegrabber_param (AcqHandle, 'grab_data_items', grabDataItems)
get_framegrabber_param (AcqHandle, 'error_text', errorText)
* Tree Item Access
get_framegrabber_param (AcqHandle, 'Parameters/Capture/AutoExposure', autoExposure)
get_framegrabber_param (AcqHandle, 'Parameters/Capture/Exposure', exposure)
* Tree Item Types
get_framegrabber_param (AcqHandle, 'type:Parameters/Capture/AutoExposure', autoExposureType)
* Get full subtree as JSON string
get_framegrabber_param (AcqHandle, 'Parameters', parameters)