Skip to main content
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 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.

Acknowledgements

Supported by Wellcome and EPSRC.

Metadata

Release files for scikit-surgerytorsosimulator 0.0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scikit-surgerytorsosimulator 0.0.6.1
File Size Uploaded
scikit-surgerytorsosimulator-0.0.6.1.tar.gz 22.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scikit-surgerytorsosimulator 0.0.6.1
File Interpreter ABI Platform
scikit_surgerytorsosimulator-0.0.6.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 32.5 kB

Release files / scikit-surgerytorsosimulator-0.0.6.1.tar.gz

Download URL scikit-surgerytorsosimulator-0.0.6.1.tar.gz
Size 22.1 kB
Tags Source
SHA-256 checksum
How to use checksums
534034d067af13c0fd5f2648cf6260ed941449d0f6b2d4ec18a16f3640ed9088
BLAKE2b-256 checksum
How to use checksums
cfbb5d8949d746651c0c5b7df2bcddbe9bff4797bd88077f7b36ea5872bab9fc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

Release files / scikit_surgerytorsosimulator-0.0.6.1-py2.py3-none-any.whl

Download URL scikit_surgerytorsosimulator-0.0.6.1-py2.py3-none-any.whl
Size 10.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a05af9e16399d8abde4c0aa4d5895c29f951f6aa6cafa828fceae6ca3186a3d0
BLAKE2b-256 checksum
How to use checksums
a9b77d0d826f601c87cde0635ebe7dfaaa1724a0b66f52b4ed7f3ae95c64e4a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

Release history Release notifications | RSS feed

This release

0.0.6.1 This release

2 release files

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page