Skip to main content

image2image

License PyPI Python Version CI codecov

Explore, align, and prepare scientific images in one place.

image2image is a desktop toolkit for visualizing and registering whole-slide images, microscopy data, and imaging mass spectrometry datasets. It brings a collection of focused applications together behind one launcher, so you can move from inspection to registration to export without changing tools.

The image2image application launcher

Why image2image?

  • See multiple modalities together. Overlay images, channels, masks, and point data in a shared viewer, with per-dataset scaling and transformations.
  • Register images interactively. Create affine registrations with fiducial points, preview the result, and save reusable transformation files.
  • Register whole-slide images. Build Elastix or Valis workflows with preprocessing, masks, registration paths, and batch execution.
  • Prepare data for downstream tools. Convert images to OME-TIFF, crop or mask regions, merge channels or files, and export fusion-compatible data.
  • Work from the GUI or command line. Use the launcher for a guided workflow, or invoke individual applications from a terminal.

Applications at a glance

Application Use it for Launch command
Viewer Overlay images, channels, masks, points, and transformations i2viewer
Register Manually align two images with fiducial markers i2register
Elastix Register whole-slide images with Elastix workflows i2elastix
Valis Register whole-slide images with Valis workflows image2image -t valis
Runner Queue and review multiple registration projects i2runner
Convert Convert supported microscopy formats to OME-TIFF i2convert
Crop Crop or mask one or more images i2crop
Merge Combine channels or image files image2image -t merge
Fusion Export data for the MATLAB fusion application image2image -t fusion

The default image2image command opens the launcher, where all available applications can be started.

Install

image2image requires Python 3.11 or newer. Install it from PyPI with a Qt backend, then start the launcher:

python -m pip install "image2image[pyqt6]"
image2image

If you prefer another supported Qt binding, replace pyqt6 with pyside6, pyqt5, or pyside2.

For packaged application builds and release notes, see the GitHub Releases page.

A typical workflow

  1. Open the Viewer to inspect your images and confirm their pixel sizes.
  2. Use Register to create an affine transformation between two modalities, or choose Elastix or Valis for whole-slide registration.
  3. Review the alignment and export the resulting images or transformation files.
  4. Use Crop, Convert, or Merge to prepare the final data for analysis or sharing.

The image2image viewer The image2image registration app

Documentation

Development

Clone the repository and install the project with its development tools:

git clone https://github.com/vandeplaslab/image2image.git
cd image2image
python -m pip install -e "[pyqt6,dev]"

Contributions are welcome. Please open an issue for a bug report or feature request, or submit a pull request with a focused change and relevant tests.

License

image2image is released under the BSD 3-Clause License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

image2image-0.3.1.tar.gz (361.3 kB view details)

Uploaded Source

Built Distribution

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

image2image-0.3.1-py3-none-any.whl (392.0 kB view details)

Uploaded Python 3

File details

Details for the file image2image-0.3.1.tar.gz.

File metadata

  • Download URL: image2image-0.3.1.tar.gz
  • Upload date:
  • Size: 361.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for image2image-0.3.1.tar.gz
Algorithm Hash digest
SHA256 32d2f8df0c6e3db85b944b1795fd3ea8151c0c3e758b745b18013d6bc4ec6b9e
MD5 1114cb57ca077ea53e551fec4dc5afbd
BLAKE2b-256 eb63d7b6b3bd1d0d3f10b85bcb5a7964167c17f326a9310f378f5099b4b17467

See more details on using hashes here.

File details

Details for the file image2image-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: image2image-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 392.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for image2image-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1704ce83a4edb6680b1b53a0d00e019cbaee33d2ddb39534db873e1caf2d6d1d
MD5 70d1bab2289a676965c173aee8f3ac83
BLAKE2b-256 65ecba0922980766f67c4e54bb5f6a0cdfe2b90f57171dafcdbe3af15e6f8d65

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 files

0.3.0

2 files

0.2.3

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page