Skip to content

Installation referenceđź”—

Software packagesđź”—

Meta packagesđź”—

Depending on your operating system, the following meta packages are available via SOM:

Development
The development version of HALCON, including interfaces to supported programming languages and all example programs, including all necessary images and 3D models.
Runtime
The runtime version of HALCON, i.e., only the set of libraries that are necessary to run a HALCON application. This type of installation encompasses neither examples nor images. However, it contains HDevEngine and the provided external procedures.
AI Accelerator Interfaces
Plugins for optimizing the performance of deep learning, like the “TensorRT Inference PlugIn”.
Image Acquisition Interfaces
The most widely used interfaces. Additional interfaces can be downloaded under mvtec.com/products/interfaces.
Digital I/O Interfaces
Interfaces for several I/O devices. Additional interfaces can be downloaded under mvtec.com/products/interfaces.
HALCON Variable Inspect Extension for Visual Studio
Extension that simplifies the debugging of applications in Visual Studio.

Single packagesđź”—

The packages above are based on the following packages:

EULA
The End User License Agreement
Installation maintenance
Support files for installation and uninstallation
Example programs
Example programs for all supported programming languages
Example data
3D-Models and images
Runtime files
All files needed for runtime installation, and the HALCON tools “hhostid” and “hcheck_parallel”
Runtime files (general)
Support files needed for runtime installation (Linux)
Development files
Include files for development, the entire product documentation, and the HALCON tools “hbench”, “hinfo”, and “hcomp”
HDevelop
HALCON’s interactive development environment (HDevelop) and a command-line tool to run HDevelop scripts (hrun)
HDevelop XL
The large-image version of HDevelop and a command-line tool to run HDevelop scripts (hrun)
Deep learning core
Pretrained classifiers for deep learning applications
Deep learning data
Images and pretrained classifiers for deep learning example programs
Deep learning third party library
CUDA libraries
Microsoft Visual C++ Redistributable
Files for the development with C++ on Windows

File structuređź”—

The default installation locations are as follows:

User mode
Install target (programs): %LOCALAPPDATA%\Programs\MVTec
Install target (data): %APPDATA%\MVTec
System mode
Install target (programs): %PROGRAMFILES%\MVTec
Install target (data): %PUBLIC%\Documents\MVTec
User mode
Install target (programs): $HOME/MVTec
Install target (data): $HOME/MVTec
System mode
Install target (programs): opt/MVTec
Install target (data): opt/MVTec

Directoriesđź”—

The following list shows the most important directories and files. Not all directories may be present depending on your installation.

bin
Contains HALCON programs and tools, in subdirectories corresponding to the different platforms. The subdirectories dotnet20 and dotnet35 contain the HALCON/.NET assemblies based on .NET Framework 2.0 and .NET Framework 3.5, respectively.
Windows only: This directory also contains the DLLs of the HALCON libraries, the DLLs for the supported image acquisition interfaces, and I/O device interfaces.
calib
Contains description files for the calibration plates, which you can use to calibrate your camera.
examples
Contains example programs, images, and models.

Tip

To experiment with the examples without modifying the distributed versions, create a private copy in your own working directory.

filter
Contains predefined filter masks.
genicam
Contains the underlying GenAPI runtime software for the GigE Vision, GenICamTL, and USB3Vision image acquisition interfaces.
include
Contains the header files that are necessary to use HALCON within the programming languages C or C++.
lib
Contains the HALCON libraries.
license
Place the license file here (see How to install a license).
lut
Contains predefined look-up tables.
misc
Contains miscellaneous files for the installer, for example, the GigE Vision filter driver.
Windows only: In addition, the installer of HALCON Variable Inspect can be found here. For more information about this extension, see Working with HALCON Variable Inspect.
ocr
Contains pretrained fonts.
procedures
Contains external procedures for HDevelop and HDevEngine.
som.d
Database for installed SOM packages, i.e., all installed packages are registered in this subdirectory.

Machine-specific configurationđź”—

The following directory contains machine-specific configuration data, for example, results of the utility hcheck_parallel or the operator optimize_aop:

C:\%ProgramData%\MVTec\HALCON-26.11

/opt/halcon ($HALCONROOT)

User-specific configurationđź”—

The following directory contains user-specific configuration data:

%APPDATA%/MVTec

$HOME/.hdevelop/MVTec

HALCON toolsđź”—

The following command-line tools are available:

hbench
A benchmark tool for the HALCON machine vision library to compare the capability of various machines. For example, memory transfer can be measured with the option hbench -memory.
hcheck_parallel
A tool checking a multiprocessor computer about its potential for speeding up HALCON operators by parallel processing. For more information, see Automatic parallelization.
hcomp
The HALCON compiler. For more information, see The HALCON compiler hcomp.
hhostid
A tool to find available host IDs for licensing. For more information, see How to identify the hardware.
hrun
A command line utility to run HDevelop scripts.

Environment variablesđź”—

HALCON-specific environment variablesđź”—

HALCONROOT
This is the most important environment variable. It designates the directory where HALCON is installed.
If this variable is unset at the time HDevelop is run, or when the HALCON library is loaded, its value will be inferred from the path the executable or the library resides in, respectively. From this path the trailing part bin\%HALCONARCH% or lib\%HALCONARCH% will be removed. The variable HALCONROOT will then be set to the resulting path temporarily.

Based on this variable, the system switches to subdirectories important for running HALCON:

  • %HALCONROOT%\examples
    If the variable HALCONEXAMPLES (see below) is not set, the system looks for example programs in this directory.

  • %HALCONEXAMPLES%\images
    If the variable HALCONIMAGES (see below) is not set, the system looks for image files in this directory.

HALCONEXAMPLES
This environment variable designates the directory where HALCON example programs are installed.
HALCONIMAGES
The system uses this environment variable to search for image files specified by a relative path.
HALCONARCH
This variable designates the used platform. For more information, see Supported platforms and minimum system requirements.
HALCONEXTENSIONS
This is a list of directories in which user-defined extension operators (so-called extension packages) are kept. Each package consists of a number of operators linked into a shared library, plus the additional operator documentation in help files and HTML files. See Installing extension packages for information on how to install an extension package, and Extending HALCON for details on creating your own extension packages.
HALCONSPY
If this environment variable is defined (regardless of the value) before you start a HALCON program, the HALCON debugging tool HALCON Spy is activated. This corresponds to call set_spy('mode','on') within a HALCON program. The main difference between the two modes for activating HALCON Spy is that by defining HALCONSPY it is possible to monitor an already linked HALCON program during runtime without modifications.
For more information about using HALCON Spy and how to parameterize it via this environment variable, see Monitoring HALCON programs with HALCON Spy.
HALCON_LICENSE_FILE
This environment variable can be set to the full path of a specific license file. In this case, the given license file is used and no further search is performed. Usually, the license file is searched in the current working directory and the installed license directory.

General environment variablesđź”—

PATH
During the installation, the folder %HALCONROOT%\bin\%HALCONARCH% is automatically added to the system variable PATH.
PATH
If you want to start HDevelop from an arbitrary directory, include the HALCON program path $HALCONROOT/bin/$HALCONARCH in the system variable PATH.
LD_LIBRARY_PATH
Include the HALCON library path $HALCONROOT/lib/$HALCONARCH in the system variable LD_LIBRARY_PATH. This is necessary both for running HDevelop and for creating stand-alone applications.
DISPLAY
The system uses this environment variable to open windows. It is used in the same way as for other X applications.
HOME
This system variable points to your home directory.