eegkit / pluslib

Software library for data acquisition, pre-processing, and calibration for navigated image-guided interventions.

PlusLib

Software library for data acquisition, pre-processing, and calibration for navigated image-guided interventions. See more information at PlusToolkit.org.

Bugs

Please file an issue report over at https://github.com/PlusToolkit/PlusLib/issues.

Questions

Please start a discussion at https://github.com/PlusToolkit/PlusLib/discussions.

Documentation

• PlusLib API documentation: generated nightly from the latest code version.
• Plus devices: description of the steps requires to implement a new device interface.
• Notepad++ log file syntax highlighting is available via this user-defined language.

Testing dashboards

• PlusLib dashboard: results of automatic tests of the Plus library
• PlusApp dashboard: results of automatic tests of the Plus applications

Build instructions

Plus library files and all required libraries and toolkits are automatically downloaded, configured, and built using CMake "superbuild" method (using CMake external project infrastructure). Build instructions are available in PlusBuild repository.

Supported platforms:

• 32/64-bit builds: Plus can be built in either 32-bit or 64-bit mode. 64-bit applications have the advantage of larger available memory space (which is useful for certain applications, such as recording a large number of frames in memory, or reconstructing high-resolution volumes), but only a few hardware devices have 64-bit compatible drivers. If available memory is not a concern  then use only 32-bit builds. If lots of memory is needed, and the application does not have to use tracking or imaging hardware devices directly then 64-bit build of Plus can be used. If both hardware support and lots of memory is needed then a 32-bit build of Plus can be used for data acquisition and the acquired data can be passed on to a 64-bit Plus or other application for further processing.
• Windows 7 32-bit/64-bit, Windows 10 32-bit/64-bit, Windows XP 32-bit embedded, Ubuntu 16.04, and MacOSX operating systems are fully supported and regularly tested.
• Running on Linux and MacOS: Unfortunately, many of the drivers written for devices are Windows specific, and thus capture cannot be done on a Linux or MacOSX machine. It is recommended to do the data acquisition on Windows and stream the acquired data to the Linux or MacOS computer for further processing.

Contributing

We follow the standard GitHub Flow process. In short: send a pull request with proposed changes. See more information here.

When making code changes, please follow Plus coding conventions. The Astyle formatter can be used to quickly format a file to Plus standards.

• PLUS format

License

Plus has a BSD-style license, which allows any kind of use for free. See more details here.