Skip to main content

scikit-surgerytorsosimulator provides an application to simulate an ultrasound probe moving over a body torso, it is intended for public engagement events"

Project description

Logo GitLab-CI test status Test coverage Documentation Status

Author: Stephen Thompson

scikit-torso-simulator is part of the SNAPPY software project, developed at the Wellcome EPSRC Centre for Interventional and Surgical Sciences, part of University College London (UCL).

scikit-torso-simulator supports Python 3.6.

snappy-torso-simulator uses out put from a tracking system (NDI or AruCo tags) to select a frame of video to show. It can be used to construct a simple to use ultrasound simulator.

python sksurgerytorsosimulator.py --config config.json

The config file defines the tracking parameters and image buffer, e.g.

{
 "ultrasound buffer": "data/usbuffer.mp4",
       "default image": "data/logo.png",
       "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://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgerytorsosimulator

Running tests

Pytest is used for running unit tests:

pip install pytest
python -m pytest

Linting

This code conforms to the PEP8 standard. Pylint can be used to analyse the code:

pip install pylint
pylint --rcfile=tests/pylintrc snappytorsosimulator

Installing

You can pip install directly from the repository as follows:

pip install git+https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgerytorsosimulator

Contributing

Please see the contributing guidelines.

Acknowledgements

Supported by Wellcome and EPSRC.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

scikit_surgerytorsosimulator-0.0.1-py2.py3-none-any.whl (15.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page