scikit-surgerycore
===============================
.. image:: https://github.com/SciKit-Surgery/scikit-surgerycore/raw/master/skscore_logo.png
:height: 200px
:target: https://github.com/SciKit-Surgery/scikit-surgerycore
:alt: Logo
|
.. image:: https://github.com/SciKit-Surgery/scikit-surgerycore/workflows/.github/workflows/ci.yml/badge.svg
:target: https://github.com/SciKit-Surgery/scikit-surgerycore/actions
:alt: GitHub Actions CI status
.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgerycore/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/SciKit-Surgery/scikit-surgerycore?branch=master
:alt: Test coverage
.. image:: https://readthedocs.org/projects/scikit-surgerycore/badge/?version=latest
:target: http://scikit-surgerycore.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
Description
-----------
SciKit-SurgeryCore implements algorithms and tools that are common to all SciKit-Surgery packages.
SciKit-SurgeryCore 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)`_.
.. features-start
Features
--------
* A `Configuration Manager <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.configuration.configuration_manager>`_ to load parameters from a .json file
* A `Transform Manager <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.transforms.transform_manager>`_ to manage combinations of 4x4 transformation matrices
* `Corresponding point <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.algorithms.procrustes>`_ (i.e Landmark) based registration, based on `Arun et al., 1987`_.
* `Rotaiton/translation Matrix construction <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.transforms.matrix>`_ and `validation functions <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#matrix-validation>`_,
checking a numpy array is a camera matrix, rotation matrix, rigid transform etc.
.. features-end
Citing
------
If you make use of SciKit-Surgery libraries in your work, please cite the following paper:
| Thompson S, Dowrick T, Ahmad M, et al.
| SciKit-Surgery: compact libraries for surgical navigation.
| International Journal of Computer Assisted Radiology and Surgery. May 2020.
| DOI: 10.1007/s11548-020-02180-5
Installing
----------
You can pip install as follows:
::
pip install scikit-surgerycore
Developing
----------
Cloning
^^^^^^^
You can clone the repository using the following command:
::
git clone https://github.com/SciKit-Surgery/scikit-surgerycore.git
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-surgerycore 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-surgerycore
.. _`Documentation`: https://scikit-surgerycore.readthedocs.io
.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery/
.. _`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-surgerycore/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgerycore/blob/master/LICENSE
.. _`Arun et al., 1987`: http://doi.ieeecomputersociety.org/10.1109/TPAMI.1987.4767965
Raw data
{
"_id": null,
"home_page": "https://github.com/SciKit-Surgery/scikit-surgerycore",
"name": "scikit-surgerycore",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "medical imaging",
"author": "Steve Thompson",
"author_email": "s.thompson@ucl.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/37/42/621adb229bac56d4f98b5fe245020db904e5377888ddfd0c954ef821c9a0/scikit-surgerycore-0.7.2.tar.gz",
"platform": null,
"description": "scikit-surgerycore\n===============================\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgerycore/raw/master/skscore_logo.png\n :height: 200px\n :target: https://github.com/SciKit-Surgery/scikit-surgerycore\n :alt: Logo\n\n| \n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgerycore/workflows/.github/workflows/ci.yml/badge.svg\n :target: https://github.com/SciKit-Surgery/scikit-surgerycore/actions\n :alt: GitHub Actions CI status\n\n.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgerycore/badge.svg?branch=master&service=github\n :target: https://coveralls.io/github/SciKit-Surgery/scikit-surgerycore?branch=master\n :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/scikit-surgerycore/badge/?version=latest\n :target: http://scikit-surgerycore.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\nDescription\n-----------\n\nSciKit-SurgeryCore implements algorithms and tools that are common to all SciKit-Surgery packages.\n\nSciKit-SurgeryCore 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\n.. features-start\n\nFeatures\n--------\n\n* A `Configuration Manager <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.configuration.configuration_manager>`_ to load parameters from a .json file\n* A `Transform Manager <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.transforms.transform_manager>`_ to manage combinations of 4x4 transformation matrices\n* `Corresponding point <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.algorithms.procrustes>`_ (i.e Landmark) based registration, based on `Arun et al., 1987`_.\n* `Rotaiton/translation Matrix construction <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#module-sksurgerycore.transforms.matrix>`_ and `validation functions <https://scikit-surgerycore.readthedocs.io/en/latest/module_ref.html#matrix-validation>`_, \n checking a numpy array is a camera matrix, rotation matrix, rigid transform etc.\n\n.. features-end\n\nCiting\n------\nIf you make use of SciKit-Surgery libraries in your work, please cite the following paper:\n\n\n | Thompson S, Dowrick T, Ahmad M, et al.\n | SciKit-Surgery: compact libraries for surgical navigation.\n | International Journal of Computer Assisted Radiology and Surgery. May 2020. \n | DOI: 10.1007/s11548-020-02180-5\n\n\nInstalling\n----------\n\nYou can pip install as follows:\n\n::\n\n pip install scikit-surgerycore\n\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-surgerycore.git\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\n\nContributing\n^^^^^^^^^^^^\n\nPlease see the `contributing guidelines`_.\n\nUseful links\n^^^^^^^^^^^^\n\n* `Source code repository`_\n* `Documentation`_\n\n\nLicensing and copyright\n-----------------------\n\nCopyright 2018 University College London.\nscikit-surgerycore 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-surgerycore\n.. _`Documentation`: https://scikit-surgerycore.readthedocs.io\n.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery/\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-surgerycore/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgerycore/blob/master/LICENSE\n.. _`Arun et al., 1987`: http://doi.ieeecomputersociety.org/10.1109/TPAMI.1987.4767965\n",
"bugtrack_url": null,
"license": "BSD-3 license",
"summary": "scikit-surgerycore contains commonly used Image Guided Surgery algorithms and tools",
"version": "0.7.2",
"project_urls": {
"Homepage": "https://github.com/SciKit-Surgery/scikit-surgerycore"
},
"split_keywords": [
"medical",
"imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3742621adb229bac56d4f98b5fe245020db904e5377888ddfd0c954ef821c9a0",
"md5": "a64c20ddfba7f8fc479bf5e17a61cc72",
"sha256": "1793a2012ab9570fdda91e231e6dd5d429e8f16c5cc57b2c3e4084ccff7be967"
},
"downloads": -1,
"filename": "scikit-surgerycore-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "a64c20ddfba7f8fc479bf5e17a61cc72",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43730,
"upload_time": "2024-04-12T10:47:22",
"upload_time_iso_8601": "2024-04-12T10:47:22.016705Z",
"url": "https://files.pythonhosted.org/packages/37/42/621adb229bac56d4f98b5fe245020db904e5377888ddfd0c954ef821c9a0/scikit-surgerycore-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 10:47:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SciKit-Surgery",
"github_project": "scikit-surgerycore",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "scikit-surgerycore"
}
JSON
