Requirements

Licence

How LumiScan Object Finder is licensed depends on where you bought it and where it runs:

Bought from Runs on Licensing

HD Vision Systems

Windows 11 or Ubuntu 24.04

The licence is held on your LumiScan Key. It is a one-time purchase and needs no renewal.

Licensing path: bought from HD Vision Systems

ctrlX Store

Windows 11

The licence is held in ctrlX WORKS. The LumiScan Key is required in addition; it protects the software against reverse engineering.

Licensing path: ctrlX Store, Windows

ctrlX Store

ctrlX OS (ctrlX CORE or IPC)

ctrlX licence SWL-W-XCx-OBJECTxFDxHDVS-V1NN, one licence per ten modules.

Licensing path: ctrlX Store, ctrlX OS

Each device on which LumiScan Object Finder runs at the same time needs its own LumiScan Key. Keys can be exchanged between devices.

How to install CodeMeter Runtime and how to request, renew and move licences is described in LumiScan Licensing.

On ctrlX OS, the application shuts down shortly after starting if the licence is missing; the reason is written to the system log.

A platform and its Data Layer

Platform Data Layer

ctrlX OS (ctrlX CORE or ctrlX IPC)

ctrlX Data Layer, provided by ctrlX OS

a PC with Windows 11 or Ubuntu 24.04

LumiScan Keryx, the Data Layer of HD Vision Systems for PCs

On ctrlX OS there is nothing to install for the Data Layer.

On a PC the application starts the LumiScan Keryx broker when none is running; installing and setting up LumiScan Keryx is described in LumiScan Keryx on a PC.

An image source on the same device

The application reads its images from another application’s Data Layer image node. That application must run on the same device - the same ctrlX CORE or ctrlX IPC, or the same PC. Remote Data Layer access is not supported.

In practice this is LumiScan Cam Driver, but any application works as long as its image node provides these four children:

Node Type Description

data

array of uint8

Raw, uncompressed pixel data

width

uint64

Image width in pixels

height

uint64

Image height in pixels

pixel-type

string

GenICam pixel format name

Supported pixel formats

Mono8, Mono12, RGB8, RGB12, BGR8, BGR12, BayerGR8, BayerGR12, BayerRG8, BayerRG12.

Bayer images are converted to colour and 12-bit images are scaled down to 8 bit before matching, so templates cut from one format still match images of another.

Any other pixel format is rejected with status code -3.

Storage

Templates are stored as PNG files in the application’s configuration directory. On ctrlX OS this directory is part of the active solution. Allow for the size of the templates you expect to keep - a template is a small crop, typically a few tens of kilobytes.

The directory is created on first start. See Object Storage.

The image stream (experimental) adds one folder beside them, settings-history/: one small JSON file for each settings hash a module publishes, never deleted. See Finding Objects on an Image Stream (Experimental).

Timing

Matching is synchronous: the call to execute returns when the search has finished. How long that takes depends on the image size, the template size, and above all on how wide a scale and rotation range is searched - the work is one pass per scale/rotation combination.

Start from the defaults, which search a single scale and rotation, and widen only as far as the application actually needs. See Tuning the Search.