--- title: "FAQ" description: "Frequently asked questions about LumiScan Annotation - requirements and installation, settings file, folder structure, users, ROI, bounding boxes, shortcuts and licensing." product: "LumiScan Annotation" component: "lumiscan-annotation" version: "1.8.4" display_version: "1.8.4.3" latest_version: true language: "en" url: "https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/faq.html" --- # FAQ – LumiScan Annotation Short answers to common questions and error messages for LumiScan Annotation. Each entry links to the page with the details. > [!TIP] > Search this page for the exact error message. Each entry has a fixed anchor (for example `#faq-settings-file`). ## Requirements, installation and licensing ### Which operating system does LumiScan Annotation require? {#faq-system-requirements} - **Answer:** Windows 11. - **More:** [Requirements](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/requirements.html) ### How do I install LumiScan Annotation? {#faq-installation} - **Answer:** 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**. - **More:** [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/before-installation.html#installing-the-codemeter-runtime-environment-2), [Installing LumiScan Annotation on Windows](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/installing-lumiscan-annotation-on-windows.html) ### How is LumiScan Annotation licensed? {#faq-licence} - **Answer:** 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. - **More:** [Requirements](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/requirements.html#licence), [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html), [Licensing FAQ](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/faq.html) ## Getting started ### How must the images be organized? {#faq-folder-structure} - **Answer:** 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. - **More:** [Folder Structure](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/folder-structure.html) ### Where is the settings file and what can I configure in it? {#faq-settings-file} - **Answer:** `settings.json` is created automatically at the first start in `C:\Users\\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. - **More:** [JSON Settings Example](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/user-interface.html#json-settings-example) ### How do I add or delete users? {#faq-users} - **Answer:** 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. - **More:** [User Management](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/menu.html#user-management) ### What is the ROI and how do I set it? {#faq-roi} - **Answer:** 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. - **More:** [ROI Settings](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/menu.html#roi-settings) ## Annotating images ### How do I add an oriented bounding box? {#faq-add-bounding-box} - **Answer:** In the central view (the box gets the label of the active class in the label list): 1. Double-click with the left mouse button where the bottom edge of the box should be (this edge is always green). 2. Without holding the mouse button, left-click on the upper edge of the object to set the height. 3. Left-click on any side point of the object to set the width. - **More:** [Image Annotation](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/image-annotation.html) ### How do I move, resize or rotate a bounding box? {#faq-edit-bounding-box} - **Answer:** 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. - **More:** [Image Annotation](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/image-annotation.html) ### How do I change the label of a bounding box? {#faq-change-label} - **Answer:** 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. - **More:** [Image Annotation](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/image-annotation.html), [Shortcuts for Common Operations](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/shortcuts-for-common-operations.html) ### Which keys switch images and save annotations? {#faq-navigation-shortcuts} - **Answer:** `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**. - **More:** [Shortcuts for Common Operations](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/shortcuts-for-common-operations.html), [Navigation](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/navigation.html) ### Can I see who changed an annotation and when? {#faq-change-history} - **Answer:** 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. - **More:** [Image Annotation](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/image-annotation.html) ## Troubleshooting {#troubleshooting} Problems and error messages are described step by step in [Troubleshooting](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/troubleshooting.html): - [The window is empty](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/troubleshooting.html#faq-first-start-empty-window) ## Support ### Where can I get further help? {#faq-support} - **Answer:** See the site-wide [LumiScan FAQ](https://docs.hdvisionsystems.com/en/faq.html). Contact customer support at [customer.success@hdvisionsystems.com](mailto:customer.success@hdvisionsystems.com) or +49 6221 6721905. For licences, write to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com).