scikit-surgeryimage


Namescikit-surgeryimage JSON
Version 0.10.1 PyPI version JSON
download
home_pagehttps://github.com/SciKit-Surgery/scikit-surgeryimage
Summaryscikit-surgeryimage implements image processing tools and alogrithms for Image Guided Surgery.
upload_time2022-03-22 10:17:32
maintainer
docs_urlNone
authorStephen Thompson
requires_python
licenseBSD-3 license
keywords medical imaging
VCS
bugtrack_url
requirements numpy opencv-contrib-python-headless scikit-surgerycore
Travis-CI No Travis.
coveralls test coverage
            scikit-surgeryimage
====================

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

|

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

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

.. image:: https://readthedocs.org/projects/scikit-surgeryimage/badge/?version=latest
    :target: http://scikit-surgeryimage.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/url?style=social&url=http%3A%2F%2Fscikit-surgery.org
   :target: https://twitter.com/intent/tweet?screen_name=scikit_surgery&ref_src=twsrc%5Etfw
   :alt: Get in touch via twitter

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




scikit-surgeryimage is a python only project to implement image processing algorithms
that are useful for image-guided surgery.

scikit-surgeryimage was developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_ in `University College London (UCL)`_.

.. features-start

Features
--------

requirements.txt specifies a dependency on opencv-contrib-python-headless, so you can use any OpenCV python therein.
In addition, this project provides:

* `Convenience classes <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#data-acquisition>`_ for video read and write.
* `Utilities <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#calibration-tools>`_ to detect the number of cameras and prepare text for overlay on video.
* A `PointDetector <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#utilities>`_ interface for video camera calibration and implementations such as OpenCV chessboard, ArUco, ChArUco and combinations.
* Generate `ChArUco <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#sksurgeryimage.calibration.charuco.make_charuco_board>`_ patterns
* `Interlacing and deinterlacing <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#video-interlacing-functions>`_.
* Convenience wrappers for `erosion and dilation <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#module-sksurgeryimage.processing.morphological_operators>`_.

.. features-end

Installing
~~~~~~~~~~

You can pip install directly from the repository as follows:
::

    pip install scikit-surgeryimage


Developing
^^^^^^^^^^

You can clone the repository using the following command:

::

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


Running the tests
^^^^^^^^^^^^^^^^^

You can run the unit tests by installing and running tox:

    ::

      pip install tox
      tox

Encountering Problems?
^^^^^^^^^^^^^^^^^^^^^^
Please check list of `common issues`_.

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

Please see the `contributing guidelines`_.


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

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


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

