Data

Tools

Indexes

Applications

Experiments

Open Source Science

scikit-surgeryvtk

image fusion or overlay, for augmented reality apps, using VTK and OpenCV for a calibrated overlay.

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

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    8 of 10 committers (80.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary

Keywords

calibration opencv python scikit-surgery vtk

Keywords from Contributors

ucl augmented-reality surgery ndi tensorflow-tutorials aruco augmented-reality-applications opencv-python scikit-surgerybard vtk-applications
Last synced: 6 months ago · JSON representation

Repository

image fusion or overlay, for augmented reality apps, using VTK and OpenCV for a calibrated overlay.

Basic Info
Statistics
  • Stars: 24
  • Watchers: 2
  • Forks: 5
  • Open Issues: 10
  • Releases: 9
Topics
calibration opencv python scikit-surgery vtk
Created almost 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License

README.rst 

scikit-surgeryvtk
=================

.. image:: https://raw.githubusercontent.com/SciKit-Surgery/scikit-surgeryvtk/master/sksvtk_logo.png
   :height: 128px
   :width: 128px
   :target: https://github.com/SciKit-Surgery/scikit-surgeryvtk 
   :alt: Logo

.. image:: https://github.com/SciKit-Surgery/scikit-surgeryvtk/workflows/.github/workflows/ci.yml/badge.svg
   :target: https://github.com/SciKit-Surgery/scikit-surgeryvtk/actions
   :alt: GitHub Actions CI status

.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgeryvtk/badge.svg?branch=master&service=github
    :target: https://coveralls.io/github/SciKit-Surgery/scikit-surgeryvtk?branch=master
    :alt: Test coverage

.. image:: https://readthedocs.org/projects/scikit-surgeryvtk /badge/?version=latest
    :target: http://scikit-surgeryvtk .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

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

scikit-surgeryvtk uses VTK for Image Guided Surgery applications.

scikit-surgeryvtk 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-surgeryvtk is tested on Python 3.9 - 3.11 and may support other Python versions.

.. features-start

Features
--------

Functionality includes:

* `Load 3D surface models `_ from vtl/stl/vtp etc. files.
* `A widget to overlay `_ 3D models onto a background image e.g. from webcam/video file, useful for Augmented Reality (AR) overlays, using VTK.
* Functions for working with `calibrated cameras `_, and projecting points from 3D to 2D.
* A widget to drive a `stereo interlaced monitor `_.
* Functions to `voxelise data and calculate distance fields `_.

.. features-end

Installing
----------

You can pip install as follows:

::

    pip install scikit-surgeryvtk


Developing
----------

You can clone the repository using the following command:

::

    git clone https://github.com/SciKit-Surgery/scikit-surgeryvtk


Running the tests
-----------------

You can run the unit tests, build documentation, and other options by installing and running tox:

::

    pip install tox
    tox
    tox -e docs
    tox -e lint


Encountering Problems?
----------------------

Please get in touch or raise an `issue`_.


Contributing
------------

Please see the `contributing guidelines`_.


Useful links
------------

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


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

Copyright 2020 University College London.
scikit-surgeryvtk 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-surgeryvtk
.. _`Documentation`: https://scikit-surgeryvtk.readthedocs.io
.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery/scikit-surgery/wiki/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-surgeryvtk/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgeryvtkblob/master/LICENSE
.. _`issue`: https://github.com/SciKit-Surgery/scikit-surgeryvtk/issues/new

Owner

  • Name: SciKit-Surgery
  • Login: SciKit-Surgery
  • Kind: organization
  • Email: s.thompson@ucl.ac.uk

Compact Libraries for Surgical Navigation

GitHub Events

Total
  • Issues event: 18
  • Watch event: 3
  • Delete event: 15
  • Issue comment event: 8
  • Push event: 35
  • Create event: 24
Last Year
  • Issues event: 18
  • Watch event: 3
  • Delete event: 15
  • Issue comment event: 8
  • Push event: 35
  • Create event: 24

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 969
  • Total Committers: 10
  • Avg Commits per committer: 96.9
  • Development Distribution Score (DDS): 0.679
Past Year
  • Commits: 350
  • Committers: 3
  • Avg Commits per committer: 116.667
  • Development Distribution Score (DDS): 0.111
Top Committers
Name Email Commits
Miguel Xochicale m****e@u****k 311
Matt Clarkson m****n@u****k 297
Thomas Dowrick t****k@g****m 200
Stephen Thompson s****n@u****k 69
Thomas Dowrick t****k@u****k 44
BongjinKoo b****o@u****k 34
unknown n****5@u****k 5
Joao_Ramalhinho_Dell j****5@u****k 3
bongjinkoo d****a@g****m 3
Mian Ahmad m****d@u****k 3
Committer Domains (Top 20 + Academic)
ucl.ac.uk: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 84
  • Total pull requests: 41
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 8 hours
  • Total issue authors: 7
  • Total pull request authors: 5
  • Average comments per issue: 2.17
  • Average comments per pull request: 0.37
  • Merged pull requests: 33
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 11
  • Pull requests: 0
  • Average time to close issues: 1 day
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.18
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • thompson318 (30)
  • MattClarkson (28)
  • mxochicale (12)
  • tdowrick (9)
  • NMontanaBrown (3)
  • LiZhenzhuBlog (1)
  • liushuya7 (1)
Pull Request Authors
  • thompson318 (14)
  • tdowrick (10)
  • mxochicale (10)
  • MattClarkson (5)
  • NMontanaBrown (2)
Top Labels
Issue Labels
p3-low (7) gitlab merge request (4) p1-high (3) p2-medium (3) has attachment (2) bug (2) p0-critical (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,976 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 7
  • Total versions: 69
  • Total maintainers: 2
pypi.org: scikit-surgeryvtk

scikit-surgeryvtk uses VTK for Image Guided Surgery applications

  • Versions: 69
  • Dependent Packages: 2
  • Dependent Repositories: 7
  • Downloads: 2,976 Last month
Rankings
Dependent packages count: 2.1%
Dependent repos count: 5.6%
Average: 9.5%
Downloads: 10.1%
Stargazers count: 14.2%
Forks count: 15.4%
Maintainers (2)
MattClarkson weiss_ucl
Last synced: 6 months ago

Dependencies

requirements-dev.txt pypi
  • coverage * development
  • coveralls * development
  • mock * development
  • nbsphinx * development
  • parameterized * development
  • pyfakefs * development
  • pyinstaller * development
  • pylint * development
  • pytest * development
  • pytest-qt * development
  • pyyaml * development
  • six >=1.10 development
  • sphinx * development
  • sphinx_rtd_theme * development
  • tox * development
requirements.txt pypi
  • PySide2 <5.15.0
  • numpy >=1.11
  • opencv-contrib-python-headless >=4.2.0.32
  • scikit-surgerycore >=0.1.7
  • scikit-surgeryimage >=0.10.1
  • vtk <=9.1.0
setup.py pypi
  • PySide2 <5.15.0
  • numpy >=1.11
  • opencv-contrib-python-headless >=4.2.0.32
  • scikit-surgerycore >=0.1.7
  • scikit-surgeryimage >=0.10.1
  • vtk <=9.1.0
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/checkout master composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v2 composite
  • pypa/gh-action-pypi-publish master composite
requirements-docs.txt pypi
  • docutils *
  • six *
  • sphinx *
  • sphinx_rtd_theme *