Skip to main content

scikit-surgeryutils - Tests/demos utilities, based around opencv-contrib-python-headless and PySide6

Project description

Logo

GitHub Actions CI statuss Test coverage Documentation Status https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg Follow scikit_surgery on twitter

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.

Acknowledgements

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.

Source Distribution

scikit_surgeryutils-2.4.0.tar.gz (50.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scikit_surgeryutils-2.4.0-py2.py3-none-any.whl (49.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file scikit_surgeryutils-2.4.0.tar.gz.

File metadata

  • Download URL: scikit_surgeryutils-2.4.0.tar.gz
  • Upload date:
  • Size: 50.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scikit_surgeryutils-2.4.0.tar.gz
Algorithm Hash digest
SHA256 465fd6d31c7dc031d5ddb0686065e05c10e5c9b966e3a40f9693a88ac6f23c5d
MD5 31dfb03debffbbdf610118f556b1929c
BLAKE2b-256 6e8e6dc96049430813b6a30c0db91b4ca026ee100076c33fce8b9b5da5308113

See more details on using hashes here.

Provenance

The following attestation bundles were made for scikit_surgeryutils-2.4.0.tar.gz:

Publisher: ci.yml on SciKit-Surgery/scikit-surgeryutils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scikit_surgeryutils-2.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for scikit_surgeryutils-2.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a654a745b87a3fa22e28fb1d562845e7fa625d90a24ae3b9745e1026077aea3e
MD5 6009be1da8ae12509c99afbcf0de7692
BLAKE2b-256 7bac098936a95332feedcb8db67012e03655001b69a495c45401778d9247bcc8

See more details on using hashes here.

Provenance

The following attestation bundles were made for scikit_surgeryutils-2.4.0-py2.py3-none-any.whl:

Publisher: ci.yml on SciKit-Surgery/scikit-surgeryutils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page