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.3.0.tar.gz (47.7 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.3.0-py2.py3-none-any.whl (46.3 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: scikit_surgeryutils-2.3.0.tar.gz
  • Upload date:
  • Size: 47.7 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.3.0.tar.gz
Algorithm Hash digest
SHA256 c7e067a7ba2caf3fb54a7f4d4938f52adf686494d9f9b41370c87b91ccfc3f49
MD5 a5e02eeecddbcd9a26477132115c2e86
BLAKE2b-256 8f0e6f5c40fbfc08cdae669e38f7ec3f267664b4022184fae957d20403378299

See more details on using hashes here.

Provenance

The following attestation bundles were made for scikit_surgeryutils-2.3.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.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for scikit_surgeryutils-2.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 af350b9d7a1146787db0c3a195470ef59a3907c7b94bc3b2c1758eb7190fad97
MD5 cbecdb08c054d9ad4ba74609ecc6ffb1
BLAKE2b-256 3ebec01a52f37ff0689f7860fed42a293c673fe8c91442214e046b588aa1c429

See more details on using hashes here.

Provenance

The following attestation bundles were made for scikit_surgeryutils-2.3.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