Skip to main content

SnappySonic

Logo

GitHub Actions CI status Test coverage Documentation Status The SnappySonic Paper Maintainability Tutorial on YouTube Follow scikit_surgery on twitter

Author: Stephen Thompson

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/SciKit-Surgery/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/SciKit-Surgery/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.

Release files for snappysonic 0.0.8

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

Source distribution (sdist)

Source distribution for snappysonic 0.0.8
File Size Uploaded
snappysonic-0.0.8.tar.gz 27.0 kB Details

Built distribution (wheel)

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

Total release size: 43.0 kB

Release files / snappysonic-0.0.8.tar.gz

Download URL snappysonic-0.0.8.tar.gz
Size 27.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1219753ef568dd8d609985566d18bd77de375a92782daf96267072b593291eb0
BLAKE2b-256 checksum
How to use checksums
a144d8c7df8d31ab241f284426429a09432513e92488861b73d6f20fbf5b97b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / snappysonic-0.0.8-py2.py3-none-any.whl

Download URL snappysonic-0.0.8-py2.py3-none-any.whl
Size 16.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
4d17def5bd29082507d764d1e0bb7360602e4e066a802df7b161fc1dbfd7dba2
BLAKE2b-256 checksum
How to use checksums
d8a1d3a7553738f18c51b34d6d4c765ec6a6c293f9281c11cafb6b77e51d0787
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release history Release notifications | RSS feed

This release

0.0.8 This release

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

1 release file

0.0.3

1 release file

0.0.2

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