Skip to main content

A napari plugin for manual registration of (a part of) an image

Project description

Partial-Aligner

License PyPI Python Version

A napari plugin to affine transform images and parts of images in 2D and 3D. It was developed in the context of brain slice registration and solves multiple, related problems when working with histology slices.


Installation

You can install Partial-Aligner via pip:

pip install Partial-Aligner

To make full use of this plugin, please also install the sister plugins:

pip install Label-Creator
pip install Layer-Data-Replace
pip install World2Data

Usage

It is important to note that this plugin is part of a group of plugins (Label-Creator, Layer-Data-Replace, World2Data) which are intended to be used together.

The principle workflow with this plugin is as follows:

  1. Load an image of interest (ioi) using standard napari.
  2. Find out meaningful transformation parameters for the ioi (or part of it) based on what you see in the viewer.
  3. (optional) Save the affine transformation matrix (can later be applied to other modalities)
  4. Apply the transformation to create a new, altered version of the ioi (use plugin World2Data)

Decisions on the parameters (step 2) are made based on the problem at hand:

  • Registration: You have a second (fixed) image and you want to align your ioi to that image? Transform your whole ioi! Just play with the transformation parameters until you are happy with the alignment of ioi and fixed image.


DAPI staining (red) before (left) and after (right) manual registration on an MRI image (green).

  • Histology artifact repair: Parts of your histology slice are misplaced? Transform the misplaced parts! Label them and change the transformation parameters for the misplaced parts until you are happy with their alignment with the rest of the image.


Original slice with misplaced region (left), marked using the label function (middle) and after manual adjustment (right), where the misplaced region (green) was cut and newly positioned.

To make this plugin run reasonably fast, the affine transformations are not applied to the image data in real time. Instead, the internal napari viewing parameters are changed according to the transformation parameters. Therefore, to save transformed image data, the World2Data plugin is used, which calculates and saves the resulting image based on the internal napari viewing parameters.

Here we showcase a resulting multimodal 3D alignment of a whole mouse brain. The modalities are CT, MRI, simulated radiation dose distributions, DAPI staining and DNA-damage repair foci, with a Nissl-staining mouse atlas as template.

https://user-images.githubusercontent.com/36212786/149530462-51a53631-bf74-459b-ab4e-572c52cf2692.mov

Contributing

Contributions are very welcome. Tests can be run with tox.

License

Distributed under the terms of the BSD-3 license, "Partial-Aligner" is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

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

Partial-Aligner-0.0.1.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

Partial_Aligner-0.0.1-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file Partial-Aligner-0.0.1.tar.gz.

File metadata

  • Download URL: Partial-Aligner-0.0.1.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for Partial-Aligner-0.0.1.tar.gz
Algorithm Hash digest
SHA256 cd4631241785b4cbc320aac9d8b7c380f9a21e6c59a6005e92258784b390b836
MD5 ba1afde7c282fcd7f44cd8f0ab1cd9cc
BLAKE2b-256 1acd903a9ec86e5e6ac08ad7e40f9b1e7ee74f0f6c47d66effd04bad318ecfef

See more details on using hashes here.

File details

Details for the file Partial_Aligner-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: Partial_Aligner-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for Partial_Aligner-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e0a80b233ee814dd635be5d918d0e38ef470b7e5aa3d5b84edcad4fc4fc914d
MD5 5152f4ea3073ca1f321e6880aa02be96
BLAKE2b-256 14bea7b9afabccb9560a9b48d9c95dd854a88c81fb3c23e9f1ed52c86c48ca83

See more details on using hashes here.

Supported by

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