https://github.com/scikit-surgery/scikit-surgerynditracker
Easy communication with NDI trackers (Polaris Vicra, Spectra, Vega, and Aurora)
https://github.com/scikit-surgery/scikit-surgerynditracker
ndi scikit-surgery ucl
Last synced: about 1 year ago
JSON representation
Easy communication with NDI trackers (Polaris Vicra, Spectra, Vega, and Aurora)
- Host: GitHub
- URL: https://github.com/scikit-surgery/scikit-surgerynditracker
- Owner: SciKit-Surgery
- License: other
- Created: 2020-04-28T13:24:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T09:16:20.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T01:58:11.870Z (about 1 year ago)
- Topics: ndi, scikit-surgery, ucl
- Language: Python
- Homepage: https://github.com/SciKit-Surgery
- Size: 1.63 MB
- Stars: 44
- Watchers: 3
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
scikit-surgerynditracker
===============================
.. image:: https://github.com/SciKit-Surgery/scikit-surgerynditracker/raw/master/sksndi_logo.png
:height: 128px
:target: https://github.com/SciKit-Surgery/scikit-surgerynditracker
:alt: Logo
|
.. image:: https://github.com/SciKit-Surgery/scikit-surgerynditracker/workflows/.github/workflows/ci.yml/badge.svg
:target: https://github.com/SciKit-Surgery/scikit-surgerynditracker/actions/
:alt: GitHub CI test status
.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgerynditracker/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/SciKit-Surgery/scikit-surgerynditracker?branch=master
:alt: Test coverage
.. image:: https://readthedocs.org/projects/scikit-surgerynditracker/badge/?version=latest
:target: http://scikit-surgerynditracker.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/Cite-SciKit--Surgery-informational
:target: https://doi.org/10.1007/s11548-020-02180-5
:alt: The SciKit-Surgery paper
.. image:: https://img.shields.io/twitter/follow/scikit_surgery?style=social
:target: https://twitter.com/scikit_surgery?ref_src=twsrc%5Etfw
:alt: Follow scikit_surgery on twitter
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
^^^^^^^^^^^^
* `Source code repository`_
* `Documentation`_
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
----------------
Supported by `Wellcome`_ and `EPSRC`_.
.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss
.. _`source code repository`: https://github.com/SciKit-Surgery/scikit-surgerynditracker
.. _`Documentation`: https://scikit-surgerynditracker.readthedocs.io
.. _`SciKit-Surgery`: https://www.github.com/SciKit-Surgery
.. _`University College London (UCL)`: http://www.ucl.ac.uk/
.. _`Wellcome`: https://wellcome.ac.uk/
.. _`EPSRC`: https://www.epsrc.ac.uk/
.. _`contributing guidelines`: https://github.com/SciKit-Surgery/scikit-surgerynditracker/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgerynditracker/blob/master/LICENSE