Skip to main content

scikit-surgerytorsosimulator has been superseded by snappysonic"

Project description

Logo GitHub Actions CI status Test coverage Documentation Status The SnappySonic Paper Software DOI Maintainability 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 --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



You can clone the repository using the following command:

git clone

Running tests

Unit tests are performed in stand alone environments using tox, which also checks coding style.



You can pip install from pypi with

pip install snappysonic

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

pip install git+

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:


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
Filename, size File type Python version Upload date Hashes
Filename, size scikit_surgerytorsosimulator- (10.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size scikit-surgerytorsosimulator- (22.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page