Bases: itom.uiItem
figure([handle, [rows = 1, cols = 1]]) -> creates figure window.
The class itom.figure represents a standalone figure window, that can have various subplots. If an instance of this class is created without further parameters a new figure is created and opened having one subplot area (currently empty) and the numeric handle to this figure is returned:
h = figure()
Subplots are arranged in a regular grid whose size is defined by the optional parameters ‘rows’ and ‘cols’. If you create a figure instance with a given handle, the instance is either a reference to an existing figure that has got this handle or if it does not exist, a new figure with the desired handle is opened and the handle is returned, too.
Parameters : | handle : {int}
rows : {int, default: 1}
cols : {int, default: 1}
|
---|
This method closes and deletes any specific figure (given by handle) or all opened figures.
Parameters : | handle : {dataIO-Instance}
|
---|
Notes
If any instance of class ‘figure’ still keeps a reference to any figure, it is only closed and deleted if the last instance is deleted, too.
Creates a plot-image (2D) and automatically grabs images into this window. This function is not blocking.
Parameters : | cam : {dataIO-Instance}
areaIndex: {int}, optional : className : {str}, optional
|
---|
Plot an existing dataObject in not dockable, not blocking window. The style of the plot will depend on the object dimensions. If x-dim or y-dim are equal to 1, plot will be a lineplot else a 2D-plot.
Parameters : | data : {DataObject}
areaIndex: {int}, optional : className : {str}, optional
|
---|
This method closes and deletes any specific figure (given by handle) or all opened figures.
Parameters : | index : {unsigned int}
|
---|
dock status of figure (True|False)
this attribute controls the dock appearance of this figure. If it is docked, the figure is integrated into the main window of itom, else it is a independent window.
returns handle of figure