scikit-surgeryarucotracker
===============================
.. image:: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/raw/master/project-icon.gif
:height: 128px
:width: 128px
:target: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker
:alt: Logo
|
.. image:: https://bestpractices.coreinfrastructure.org/projects/6116/badge
:target: https://bestpractices.coreinfrastructure.org/projects/6116
:alt: OpenSSF Best Practices
.. image:: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/workflows/.github/workflows/ci.yml/badge.svg
:target: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/actions/
:alt: GitHub CI test status
.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgeryarucotracker/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/SciKit-Surgery/scikit-surgeryarucotracker?branch=master
:alt: Test coverage
.. image:: https://readthedocs.org/projects/scikit-surgeryarucotracker/badge/?version=latest
:target: http://scikit-surgeryarucotracker.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://zenodo.org/badge/DOI/10.5281/zenodo.3971640.svg
:target: https://doi.org/10.5281/zenodo.3971640
:alt: Software DOI
Author: Stephen Thompson
scikit-surgeryarucotracker provides a simple Python interface between OpenCV's ARuCo marker tracking libraries and other Python packages designed around scikit-surgerytrackers. It allows you to treat an object tracked using ARuCo markers in the same way as an object tracked using other tracking hardware (e.g. aruco - scikit-surgerynditracker).
scikit-surgeryarucotracker 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)`_.
scikit-surgeryarucotracker is tested with Python 3.6 and may support other Python versions.
.. features-start
.. features-end
Installing
----------
::
pip install scikit-surgeryarucotracker
Using
-----
Configuration is done using Python libraries. Tracking data is returned in NumPy arrays.
::
from sksurgeryarucotracker.arucotracker import ArUcoTracker
config = {
"video source" : 0
}
tracker = ArUcoTracker(config)
tracker.start_tracking()
print(tracker.get_frame())
tracker.stop_tracking()
tracker.close()
Developing
----------
Cloning
^^^^^^^
You can clone the repository using the following command:
::
git clone https://github.com/SciKit-Surgery/scikit-surgeryarucotracker
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 2019 University College London.
scikit-surgeryarucotracker 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-surgeryarucotracker
.. _`Documentation`: https://scikit-surgeryarucotracker.readthedocs.io
.. _`SciKit-Surgery`: https://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/SciKit-Surgery/scikit-surgeryarucotracker/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/SciKit-Surgery/scikit-surgeryarucotracker",
"name": "scikit-surgeryarucotracker",
"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/98/e0/e96404163121a62afdea47a8161920fb6276839ef37092aef4da9196fbd9/scikit-surgeryarucotracker-1.0.2.tar.gz",
"platform": null,
"description": "scikit-surgeryarucotracker\n===============================\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/raw/master/project-icon.gif\n :height: 128px\n :width: 128px\n :target: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker\n :alt: Logo\n\n|\n\n.. image:: https://bestpractices.coreinfrastructure.org/projects/6116/badge\n :target: https://bestpractices.coreinfrastructure.org/projects/6116\n :alt: OpenSSF Best Practices\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/workflows/.github/workflows/ci.yml/badge.svg\n :target: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/actions/\n :alt: GitHub CI test status\n\n.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgeryarucotracker/badge.svg?branch=master&service=github \n :target: https://coveralls.io/github/SciKit-Surgery/scikit-surgeryarucotracker?branch=master\n :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/scikit-surgeryarucotracker/badge/?version=latest\n :target: http://scikit-surgeryarucotracker.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://zenodo.org/badge/DOI/10.5281/zenodo.3971640.svg\n :target: https://doi.org/10.5281/zenodo.3971640\n :alt: Software DOI\n\nAuthor: Stephen Thompson\n\nscikit-surgeryarucotracker provides a simple Python interface between OpenCV's ARuCo marker tracking libraries and other Python packages designed around scikit-surgerytrackers. It allows you to treat an object tracked using ARuCo markers in the same way as an object tracked using other tracking hardware (e.g. aruco - scikit-surgerynditracker). \n\nscikit-surgeryarucotracker 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\nscikit-surgeryarucotracker is tested with Python 3.6 and may support other Python versions.\n\n.. features-start\n\n.. features-end\n\nInstalling\n----------\n\n::\n\n pip install scikit-surgeryarucotracker\n\nUsing\n-----\nConfiguration is done using Python libraries. Tracking data is returned in NumPy arrays.\n\n::\n\n from sksurgeryarucotracker.arucotracker import ArUcoTracker\n config = {\n \"video source\" : 0\n }\n tracker = ArUcoTracker(config)\n\n tracker.start_tracking()\n print(tracker.get_frame())\n tracker.stop_tracking()\n tracker.close()\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-surgeryarucotracker\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 2019 University College London.\nscikit-surgeryarucotracker 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-surgeryarucotracker\n.. _`Documentation`: https://scikit-surgeryarucotracker.readthedocs.io\n.. _`SciKit-Surgery`: https://github.com/UCL/scikit-surgery/wikis/home\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-surgeryarucotracker/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgeryarucotracker/blob/master/LICENSE",
"bugtrack_url": null,
"license": "BSD-3 license",
"summary": "scikit-surgeryarucotracker is a simple tracking interface using ARuCo markers",
"version": "1.0.2",
"split_keywords": [
"medical",
"imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98e0e96404163121a62afdea47a8161920fb6276839ef37092aef4da9196fbd9",
"md5": "934d748ca7f8352539f7397cbdb3b3af",
"sha256": "939f7d89f03c066d871f6595a20dcb5efcaed0253dc535b8457eedb8bc97e0ee"
},
"downloads": -1,
"filename": "scikit-surgeryarucotracker-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "934d748ca7f8352539f7397cbdb3b3af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28391,
"upload_time": "2023-03-31T12:57:24",
"upload_time_iso_8601": "2023-03-31T12:57:24.384619Z",
"url": "https://files.pythonhosted.org/packages/98/e0/e96404163121a62afdea47a8161920fb6276839ef37092aef4da9196fbd9/scikit-surgeryarucotracker-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-31 12:57:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "SciKit-Surgery",
"github_project": "scikit-surgeryarucotracker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "scikit-surgeryarucotracker"
}
JSON
