scikit-surgerynditracker
scikit-surgerynditracker is a python interface for Northern Digital (NDI) trackers. It should work with Polaris Vicra, Spectra, and Vega optical trackers and Aurora electromagnetic trackers. Tracking data is output as NumPy arrays.
Author: Stephen Thompson
scikit-surgerynditracker is part of the SciKit-Surgery software project, developed at the Wellcome EPSRC Centre for Interventional and Surgical Sciences, part of University College London (UCL).
Installing
pip install scikit-surgerynditracker
Using
Configuration is done using Python libraries at instantiation. Invalid configuration should raise exceptions. Tracking data is returned in a set of lists, containing the port handles, timestamps, framenumbers, the tracking data and a tracking quality metric. By default tracking data is returned as a 4x4 NumPy array, though can be returned as a quaternion by changing the configuration.
from sksurgerynditracker.nditracker import NDITracker
SETTINGS = {
"tracker type": "polaris",
"romfiles" : ["../data/8700339.rom"]
}
TRACKER = NDITracker(SETTINGS)
TRACKER.start_tracking()
port_handles, timestamps, framenumbers, tracking, quality = TRACKER.get_frame()
for t in tracking:
print (t)
TRACKER.stop_tracking()
TRACKER.close()
See demo.py for a full example
Developing
Cloning
You can clone the repository using the following command:
git clone https://github.com/SciKit-Surgery/scikit-surgerynditracker
Running the tests
You can run the unit tests by installing and running tox:
pip install tox tox
Contributing
Please see the contributing guidelines.
Useful links
Licensing and copyright
Copyright 2018 University College London. scikit-surgerynditracker is released under the BSD-3 license. Please see the license file for details.
Acknowledgements
Metadata
Release files for scikit-surgerynditracker 1.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scikit_surgerynditracker-1.0.6.tar.gz | 33.3 kB | Details |
Release files / scikit_surgerynditracker-1.0.6.tar.gz
| Download URL | scikit_surgerynditracker-1.0.6.tar.gz |
|---|---|
| Size | 33.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0c25129392d34f6a23a89aaa0313cde8790dad644016ef67ce689967e923abed
|
|
BLAKE2b-256 checksum How to use checksums |
c5b35390eaea96dc91e042b114589f899437846f38725d3c5338619f39e9a1f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency log