3.1. Quick Start

3.1.1. The GUI

If you open itom for the first time, the main graphical user interface will look like the following screenshot:

../_images/itom_layout.png

The main components are highlighted with different colors and numbers. These components are:

  1. The menu bar gives you access to the script management, the script execution and debugging, the windowing system and help features. You can add your own menus to this bar.
  2. The most common commands are also accessible via the main toolbar of itom. Add your own toolbars and connect them with user defined scripts to adapt itom to your personal needs.
  3. The file system toolbox gives you access to script files (written in Python 3) or other files that can be loaded with itom (e.g. bmp, png, gif, tif, Matlab files… - depending on the installed plugins)
  4. The console (command line) allows you directly executing single or multiline script commands.
  5. The current set of global (or local) variables in the Python workspace is listed in the corresponding toolboxes.
  6. All available hardware and software plugins are listed in the plugin toolbox. Use this toolbox to connect to your cameras or actuators or get informed about available software filters or algorithms. If you miss a plugin whose library file exists, check the menu file >> loaded plugins… so see if the library has been found and / or why this library could not been loaded.

Connected hardware components can be operated either by script commands or directly by the GUI. The following sections show you examples for both approaches.

3.1.2. Connect to a hardware plugin using the GUI

itom comes with a set of different plugins that are used to connect to various cameras, AD-converters or actuators of different manufacturers. You can implement your own plugin (written in C++) in order to make your specific hardware component accessible via itom. By default, itom is shipped with a virtual actuator and virtual camera in order to simulate hardware on any computer without a real camera being connected.

Note

In this example, an approach is shown how to connect to an actuator instance using the GUI functionalities of itom. This approach is very similar for camera plugins.

In the following example, we will connect to such a virtual actuator, move single axes and finally close the actuator. This is all done by the graphical user interface of itom. Later we will learn, how to do this by the help of script commands. For this example, you need to have the hardware plugin DummyMotor which should be listed in the plugin toolbox as child of the actuators group.

../_images/openDummyMotor1.png

Every entry in this toolbox corresponds to one library file (Windows: *.dll, Linux: *.so), located in any subfolder of the plugins subfolder of your itom installation path. If the library could be loaded, you can connect to one or multiple instances of its represented hardware (e.g. you can connect to various motors of the same type that are connected to the computer). If you don’t find the desired library in the plugins toolbox, you either don’t have the library in the plugins subfolder or the library could not be loaded. This can have various reasons. See the loaded plugins… dialog in the menu file to check why the plugin could not be loaded.

Here, we want to create one instance of the DummyMotor plugin which simulates a motor stage with up to 10 axes. In order to create an instance, choose New Instance… from the context menu of the corresponding DummyMotor library entry (see figure above).

Usually, you have to pass multiple mandatory or optional parameters when connecting to a hardware instance (e.g. a port number, IP address, color space, identification string…). In order to pass these parameters, a dialog is opened:

../_images/openDummyMotor3.png

This dialog is automatically configured depending on the needs of the specific plugin. The tab mandatory parameters lists all parameters that you have to pass, the tab optional parameters all optional ones. If one tab is disabled, no parameters are required in this section. In case of the dummy motor, no mandatory parameters are required. However, you may change the number of virtual axes or set the internal name of the motor instance.

Each parameter has already a default value and a description, that is available when moving the mouse over the information icon at the end of the line. Additionally, parameters can have meta information that may restrict the allowed value range or the string values that are accepted. These restrictions are available via the tooltip text of the corresponding input field.

Press OK to accept the dialog and create the motor instance. If no error message occurs during initialisation a child entry is added to the DummyMotor item in the tree view of the plugin toolbox. This indicates that an instance of the plugin has been created and is ready for use. The name of this child either corresponds to the optional name of the motor instance or an auto-incremented ID if no name has been given.

Now, you can work with this motor instance. The necessary functions are either available by the context menu of the item or by the toolbar of the plugin toolbox that is always related to the currently selected item (therefore click on the instance’s item to get the necessary toolbar):

