Author(s): Miguel Xochicale, Thomas Dowrick, Stephen Thompson and Matt Clarkson; Contributor(s): Mian Ahmad.
scikit-surgeryutils containing small demo apps and utilities.
scikit-surgeryutils 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).
scikit-surgeryvtk is tested on Python 3.8. and may support other Python versions.
Features
Common overlay apps - Examples of common uses of scikit-surgeryvtk’s VTKOverlayWindow. Includes overlaying on a video feed, duplicating a feed.
Command line applications
Open a terminal, load your virtual environment and run the application as python sk*.py.
sksurgeryvideolag.py - shows a millisecond timer and video image to crudely measure measure lag.
sksurgerycharucotest.py - extracts charuco points and annotates video image with each id detected.
sksurgeryrendermodelslikecamera.py - renders a VTK model, over background image, using OpenCV camera intrinsics.
sksurgerymakecalibrationdots.py - Create a calibraiton dot pattern.
sksurgeryreslice.py - DICOM reslice widget demo.
sksurgerytextoverlay.py - VTK text overlay demo.
sksurgerytransformpolydata.py - Read a surface mesh (.vtk,.vtp,.stl,.ply file), transform by 4x4 matrix and write as .vtk.
sksurgerystereorenderer.py - Reads a set of meshes, overlays on stereo video. Documentation.
Installing
You can pip install directly from the repository as follows:
pip install git+https://github.com/SciKit-Surgery/scikit-surgeryutils
Developing
Cloning
You can clone the repository using the following command:
git clone https://github.com/SciKit-Surgery/scikit-surgeryutils
Installing the dependencies, running the tests
You can install dependencies and run the unit tests by installing and running tox:
pip install tox tox tox -e docs tox -e lint
Tox will create a separate venv in .tox/test. See tox.ini for commands that tox runs.
Encountering Problems?
Please get in touch or raise an issue.
Contributing
Please see the contributing guidelines.
Useful links
Licensing and copyright
Copyright 2018 University College London. scikit-surgeryutils is released under the BSD-3 license. Please see the license file for details.
Acknowledgements
2 maintainers
Release files for scikit-surgeryutils 2.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scikit_surgeryutils-2.4.0.tar.gz | 50.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scikit_surgeryutils-2.4.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 99.8 kB
Release files / scikit_surgeryutils-2.4.0.tar.gz
| Download URL | scikit_surgeryutils-2.4.0.tar.gz |
|---|---|
| Size | 50.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
465fd6d31c7dc031d5ddb0686065e05c10e5c9b966e3a40f9693a88ac6f23c5d
|
|
BLAKE2b-256 checksum How to use checksums |
6e8e6dc96049430813b6a30c0db91b4ca026ee100076c33fce8b9b5da5308113
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 11, 2026.
Transparency logRelease files / scikit_surgeryutils-2.4.0-py2.py3-none-any.whl
| Download URL | scikit_surgeryutils-2.4.0-py2.py3-none-any.whl |
|---|---|
| Size | 49.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a654a745b87a3fa22e28fb1d562845e7fa625d90a24ae3b9745e1026077aea3e
|
|
BLAKE2b-256 checksum How to use checksums |
7bac098936a95332feedcb8db67012e03655001b69a495c45401778d9247bcc8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 11, 2026.
Transparency log
