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
Raw data
{
"_id": null,
"home_page": "https://github.com/SciKit-Surgery/scikit-surgerynditracker",
"name": "scikit-surgerynditracker",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "medical imaging",
"author": "Stephen Thompson",
"author_email": "s.thompson@ucl.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/4d/17/e588d04dbf6a717e561d0d3140fe388008814d7151b85d11bd5b08fe7940/scikit-surgerynditracker-1.0.0.tar.gz",
"platform": null,
"description": "scikit-surgerynditracker\n===============================\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgerynditracker/raw/master/sksndi_logo.png\n :height: 128px\n :target: https://github.com/SciKit-Surgery/scikit-surgerynditracker\n :alt: Logo\n\n|\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgerynditracker/workflows/.github/workflows/ci.yml/badge.svg\n :target: https://github.com/SciKit-Surgery/scikit-surgerynditracker/actions/\n :alt: GitHub CI test status\n\n.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgerynditracker/badge.svg?branch=master&service=github\n :target: https://coveralls.io/github/SciKit-Surgery/scikit-surgerynditracker?branch=master\n :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/scikit-surgerynditracker/badge/?version=latest\n :target: http://scikit-surgerynditracker.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/Cite-SciKit--Surgery-informational\n :target: https://doi.org/10.1007/s11548-020-02180-5\n :alt: The SciKit-Surgery paper\n\n.. image:: https://img.shields.io/twitter/follow/scikit_surgery?style=social\n :target: https://twitter.com/scikit_surgery?ref_src=twsrc%5Etfw\n :alt: Follow scikit_surgery on twitter\n\nscikit-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.\n\nAuthor: Stephen Thompson\n\nscikit-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)`_.\n\n\nInstalling\n----------\n\n::\n\n pip install scikit-surgerynditracker\n\nUsing\n-----\nConfiguration is done using Python libraries at instantiation. Invalid\nconfiguration should raise exceptions. Tracking data is returned in a set of\nlists, containing the port handles, timestamps, framenumbers, the tracking data\nand a tracking quality metric. By default tracking data is returned as a 4x4 NumPy array,\nthough can be returned as a quaternion by changing the configuration.\n\n::\n\n from sksurgerynditracker.nditracker import NDITracker\n SETTINGS = {\n \"tracker type\": \"polaris\",\n \"romfiles\" : [\"../data/8700339.rom\"]\n }\n TRACKER = NDITracker(SETTINGS)\n\n TRACKER.start_tracking()\n port_handles, timestamps, framenumbers, tracking, quality = TRACKER.get_frame()\n for t in tracking:\n print (t)\n TRACKER.stop_tracking()\n TRACKER.close()\n\nSee demo.py for a full example\n\nDeveloping\n----------\n\nCloning\n^^^^^^^\n\nYou can clone the repository using the following command:\n\n::\n\n git clone https://github.com/SciKit-Surgery/scikit-surgerynditracker\n\n\nRunning the tests\n^^^^^^^^^^^^^^^^^\n\nYou can run the unit tests by installing and running tox:\n\n::\n\n pip install tox\n tox\n\nContributing\n^^^^^^^^^^^^\n\nPlease see the `contributing guidelines`_.\n\n\nUseful links\n^^^^^^^^^^^^\n\n* `Source code repository`_\n* `Documentation`_\n\n\nLicensing and copyright\n-----------------------\n\nCopyright 2018 University College London.\nscikit-surgerynditracker is released under the BSD-3 license. Please see the `license file`_ for details.\n\n\nAcknowledgements\n----------------\n\nSupported by `Wellcome`_ and `EPSRC`_.\n\n\n.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss\n.. _`source code repository`: https://github.com/SciKit-Surgery/scikit-surgerynditracker\n.. _`Documentation`: https://scikit-surgerynditracker.readthedocs.io\n.. _`SciKit-Surgery`: https://www.github.com/SciKit-Surgery\n.. _`University College London (UCL)`: http://www.ucl.ac.uk/\n.. _`Wellcome`: https://wellcome.ac.uk/\n.. _`EPSRC`: https://www.epsrc.ac.uk/\n.. _`contributing guidelines`: https://github.com/SciKit-Surgery/scikit-surgerynditracker/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgerynditracker/blob/master/LICENSE",
"bugtrack_url": null,
"license": "BSD-3 license",
"summary": "Interface for Northern Digital (NDI) Trackers with data to NumPy arrays",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/SciKit-Surgery/scikit-surgerynditracker"
},
"split_keywords": [
"medical",
"imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d17e588d04dbf6a717e561d0d3140fe388008814d7151b85d11bd5b08fe7940",
"md5": "3714c49bdd2a478c8731c04a2617e55b",
"sha256": "b6d0e16bd9d2ac7e47902f6758435802995f2e11690a1423ae4058ba610b582e"
},
"downloads": -1,
"filename": "scikit-surgerynditracker-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3714c49bdd2a478c8731c04a2617e55b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24434,
"upload_time": "2023-10-11T16:24:20",
"upload_time_iso_8601": "2023-10-11T16:24:20.847084Z",
"url": "https://files.pythonhosted.org/packages/4d/17/e588d04dbf6a717e561d0d3140fe388008814d7151b85d11bd5b08fe7940/scikit-surgerynditracker-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-11 16:24:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SciKit-Surgery",
"github_project": "scikit-surgerynditracker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "scikit-surgerynditracker"
}
JSON