../_images/openDummyMotor4.png
  • Configuration Dialog: This opens a modal configuration dialog to configure the actuator or camera instance.
  • Show Plugin Toolbox: Every plugin can provide a toolbox that is integrated in the main window of itom and usually provides commonly used features of the plugin (e.g. the motor movement)
  • Click Close instance to close the plugin’s instance again.
  • Send to python: If you want to access the plugin’s instance by a Python script after having connected it via the GUI, use this command.

The individual (but optional) Configuration Dialog of every plugin allows changing relevant parameters of the plugin. Open this modal dialog by clicking the corresponding menu button:

../_images/dummyMotorDialog.png

As long as this window is opened, itom is blocked for further user input. The configuration dialog is assumed to only contain parameters or functions that are rarely used.

In the next step, we want to move the virtual stage. For this purpose, plugins can provide their specific toolbox, that is integrated as dockable widget into the main window of itom. Click Show Plugin Toolbox to open the toolbox of the DummyMotor:

../_images/dummyMotorWidget.png

Toolboxes are always non-blocking items that can be arbitrarily placed in the main window and usually contain often used methods and functions. In case of the dummy motor, you can use the toolbox to relatively or absolutely move one or multiple axes. During the movement, related axes are marked with a yellow background color. In case of an error, the background turns to red. The dummy motor instance simulates the movements using a speed value, that is adjustable via the configuration dialog.

Once you are done with the plugin, close the connection to the instance by clicking the Close instance button in the context menu or toolbar.

Note

Once you opened the instance by the GUI approach, shown in the recent section, you also need to close the instance by the GUI. The entry in the plugin toolbox is then marked with a gray background. Later, you will see how you can connect to the instance by a Python script or how you can later grant access to the instance to Python scripts. Then the background color turns to yellow. This means, that you have to delete all Python script variables that point to the hardware instance. Once this is done, the instance is automatically closed. For more information, read the help about the plugin toolbox.

3.1.3. Scripting

In the next section of the getting started we will learn how to execute our first lines of Python code. Python is an open-source and commonly used script language which is fully embedded into itom. You can therefore use itom to execute arbitrary Python commands or scripts, but you can also use Python to control itom and its plugins.

3.1.3.1. Hello World!

You can get the famous “hello world!” in a very simple way. Just write in the console:

1
print("hello world!")

The command is executed immediately and prints the text hello world! to the command line. Let us proceed to a more advanced example involving a camera.

3.1.3.2. Get a camera snapshot

In this example we will explain step by step how to open a camera and make a snapshot. Python code can be written and executed in two different ways, either directly, line by line, using the console, or in the form of complete scripts. In this example we will use the console and will directly type our commands. Later you can write your code in executable scripts or functions and you can control these functions with your own GUI elements.

You will need the DummyGrabber-plugin for this script to work. This plugin is a virtual camera plugin that provides noise images in order to simulate a real camera.

3.1.3.2.1. Step 1: Open the camera

First you have to start your camera device using the respective dataIO plugin. In our example we use the plugin DummyGrabber, but in general you can use any camera connected to your computer for which you have an itom plugin. Similarly to the previous example of the DummyMotor we need to create an instance of the DummyGrabber. However, we will create this instance using Python script commands instead:

1
camera = dataIO("DummyGrabber", 1024, 800)

How did we know what to write there? Select Info… from the context menu of DummyGrabber in order to show the help page about the DummyGrabber plugin:

../_images/dummyGrabberHelp.png

Note

If you don’t see the help page, go to the properties dialog of itom (menu File >> Properties) and select the checkbox Show DataIO and Actuator in the tab General >> Help Viewer.

In the help page, all mandatory and optional parameters are listed and described that are needed to instantiate one camera (the same holds for motors). If you remember the connection to the motor above, these parameters have been added to the dialog for the motor’s initialization. In case of the camera, there are up to three optional parameters. The first two describe the virtual chip size of the camera, the third one is the desired bit depth, whose default ist 8 bit.

