scikit-surgerytutorial01

Our first tutorial, make your own Augmented Reality app.

https://github.com/scikit-surgery/scikit-surgerytutorial01

Keywords

Repository

Our first tutorial, make your own Augmented Reality app.

README.rst

SciKit-Surgery Augmented Reality Tutorial
=========================================

.. image:: https://github.com/SciKit-Surgery/scikit-surgerytutorial01/raw/master/project-icon.gif
   :height: 128px
   :width: 128px
   :target: https://github.com/SciKit-Surgery/scikit-surgeryturorial01
   :alt: Logo

|

.. image:: https://readthedocs.org/projects/scikit-surgerytutorial01/badge/?version=latest
   :target: https://scikit-surgerytutorial01.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/badge/Contributor%20Covenant-2.1-4baaaa.svg
   :target: CODE_OF_CONDUCT.md

.. image:: https://img.shields.io/badge/MICCAI%20Educational%20Challenge-Finalist-yellow
   :target: https://miccai-sb.github.io/materials.html#mec2019
   :alt: Finalist in 2019 MICCAI Educational Challenge

.. 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

Author(s): Stephen Thompson.
Contributor(s): Miguel Xochicale, Mian Asbat Ahmad and Matt Clarkson.

This is the SciKit-Surgery Augmented Reality Tutorial. It will teach you how to write an augmented reality application, showing a rendered model on top of a live video feed.

The SciKit-Surgery Augmented Reality Tutorial 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-Surgery`_ is a suite of Python modules developed to accelerate the translation of basic science into clinical applications. 

The SciKit-Surgery Augmented Reality Tutorial has been tested with Python 2.7 and Python 3.6 and Python 3.7.

Purpose
-------
This tutorial guides the user in producing a simple augmented reality application using
some of the SciKit-Surgery libraries. The tutorial is intended to show how SciKit-Surgery can be used to 
quickly develop applications that include;
  
- data acquisition,
- data processing,
- data display,
- how SciKit-Surgery enables the use of 3rd party Python libraries.

To remain accessible to novice programmers the tutorial tries to avoid issues such as 
parsing command line arguments, event loops and GUI design. 

Cloning
^^^^^^^

You can clone the repository using the following command:

::

    git clone https://github.com/SciKit-Surgery/SciKit-SurgeryTutorial01


Contributing
^^^^^^^^^^^^

Please see the `contributing guidelines`_.


Useful links
^^^^^^^^^^^^

* `Source code repository`_
* `Documentation`_


Licensing and copyright
-----------------------

Copyright 2019 University College London.
The SciKit-Surgery Augmented Reality Tutorial 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-SurgeryTutorial01
.. _`Documentation`: https://SciKit-SurgeryTutorial01.readthedocs.io
.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery/scikit-surgery/wiki
.. _`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-SurgeryTutorial01/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/SciKit-SurgeryTutorial01/blob/master/LICENSE

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use SciKit-Surgery Tutorial01 in your research, please cite it as below."
authors:
- family-names: "Thompson"
  given-names: "Stephen"
  orcid: "https://orcid.org/0000-0001-7286-1326"
title: "SciKit-SurgeryTutorial01"
url: "https://github.com/SciKit-Surgery/scikit-surgerytutorial01"
preferred-citation:
  type: article
  authors:
  - family-names: "Thompson"
    given-names: "Stephen"
    orcid: "https://orcid.org/0000-0001-7286-1326"
  - family-names: "Dowrick"
    given-names: "Thomas"
    orcid: "https://orcid.org/0000-0002-2712-4447"
  - family-names: "Ahmad"
    given-names: "Mian"
    orcid: "https://orcid.org/0000-0002-4706-4146"
  - family-names: "Xiao"
    given-names: "Guofang"
  - family-names: "Koo"
    given-names: "Bongjin"
    orcid: "https://orcid.org/0000-0002-3611-4988"
  - family-names: "Bonmati"
    given-names: "Ester"
    orcid: "https://orcid.org/0000-0001-9217-5438"
  - family-names: "Kahl"
    given-names: "Kim"
  - family-names: "Clarkson"
    given-names: "Matthew"
    orcid: "https://orcid.org/0000-0002-5565-1252"
  doi: 10.1007/s11548-020-02180-5
  journal: "International journal of computer assisted radiology and surgery"
  start: 1075
  end: 1084
  title: "SciKit-Surgery: Compact Libraries for Surgical Navigation"
  volume: 15
  issue: 7
  year: 2020

GitHub Events

Issues and Pull Requests

Last synced: 10 months ago