https://github.com/snototter/imseqvis
Simple image sequence visualization GUI
https://github.com/snototter/imseqvis
gui image-processing python3 qt
Last synced: 4 months ago
JSON representation
Simple image sequence visualization GUI
- Host: GitHub
- URL: https://github.com/snototter/imseqvis
- Owner: snototter
- License: mit
- Created: 2023-07-26T20:50:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T10:30:44.000Z (over 1 year ago)
- Last Synced: 2025-11-27T18:23:50.834Z (7 months ago)
- Topics: gui, image-processing, python3, qt
- Language: Python
- Homepage:
- Size: 181 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Image & Sequence Visualization
[](https://pypi.org/project/imseqvis)
[](https://github.com/snototter/imseqvis/blob/main/LICENSE?raw=true)
This package provides GUI widgets to show images and play back image sequences.
### Installation
It is highly recommended to set up a separate virtual environment with an up-to-date `pip`:
```bash
python3 -m venv venv
source venv/bin/activate
python3 -m pip install -U pip
```
Then, simply install `imseqvis` via:
```bash
python3 -m pip install imseqvis
```
If you want to try the latest alpha, i.e. the latest `main` branch packaged and
published to [TestPyPI](https://test.pypi.org/), you can instead install it via:
```bash
python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple "imseqvis[pyside2]"
```
### Qt Backend
`imseqvis` requires a [Qt](https://www.qt.io/) backend. In Python, you need to
either install [PyQt](https://www.riverbankcomputing.com/software/pyqt/download)
or [PySide](https://doc.qt.io/qtforpython-6/).
The default installation **will not install** any of these backends, you have
to select one on your own.
Optionally, you can install `imseqvis` with a specific backend. Currently,
`pyqt5`, `pyqt6`, `pyside2`, and `pyside6` are supported:
```bash
# PyQt5
python3 -m pip install "imseqvis[pyqt5]"
# OR PyQt6
python3 -m pip install "imseqvis[pyqt6]"
# OR PySide2
python3 -m pip install "imseqvis[pyside2]"
# OR PySide6
python3 -m pip install "imseqvis[pyside6]"
```
In order to use PySide, the environmental variable `QT_DRIVER` should be set (as
this will be checked by `qimage2ndarray`). For example, to use `pyside6`:
```python
import os
os.environ['QT_DRIVER'] = 'PySide6'
...
imseqvis.show_sequence(...)
```
### Usage as Standalone Application
To quickly visualize all images within a folder or sequence (and nothing else),
you can use the provided wrappers to start a standalone GUI application:
```bash
python3 -m imseqvis path/to/image-folder
```
Or start the viewer from within your code, either specifically for a folder
or iterable image sequence (*i.e.* a random access container of NumPy [ndarrays](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html)):
```python
import imseqvis
# Show all images in the given folder.
imseqvis.show_folder('path/to/image-folder')
# Show all images in a random access container. For an exemplary data source
# refer to `imseqvis.sequence_viewer.ImageSequence`.
sequence = [...]
imseqvis.show_sequence(sequence)
```
Alternatively, you could simply use the provided `show` functionality:
```python
import imseqvis
imseqvis.show('path/to/image-folder')
sequence = [...]
imseqvis.show(sequence)
```
### Usage as Widget
To integrate the viewer into your own application, use the `ImageSequenceViewer`
widget:
```python
# Prepare the image data source. This must allow random access to the images.
# For an exemplary data source refer to
# `imseqvis.sequence_viewer.ImageSequence`.
sequence = [...]
# Create & use the widget.
viewer = SequenceViewer(image_sequence=sequence)
layout.addWidget(viewer)
...
# Alternatively, the widget can also be created without a data source:
viewer = SequenceViewer(image_sequence=None)
...
# Later on, the image sequence can be set via:
viewer.setSequence(new_sequence)
```
To show a different sequence within the same viewer, simply call:
```python
viewer.setSequence(new_sequence)
```
More detailed usage examples are provided within `examples/`. These also
demonstrate how to use the available signals to be notified of the user's
interactions with the viewer:
* `examples/demo_standalone.py` demonstrates the basic usage with a dummy
sequence.
* `examples/demo_folder.py` will playback all images within a local folder.