In order to create an instance of the camera, we create an object of the Python class dataIO, which is part of the module itom. Since this module has been globally imported at startup of itom using:

from itom import *

it is allowed to directly write dataIO instead of itom.dataIO. The constructor of this class requires the name of the plugin (as string) as first parameter. The following parameters are all mandatory parameters followed by the optional ones. You don’t need to indicate all optional ones. Therefore, the example only set the parameters maxXSize and maxYSize. The bitdepth bpp was omitted, hence, its default value is assumed.

After initialization, one instance of the camera has been created and is listed in the plugin’s toolbox (with a yellow background, saying that it has been created via Python). Additionally, you will find the variable camera in the global workspace toolbox of itom. Use this variable in order to work with the camera.

3.1.3.2.2. Step 2: Get the list of parameters

Every hardware plugin (dataIO or actuator) has a set of parameters. You can read the current value, the allowed range or values and a description of each parameter using Python.

With the following command you get a list with all available parameters for your device.

1
print(camera.getParamList())

A full list of all parameters including their current value and description is obtained via:

1
camera.getParamListInfo()

In the printed list you can also see if the parameter is read-only (r) or can also be set (rw) like shown in the next step.

3.1.3.2.3. Step 3: Setting Parameters

Parameters of the device that are not marked as read-only can be set as you need it. For example, we might wish to set the upper left corner of the ROI, the integration time (in seconds) of the capturing process or the bit-depth of the captured signal:

1
2
3
camera.setParam("x0",0)
camera.setParam("integration_time",0.05)
camera.setParam("bpp",8)

3.1.3.2.4. Step 4: Getting Parameters

If you are interested in the current value of a parameter you can use the following code to retrieve it.

1
2
sizex = camera.getParam("sizex")
print("DummyGrabber width: " + str(sizex))

3.1.3.2.5. Step 5: Taking a snapshot

Before you can use the camera you have to start it (this must be done only once).

1
camera.startDevice()

Afterwards, acquire a new image. This is the time when the acquisition starts.

1
camera.acquire()

If you then want to store the image you have to create a new empty dataObject (the dataObject will resize to the correct dimensions later) and save the values of the image in this dataObject.

1
2
data = dataObject()
camera.getVal(data)

Here you have to be careful, because data is just a reference (shallow copy!, no actual data is copied from the camera’s memory) to the internal camera memory. If you want to have a deep copy of the image you should use the copy command.

1
dataCopy = data.copy()

Alternatively, you can also use the command copyVal() to directly get a copy of the object from the camera:

1
camera.copyVal(data)

3.1.3.2.6. Step 6: Displaying the image

Up to now you have not seen any image. You can plot your acquired image using

1
plot(data)

or you can watch the live image of the camera using

1
liveImage(camera)

3.1.3.2.7. Step 7: Stop/delete the camera

At the end you should stop the camera device. And if you don’t need it any more you can delete the instance of the camera plug-in.

1
2
camera.stopDevice()
del camera

3.1.3.2.8. Alternative Step 1: Open the camera

We can also open the camera via the GUI and make the new instance available for access from python.

Therefore we select the DummyGrabber within the Plugins-Browser (GUI No. 6). We right-click and select ‘newInstance’.

../_images/openDummyGrabber1.png

The window with initialisation parameters of the plugIn opens. Select the tab optional parameters and insert

  • maxXSize = 800
  • maxYSize = 600
  • bpp = 8
../_images/openDummyGrabber2.png

Than check Access instance with python and type ‘camera’ into the field variable name. Press ok. Now you can proceed with step 2 but since you already set the grabber parameters you can also proceed with step 4.

3.1.3.3. Apply a median-filter to a snap shot

In the next step, we want to explain how to use filters provided as itom-plugins on the dataObject using the example of a median filter. Instead of executing single python commands from the console, we will now utilize the itom script editor for the first time.

