Skip to content

SciKit-Surgery/imshowTk

Repository files navigation

imshowTk

Logo

GitHub CI test status Test coverage Documentation Status The SciKit-Surgery paper Follow scikit_surgery on twitter

Author: Stephen Thompson

imshowTk is a zero dependency alternative to opencv's imshow function. It was developed to allow us to show an image window when using opencv-headless and don't want to use a larger UI library. It uses tkinter which comes as standard in most Python installations.

imshowTk 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).

Basic use case

from from imshowtk.imshowtk import ImshowTk
imshow = ImshowTk()
frame = cv2.imread('project-icon.png')
imshow.imshow(frame)
del imshow

Developing

Cloning

You can clone the repository using the following command:

git clone https://github.com/SciKit-Surgery/imshowTk

Running tests

Pytest is used for running unit tests:

pip install pytest
python -m pytest

Linting

This code conforms to the PEP8 standard. Pylint can be used to analyse the code:

pip install pylint
pylint --rcfile=tests/pylintrc imshowtk

Installing

You can pip install directly from the repository as follows:

pip install git+https://github.com/SciKit-Surgery/imshowTk

Contributing

Please see the contributing guidelines.

Useful links

Licensing and copyright

Copyright 2023 University College London. imshowTk is released under the BSD-3 license. Please see the license file for details.

Acknowledgements

Supported by Wellcome and EPSRC.

About

A zero dependency alternative to cv2.imshow()

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages