dev_inspect_ctrl (Operator)

Name

dev_inspect_ctrl — Open a window to inspect one or more control variables.

Synopsis

dev_inspect_ctrl( : : Variable : )

Description

dev_inspect_ctrl opens a variable inspect dialog to display the contents of one or more control variables. It is possible to pass several variables together in one expression, e.g., within a tuple. The standard variable inspect shows a table with one column for the values of one variable. In addition some statistics can be displayed for every variable.

For some selected semantic variable types a specific variable inspect windows is opened:

'Matrix objects': For every matrix object one inspect window is opened that orders the matrix values in a table.

'Image acquistion handles': For every image acquistion handle one inspect window is opened, that shows the most important image acquisition parameters and allows to switch a live grab mode on or off.

Normally, the contents of the dialog will be updated whenever the variable changes. However, the update behavior can be influenced by the operator dev_update_var and the Update Variable preference.

The dialog can be closed by pressing the Close button or by calling dev_close_inspect_ctrl.

Attention

This operator is not supported for code export.

Parameters

Variable (input_control)	integer(-array) → (integer / real / string)
Name of the variable to be checked.

Example

read_image (Image, 'fabrik')
regiongrowing (Image, Regions, 3, 3, 6, 100)
area_center (Regions, Area, Row, Column)
dev_inspect_ctrl (Area)

Result

If the values of the specified parameters are correct dev_inspect_ctrl returns 2 (H_MSG_TRUE). Otherwise an exception is raised and an error code returned.

See also

dev_update_var

Module

Foundation