Metadata-Version: 1.1
Name: scikit-surgerynditracker
Version: 0.1.10
Summary: Interface for Northern Digital (NDI) Trackers with data to NumPy arrays
Home-page: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgerynditracker
Author: Stephen Thompson
Author-email: s.thompson@ucl.ac.uk
License: BSD-3 license
Description: scikit-surgerynditracker
        ===============================
        
        .. image:: https://github.com/UCL/scikit-surgerynditracker/raw/master/weiss_logo.png
           :height: 128px
           :width: 128px
           :target: https://github.com/UCL/scikit-surgerynditracker
           :alt: Logo
        
        |
        
        .. image:: https://github.com/UCL/scikit-surgerynditracker/workflows/.github/workflows/ci.yml/badge.svg
           :target: https://github.com/UCL/scikit-surgerynditracker/actions/
           :alt: GitHub CI test status
        
        .. image:: https://coveralls.io/repos/github/UCL/scikit-surgerynditracker/badge.svg?branch=master&service=github
            :target: https://coveralls.io/github/UCL/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
        
        
        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/UCL/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/UCL/scikit-surgerynditracker
        .. _`Documentation`: https://scikit-surgerynditracker.readthedocs.io
        .. _`SciKit-Surgery`: https://www.github.com/UCL/scikit-surgery/wikis/home
        .. _`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/UCL/scikit-surgerynditracker/blob/master/CONTRIBUTING.rst
        .. _`license file`: https://github.com/UCL/scikit-surgerynditracker/blob/master/LICENSE
        
        
Keywords: medical imaging
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: System :: Hardware
