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



You can clone the repository using the following command:

git clone

Running tests

Pytest is used for running unit tests:

pip install pytest
python -m pytest


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

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


You can pip install directly from the repository as follows:

pip install git+


Please see the contributing guidelines.


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.

Files for scikit-surgerytorsosimulator, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size scikit_surgerytorsosimulator-0.0.1-py2.py3-none-any.whl (15.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page