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 implements 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.8. and may support other Python versions.
.. features-start
Features
--------
Functionality includes:
* `Load 3D surface models <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.models.vtk_surface_model>`_ from vtl/stl/vtp etc. files.
* `A widget to overlay <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#overlay-widget>`_ 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 <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.camera.vtk_camera_model>`_, and projecting points from 3D to 2D.
* A widget to drive a `stereo interlaced monitor <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.widgets.vtk_interlaced_stereo_window>`_.
* Functions to `voxelise data and calculate distance fields <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.models.voxelise>`_.
.. 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
.. _`common issues`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgery/wikis/Common-Issues
.. _`issue`: https://github.com/SciKit-Surgery/scikit-surgeryvtk/issues/new
Raw data
{
"_id": null,
"home_page": "https://github.com/SciKit-Surgery/scikit-surgeryvtk",
"name": "scikit-surgeryvtk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "medical imaging",
"author": "Thomas Dowrick",
"author_email": "t.dowrick@ucl.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/82/5d/ae1e2e5c9bb42a442babd70b81f355462c6d74fb348bdd470e0040ac1a11/scikit-surgeryvtk-2.1.1.tar.gz",
"platform": null,
"description": "scikit-surgeryvtk\n===============================\n\n.. image:: https://raw.githubusercontent.com/SciKit-Surgery/scikit-surgeryvtk/master/sksvtk_logo.png\n :height: 128px\n :width: 128px\n :target: https://github.com/SciKit-Surgery/scikit-surgeryvtk \n :alt: Logo\n\n|\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgeryvtk/workflows/.github/workflows/ci.yml/badge.svg\n :target: https://github.com/SciKit-Surgery/scikit-surgeryvtk/actions\n :alt: GitHub Actions CI status\n\n.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgeryvtk/badge.svg?branch=master&service=github\n :target: https://coveralls.io/github/SciKit-Surgery/scikit-surgeryvtk?branch=master\n :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/scikit-surgeryvtk /badge/?version=latest\n :target: http://scikit-surgeryvtk .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\nAuthor(s): Stephen Thompson, Matt Clarkson, Thomas Dowrick and Miguel Xochicale;\nContributor(s): Mian Ahmad.\n\nscikit-surgeryvtk implements VTK for Image Guided Surgery applications.\n\nscikit-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)`_.\n\nscikit-surgeryvtk is tested on Python 3.8. and may support other Python versions.\n\n.. features-start\n\nFeatures\n--------\nFunctionality includes:\n\n* `Load 3D surface models <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.models.vtk_surface_model>`_ from vtl/stl/vtp etc. files.\n* `A widget to overlay <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#overlay-widget>`_ 3D models onto a background image e.g. from webcam/video file, useful for Augmented Reality (AR) overlays, using VTK.\n* Functions for working with `calibrated cameras <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.camera.vtk_camera_model>`_, and projecting points from 3D to 2D.\n* A widget to drive a `stereo interlaced monitor <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.widgets.vtk_interlaced_stereo_window>`_.\n* Functions to `voxelise data and calculate distance fields <https://scikit-surgeryvtk.readthedocs.io/en/latest/module_ref.html#module-sksurgeryvtk.models.voxelise>`_.\n\n.. features-end\n\nInstalling\n~~~~~~~~~~\n\nYou can pip install as follows:\n::\n\n pip install scikit-surgeryvtk\n\n\nDeveloping\n^^^^^^^^^^\n\nYou can clone the repository using the following command:\n\n::\n\n git clone https://github.com/SciKit-Surgery/scikit-surgeryvtk\n\n\nRunning the tests\n^^^^^^^^^^^^^^^^^\n\nYou can run the unit tests, build documentation, and other options by installing and running tox:\n\n::\n\n pip install tox\n tox\n tox -e docs\n tox -e lint\n\n\nEncountering Problems?\n^^^^^^^^^^^^^^^^^^^^^^\nPlease get in touch or raise an `issue`_.\n\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 2020 University College London.\nscikit-surgeryvtk 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-surgeryvtk\n.. _`Documentation`: https://scikit-surgeryvtk.readthedocs.io\n.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery/scikit-surgery/wiki/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-surgeryvtk/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgeryvtkblob/master/LICENSE\n.. _`common issues`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgery/wikis/Common-Issues\n.. _`issue`: https://github.com/SciKit-Surgery/scikit-surgeryvtk/issues/new\n\n",
"bugtrack_url": null,
"license": "BSD-3 license",
"summary": "scikit-surgeryvtk implements VTK for Image Guided Surgery applications",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://github.com/SciKit-Surgery/scikit-surgeryvtk"
},
"split_keywords": [
"medical",
"imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e78f80fafcd5dc2a856129f852bc4adfd0ed47190c8980772b7199f124973bc",
"md5": "f37b3a90cc4afde8c46b5b8641adb9e3",
"sha256": "4ca38f1974a311c18f27fa3ed36e183ae690dbe6e6d0967cae42332e5b1d337d"
},
"downloads": -1,
"filename": "scikit_surgeryvtk-2.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f37b3a90cc4afde8c46b5b8641adb9e3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 94487,
"upload_time": "2024-02-24T10:16:58",
"upload_time_iso_8601": "2024-02-24T10:16:58.913321Z",
"url": "https://files.pythonhosted.org/packages/9e/78/f80fafcd5dc2a856129f852bc4adfd0ed47190c8980772b7199f124973bc/scikit_surgeryvtk-2.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "825dae1e2e5c9bb42a442babd70b81f355462c6d74fb348bdd470e0040ac1a11",
"md5": "590a9dc7be9032e300f07db80169ddbb",
"sha256": "8a95b575266db8aea5eebb0a6270ddee7188a85f01a230e55bd9f0a8d9b699d8"
},
"downloads": -1,
"filename": "scikit-surgeryvtk-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "590a9dc7be9032e300f07db80169ddbb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 82880,
"upload_time": "2024-02-24T10:17:01",
"upload_time_iso_8601": "2024-02-24T10:17:01.028244Z",
"url": "https://files.pythonhosted.org/packages/82/5d/ae1e2e5c9bb42a442babd70b81f355462c6d74fb348bdd470e0040ac1a11/scikit-surgeryvtk-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 10:17:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SciKit-Surgery",
"github_project": "scikit-surgeryvtk",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.11"
]
]
},
{
"name": "vtk",
"specs": [
[
">=",
"9.2.6"
]
]
},
{
"name": "PySide6",
"specs": [
[
">=",
"6.5.1.1"
]
]
},
{
"name": "opencv-contrib-python-headless",
"specs": [
[
">=",
"4.2.0.32"
]
]
},
{
"name": "scikit-surgerycore",
"specs": [
[
">=",
"0.1.7"
]
]
},
{
"name": "scikit-surgeryimage",
"specs": [
[
">=",
"0.10.1"
]
]
}
],
"tox": true,
"lcname": "scikit-surgeryvtk"
}
JSON
