Overview

NxLib API Concept

Usually libraries come in form of a DLL providing the user with a huge variety of functions; the architecture of NxLib is quite different:

Parameter Tree

The NxLib DLL only exports a small set of functions to modify its internal tree structure in which all camera and processing parameters are contained. Upon loading the NxLib library in a process, the library creates the tree and initializes all its nodes. The exported functions allow to read and write standard JSON data types from and to the nodes of the tree. A node is identified by its path corresponding to its location where it resides in the tree.

The structure of the tree and the function of the parameters therein are documented under Tree. The accessor functions can be found in the Basic Access chapter.

Commands

In addition to the tree holding all parameters, the user can execute commands by writing a command name and its parameters to a special tree item called Execute. Parameters are written to and results are read from subnodes of the execute tree. This allows a very flexible and easily extendable parametrization of the library functions.

The list of available commands and their parameters and return values can be found under Commands.

For an overview of the different types of images and data which can be processed by commands, see the binary pipeline.