Metadata-Version: 2.1
Name: scikit-surgerycore
Version: 0.6.7
Summary: scikit-surgerycore contains commonly used Image Guided Surgery algorithms and tools
Home-page: https://github.com/UCL/scikit-surgerycore
Author: Matt Clarkson
Author-email: m.clarkson@ucl.ac.uk
License: BSD-3 license
Description: scikit-surgerycore
        ===============================
        
        .. image:: https://github.com/UCL/scikit-surgerycore /raw/master/weiss_logo.png
           :target: https://github.com/UCL/scikit-surgerycore
           :alt: Logo
        
        | 
        
        .. image:: https://github.com/UCL/scikit-surgerycore/workflows/.github/workflows/ci.yml/badge.svg
           :target: https://github.com/UCL/scikit-surgerycore/actions
           :alt: GitHub Actions CI status
        
        .. image:: https://coveralls.io/repos/github/UCL/scikit-surgerycore/badge.svg?branch=master&service=github
            :target: https://coveralls.io/github/UCL/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
        
        Description
        -----------
        
        scikit-surgerycore implements algorithms and tools that are common to all scikit-surgery packages.
        
        scikit-surgerycore is part of the `SNAPPY`_ 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/UCL/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/UCL/scikit-surgerycore
        .. _`Documentation`: https://scikit-surgerycore.readthedocs.io
        .. _`SNAPPY`: https://github.com/UCL/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/UCL/scikit-surgerycore/blob/master/CONTRIBUTING.rst
        .. _`license file`: https://github.com/UCL/scikit-surgerycore/blob/master/LICENSE
        .. _`Arun et al., 1987`: http://doi.ieeecomputersociety.org/10.1109/TPAMI.1987.4767965
        
Keywords: medical imaging
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Description-Content-Type: text/x-rst