For this example, you will need the OpenCV-filters-Plugin and the DummyGrabber-Plugin.

3.1.3.3.1. Step 1: Open a script editor window

First we open the script editor by left-clicking the new Script-button in the button-bar or in the menufilenew Script.

../_images/newScript.png

3.1.3.3.2. Step 2: Write a simple snap routine

We insert the following code into the editor window. You will recognize the python commands from the previous section.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
camera = dataIO("DummyGrabber")
camera.startDevice()
camera.acquire()

dataSnap = dataObject()

camera.getVal(dataSnap)
camera.stopDevice()
...
...

3.1.3.3.3. Step 3: Retrieve the call for the median filter

What we need in the next step is the correct call for the median-filter, which is defined within the OpenCV-Filters plugin. Each plugin provides information concerning its usage that is accessible from python. Therefore we switch to the itom-console and type in

1
filterHelp("cvMedianBlur")

You can see a detailed description of the filter “cvMedianBlur”. An alternative approach is to right click on the filter name in the plugin toolbox and to choose Info…. Then, the itom help widget is automatically opened with the help about the filter as current page:

../_images/filterHelp.png

This help gives you information about the purpose of the filter and its mandatory and optional parameters that are required to apply the filter. At the bottom of the help page, you see an examplary Python string that shows how to call the filter (only mandatory parameters are included in this example). Click Copy example to clipboard in order to simply paste the example into your script or the command line.

3.1.3.3.4. Step 4: Insert the filter-call into the script

We use this information and append our script in the script editor with

1
2
3
dataFiltered = dataObject() #Destination image

filter("cvMedianBlur", dataSnap, dataFiltered, 5)

to filter the content dataSnap into the new object dataFiltered with a 5 x 5 filter kernel.

The filter also works inplace. That means we can use the input object as the output object, overwriting the input data. To show how this works we add

1
filter("cvMedianBlur", dataSnap, dataSnap, 5)

3.1.3.3.5. Step 5: Add plot commands

To view the results we add

1
2
plot(dataFiltered)
plot(dataSnap)

to the script.

3.1.3.3.6. Step 5: Run the script

To run the script, we press the run button or “F5” on the keyboard. If we have unsaved changes in our script, we are asked to save it.

../_images/runScript.png

You should see two 2D-Plots.

3.1.3.4. Getting online help

The python script language has a lot of methods and classes and itom expands these functionalities even further. To retain an overview, python provides a built-in online help. You can type help(class or method). For example:

1
help(dataIO)

gives a complete help for the class itom.dataIO, which is the python-represention for various data communication plugIns (e.g. the dummyGrabber).

By typing

1
help(dataIO.getParamListInfo)

you get the help for this subfunction of dataIO.

To get an overview over the different itom-plugin functions you can use one of several options.

For Plugin-Initialisation, e.g. the DummyGrabber from the last example, use pluginHelp(“pluginName”).

1
pluginHelp("DummyGrabber")

For information concerning an already initialized plugIns, e.g. the camera / DummyGrabber from the last example use the member function .getParamListInfo()

1
2
camera = dataIO("DummyGrabber")
camera.getParamListInfo()

To get a list of available (installed and loaded but not necessary instantiated) itom plug-ins of the type filter, use the methond filterHelp()

1
filterHelp()

If you want detailed information about one itomfilter use filterHelp(“filterName”)

1
filterHelp("lowFilter")

For user-defined GUI-Elements from plugIns use the function widgetHelp().

3.2. Further Information

For additional information on the features and usage of the itom GUI, see GUI The itom User Interface For a short introduction to the Python scripting language and use of the itom internal dataObject, see the section about the Python scripting language with more information about the dataObject

3.3. Tutorials

You can find all scripts used here in the demo folder. In the Demo scripts section of this manual you can find the overview of all demoscripts which are located in this folder and a short summary what is covered in these scripts. Additional tutorial focusing on plugin use are found in the plugins section.