NAMI-THU / IGTPrototypingTool

A Java-based tool for prototyping of medical Image Guided Therapy (IGT) applications. OpenCV and OpenIGTLink are included. Build tool is Gradle.

IGTPrototypingTool

A tool that provides basic functionalities for IGT. Tracker can be connected using OpenIGTLink, and the reported information can be used for conveniently implementing some functionality.

This tool started as a student project and is currently actively maintained by various students of Ulm University of Applied Sciences (THU).

Currently, at least Java 11 is required, but all LTS versions upwards (Java 15, Java 17) and also Java 20 are supported.

Building

For building, you can import this project as a Gradle project into your IDE, or you can run in a terminal:

# For windows
./gradle.bat build # builds the project
./gradle.bat run # runs the main program

# For linux
./gradlew build
./gradlew run

Coding Guidelines

This project uses Checkstyle to enforce some basic style checks:

• Use spaces for indentation, not tabs
• Don't use Umlaut characters
• End files with a new line
• Don't leave trailing spaces at the end of a line Run the checkstyle gradle task to check your code:

# Windows
./gradle.bat checkstyleMain

# Linux
./gradlew checkstyleMain

To ensure compatibility with older Java versions, please set the language level of this project to the lowest supported language version, currently Java 11.

Documentation

JavaDoc is automatically compiled and published to GitHub Pages. Please make sure to document all public methods and classes to help lowering the barrier for new students.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

The icon is taken from MITK, which is licensed under the BSD 3-Clause License. Check the respective attribution for more information.