Metadata-Version: 2.1
Name: scikit-surgerytorsosimulator
Version: 0.0.6.1
Summary: scikit-surgerytorsosimulator has been superseded by snappysonic"
Home-page: https://github.com/UCL/snappysonic
Author: Stephen Thompson
Author-email: s.thompson@ucl.ac.uk
License: BSD-3 license
Description: SnappySonic
        ===============================
        
        .. image:: https://github.com/UCL/snappysonic/raw/master/project-icon.png
           :height: 128px
           :width: 128px
           :target: https://github.com/UCL/snappysonic
           :alt: Logo
        
        .. image:: https://github.com/UCL/snappysonic/workflows/.github/workflows/ci.yml/badge.svg
           :target: https://github.com/UCL/snappysonic/actions
           :alt: GitHub Actions CI status
        
        .. image:: https://coveralls.io/repos/github/UCL/snappysonic/badge.svg?branch=master&service=github
            :target: https://coveralls.io/github/UCL/snappysonic?branch=master 
            :alt: Test coverage
        
        .. image:: https://readthedocs.org/projects/snappysonic/badge/?version=latest
            :target: http://snappysonic.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/badge/DOI-10.5334%2Fjors.289-blue
            :target: http://doi.org/10.5334/jors.289
            :alt: The SnappySonic Paper
        
        .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3491054.svg
           :target: https://doi.org/10.5281/zenodo.3491054
           :alt: Software DOI
        
        .. image:: https://api.codeclimate.com/v1/badges/326c1b87863bd61bbe83/maintainability
           :target: https://codeclimate.com/github/UCL/snappysonic/maintainability
           :alt: Maintainability
        
        .. image:: https://img.shields.io/badge/-Video%20Tutorial-blueviolet?style=flat&logo=youtube
           :target: https://www.youtube.com/watch?v=BI4qyg9NEOk
           :alt: Tutorial on YouTube
        
        
        
        Author: Stephen Thompson
        
        SciKit-SurgeryTorsoSimulator has been superseded by SnappySonic.
        
        SnappySonic can be used as an ultrasound acquisition simulator. The output from a tracking system (NDI or AruCo tags) is to select a frame of pre-recorded video to show. A suitable video of ultrasound data is included in the data directory, however the user can select a video of their choosing. The software and its use is described in the `SnappySonic paper`_. 
        
        SnappySonic 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)`_.
        
        SnappySonic supports Python 3.6.
        
        ::
         
            pip install snappysonic
            python snappysonic.py --config config.json
        
        The config file defines the tracking parameters and image buffer, e.g.
        
        ::
        
          {
           "ultrasound buffer": "data/usbuffer.mp4",
        	 "buffer descriptions": [
        		{
        		 "name": "glove",
        		 "start frame": 0,
        		 "end frame": 284,
        		 "x0": 20, "x1": 200,
        		 "y0": 200, "y1": 260,
        		 "scan direction": "x"
        		},
            ]
            ....
            "tracker config": {
        		"tracker type": "aruco",
        		"video source": 2,
        		"debug": true,
        		"capture properties": {
        			"CAP_PROP_FRAME_WIDTH": 640,
        			"CAP_PROP_FRAME_HEIGHT": 480
        		
           }
          }
        
        An example configuration file can be downloaded from `here`_ and an image buffer from `source code repository data directory`_
        
        Developing
        ----------
        
        Cloning
        ^^^^^^^
        
        You can clone the repository using the following command:
        
        ::
        
            git clone https://github.com/UCL/snappysonic
        
        
        Running tests
        ^^^^^^^^^^^^^
        Unit tests are performed in stand alone environments using tox, which also checks coding style.
        ::
        
            tox
        
        
        Installing
        ----------
        
        You can pip install from pypi with
        ::
        
          pip install snappysonic
        
        or You can pip install directly from the repository as follows:
        ::
        
            pip install git+https://github.com/UCL/snappysonic
        
        How to Cite
        -----------
        If you use this software in your research or teaching, please cite:
        
        Thompson, S., Dowrick, T., Xiao, G., Ramalhinho, J., Robu, M., Ahmad, M., Taylor, D. and Clarkson, M.J., 2020. SnappySonic: An Ultrasound Acquisition Replay Simulator. Journal of Open Research Software, 8(1), p.8. DOI: http://doi.org/10.5334/jors.289
        
        Contributing
        ^^^^^^^^^^^^
        
        Please see the `contributing guidelines`_.
        
        
        Useful links
        ^^^^^^^^^^^^
        
        * `Source code repository`_
        * `Documentation`_
        
        
        Licensing and copyright
        -----------------------
        
        Copyright 2019 University College London.
        snappysonic 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/snappysonic
        .. _`here`: https://github.com/UCL/snappysonic/config.json
        .. _`source code repository data directory`: https://github.com/UCL/snappysonic/data
        .. _`Documentation`: https://snappysonic.readthedocs.io
        .. _`SciKit-Surgery`: https://github.com/UCL/scikit-surgery/wikis/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/UCL/snappysonic/blob/master/CONTRIBUTING.rst
        .. _`license file`: https://github.com/UCL/snappysonic/blob/master/LICENSE
        .. _`SnappySonic paper`: http://doi.org/10.5334/jors.289
        
Keywords: medical imaging education
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 :: 3
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Description-Content-Type: text/x-rst
