FAQ

Windows 11.

Requirements

Install CodeMeter Runtime 9.00 or later and connect the LumiScan Key first. Then close all open applications, double-click Installer_LumiScan_Annotation_va_b_c_d.exe (a, b, c, d depend on the software version), accept the licence terms with Accept and follow the setup wizard to Finish.

Installing CodeMeter Runtime, Installing LumiScan Annotation on Windows

LumiScan Annotation is licensed with the LumiScan Key and needs CodeMeter Runtime 9.00 or later. Bought from HD Vision Systems, the licence is on the LumiScan Key and is an annual subscription. Bought in the ctrlX Store for Windows 11, it uses ctrlX WORKS together with the LumiScan Key. One LumiScan Key is needed per device that runs the software at the same time; keys can be exchanged between devices.

Requirements, Installing CodeMeter Runtime, Licensing FAQ

To annotate a single folder, select the folder containing the PNG images. To work with several folders, select a parent folder that contains one or more folders of PNG images (with their CSV and JSON files) and choose the folder to annotate in the folder drop-down menu at the top.

Folder Structure

settings.json is created automatically at the first start in C:\Users\<USER>\AppData\Local\HD Vision Systems GmbH\LumiScan Annotation. Its labels section is empty at first; labels you enter there are added automatically. ROI values can also be specified in the roiSettings section and are loaded automatically.

JSON Settings Example

Open Menu > Settings and click User Management. In the Users window, type a name in the lower edit box and click + to add a user; select a user in the list and click - to delete it. The user selected in the user combobox is saved when changes are made.

User Management

The region of interest (ROI) defines the part of the captured image in which the trained network will search. By default it covers the entire image. Set it in Menu > ROI Settings or in the roiSettings section of settings.json; in the central view the ROI borders are shown in blue.

ROI Settings

In the central view (the box gets the label of the active class in the label list):

Image Annotation

Select the box with a left-click (it shows four yellow corner handles). Drag its inside to move it, its edges to resize it and its corners to rotate it around its center. With the keyboard, Ctrl/Shift + i/j/k/l moves the box by one/ten pixels, Ctrl/Shift + u/o rotates it by one/ten degrees, Ctrl/Shift + v/b changes the height and Ctrl/Shift + n/m the width by one/ten pixels.

Image Annotation

Select the box with a left-click, then select another label in the label overview, type a new label, or press the label number 1-9.

Image Annotation, Shortcuts for Common Operations

a switches to the previous image, s saves the image, d switches to the next image, and alt + s saves and copies the labels to the next image (useful when the content changes little between images). The table of shortcuts can also be opened via Menu > Help.

Shortcuts for Common Operations, Navigation

Yes. After each saved annotation, LumiScan Annotation writes the user name, a Unix timestamp, the image name (PNG) and the save file name (CSV) to a JSON file. This file is saved in the raw directory under the name of the saved image; later entries are appended.

Image Annotation

See the site-wide LumiScan FAQ. Contact customer support at customer.success@hdvisionsystems.com or +49 6221 6721905. For licences, write to licenses@hdvisionsystems.com.