itom.liveImage(cam, className='', properties={}) → show a camera live image in a new figure

Creates a plot-image (2D) and automatically grabs images into this window. This function is not blocking.

If no ‘className’ is given, the type of the plot is chosen depending on the type and the size of the object. The defaults for several plot classes can be adjusted in the property dialog of itom.

You can also set a class name of your preferred plot plugin (see also property dialog of itom). If your preferred plot is not able to display the given object, a warning is returned and the default plot type is used again. For dataObjects, it is also possible to simply set ‘className’ to ‘1D’ or ‘2D’ in order to choose the default plot type depending on these aliases.

Every plot has several properties that can be configured in the Qt Designer (if the plot is embedded in a GUI), or by the property toolbox in the plot itself or by using the info() method of the corresponding itom.uiItem instance.

Use the ‘properties’ argument to pass a dictionary with properties you want to set to a certain value.


cam : {dataIO-Instance}

Camera grabber device from which images are acquired.

className : {str}, optional

class name of desired plot (if not indicated or if the className can not be found, the default plot will be used (see application settings)

properties : {dict}, optional

optional dictionary of properties that will be directly applied to the plot widget.


index : {int}

This index is the figure index of the plot figure that is opened by this command. Use figure(index) to get a reference to the figure window of this live image plot. The plot can be closed by ‘close(index)’.

plotHandle: {plotItem} :

Handle of the live image plot. This handle is used to control the properties of the plot, connect to its signals or call slots of the plot.

See also

plot, plotItem