Copyright 2018 University College London.
scikit-surgeryimage 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-surgeryimage
.. _`Documentation`: https://scikit-surgeryimage.readthedocs.io
.. _`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-surgeryimage/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgeryimage/blob/master/LICENSE
.. _`common issues`: https://github.com/SciKit-Surgery/scikit-surgery/wikis/Common-Issues
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/SciKit-Surgery/scikit-surgeryimage",
    "name": "scikit-surgeryimage",
    "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/d2/02/61f1bde9f9b1c6e485f3f26a996adacfb797b0e281597da23200cb4873e3/scikit-surgeryimage-0.10.1.tar.gz",
    "platform": null,
    "description": "scikit-surgeryimage\n====================\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgeryimage/raw/master/weiss_logo.png\n   :height: 128px\n   :width: 128px\n   :target: https://github.com/SciKit-Surgery/scikit-surgeryimage\n   :alt: Logo\n\n|\n\n.. image:: https://github.com/SciKit-Surgery/scikit-surgeryimage/workflows/.github/workflows/ci.yml/badge.svg\n   :target: https://github.com/SciKit-Surgery/scikit-surgeryimage/actions\n   :alt: GitHub Actions CI status\n\n.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgeryimage/badge.svg?branch=master&service=github\n    :target: https://coveralls.io/github/SciKit-Surgery/scikit-surgeryimage?branch=master\n    :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/scikit-surgeryimage/badge/?version=latest\n    :target: http://scikit-surgeryimage.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/url?style=social&url=http%3A%2F%2Fscikit-surgery.org\n   :target: https://twitter.com/intent/tweet?screen_name=scikit_surgery&ref_src=twsrc%5Etfw\n   :alt: Get in touch via twitter\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\n\n\n\nscikit-surgeryimage is a python only project to implement image processing algorithms\nthat are useful for image-guided surgery.\n\nscikit-surgeryimage was developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_ in `University College London (UCL)`_.\n\n.. features-start\n\nFeatures\n--------\n\nrequirements.txt specifies a dependency on opencv-contrib-python-headless, so you can use any OpenCV python therein.\nIn addition, this project provides:\n\n* `Convenience classes <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#data-acquisition>`_ for video read and write.\n* `Utilities <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#calibration-tools>`_ to detect the number of cameras and prepare text for overlay on video.\n* A `PointDetector <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#utilities>`_ interface for video camera calibration and implementations such as OpenCV chessboard, ArUco, ChArUco and combinations.\n* Generate `ChArUco <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#sksurgeryimage.calibration.charuco.make_charuco_board>`_ patterns\n* `Interlacing and deinterlacing <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#video-interlacing-functions>`_.\n* Convenience wrappers for `erosion and dilation <https://scikit-surgeryimage.readthedocs.io/en/latest/module_ref.html#module-sksurgeryimage.processing.morphological_operators>`_.\n\n.. features-end\n\nInstalling\n~~~~~~~~~~\n\nYou can pip install directly from the repository as follows:\n::\n\n    pip install scikit-surgeryimage\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-surgeryimage\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\nEncountering Problems?\n^^^^^^^^^^^^^^^^^^^^^^\nPlease check list of `common issues`_.\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 2018 University College London.\nscikit-surgeryimage 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-surgeryimage\n.. _`Documentation`: https://scikit-surgeryimage.readthedocs.io\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-surgeryimage/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgeryimage/blob/master/LICENSE\n.. _`common issues`: https://github.com/SciKit-Surgery/scikit-surgery/wikis/Common-Issues",
    "bugtrack_url": null,
    "license": "BSD-3 license",
    "summary": "scikit-surgeryimage implements image processing tools and alogrithms for Image Guided Surgery.",
    "version": "0.10.1",
    "project_urls": {
        "Homepage": "https://github.com/SciKit-Surgery/scikit-surgeryimage"
    },
    "split_keywords": [
        "medical",
        "imaging"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d20261f1bde9f9b1c6e485f3f26a996adacfb797b0e281597da23200cb4873e3",
                "md5": "dc933f4ed42b3fa794fc3c86bf907766",
                "sha256": "0886dbbf136909027dd8748b75cd6d3f0424b4ac69ce96dd5afc9d55af512f1d"
            },
            "downloads": -1,
            "filename": "scikit-surgeryimage-0.10.1.tar.gz",
            "has_sig": false,
            "md5_digest": "dc933f4ed42b3fa794fc3c86bf907766",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 44771,
            "upload_time": "2022-03-22T10:17:32",
            "upload_time_iso_8601": "2022-03-22T10:17:32.801319Z",
            "url": "https://files.pythonhosted.org/packages/d2/02/61f1bde9f9b1c6e485f3f26a996adacfb797b0e281597da23200cb4873e3/scikit-surgeryimage-0.10.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-03-22 10:17:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SciKit-Surgery",
    "github_project": "scikit-surgeryimage",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "opencv-contrib-python-headless",
            "specs": [
                [
                    ">=",
                    "4.2.0.32"
                ]
            ]
        },
        {
            "name": "scikit-surgerycore",
            "specs": [
                [
                    ">=",
                    "0.1.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "scikit-surgeryimage"
}
        
Elapsed time: 0.06663s