Skip to main content

Registration of 3D movies applied to all channels

Project description

napari-3dtimereg

License BSD-3 PyPI Python Version napari hub

Temporal registration of 2D/3D movies on one channel based on itk-elastix, and transpose alignement to the other channels.

Adaptated from multireg for temporal movies. For a tutorial on using elastix for registration, see this tutorial.


Installation

  • You can install the plugin directly in Napari by going to Plugins>Install/Uninstall plugins and search for napari-3dtimereg

  • Or you can install napari-3dtimereg via pip:

    pip install napari-3dtimereg

Usage

You can launch 3dtimereg in napari by going to Plugins>Do 3D movie registration (napari-3dtimereg).

Choose movie and reference chanel

First, choose select the movie that you want to register. The plugin will create a folder aligned in the folder of your selected movie where the results will be saved.

Choose the color chanel on which to calculate the registration (reference chanel). Color chanels are numbered from 0 to nchanels, and you can see their respective number in the layer list on the left panel of Napari. Click on Update when the correct chanel is selected to go to the registration calculation step.

Calculate temporal alignement

The registration is calculated iteratively from one frame to another. Thus the first frame is not moved and all the other frames are aligned to it. You can tune several parameters in this plugin:

parameters screenshot

The other parameters are parameters to use itk-elastix to calculate the registration.

  • show log: to see the log of Elastix calculation
  • do rigid: performs a rigid (affine) transformation step, that allowed to correct for translations/rotations.
  • do bspline: performs a b-spline based transformation step, that allowed for local deformations in the image.
  • show advanced parameters: to control the parameters used in the rigid and/or bspline transformations. These parameters control the size of the local registrations calculated, the resolutions at which the transformations are calculated, and can thus greatly impact the results.
  • final order: is the final order of the B-Splines used for the registration.
  • resolution: is the number of consecutives resolutions at which the registration will be made. First the registration is made at the lowest level of resolution, correcting global deformations/motions, then at each step, the registration is done on higher resolution, allowing to correct for more local deformations.
  • final spacing: is the physical spacing of the smallest resolution.
  • iterations: are the maximum number of iterations allowed to minimize the distance between the two images for each resolution and type of registration.

If both rigid and bspline transformations, the program first applies the rigid transformation to allow for a global registration of the images. Then it will performs the second step of b-spline transformation that can includes local deformations.

For each frame, after calculating the registration on the reference chanel, the plugin will apply the calculated transformation to all the other color chanels of the initial movie. All results are saved as separated images in the aligned folder during the computation.

Create the final aligned movie

When all frames have been processed, each color chanel and each frame have been saved in the aligned folder as separated images. This is usefull to calculate the registration on large movies without having to keep all the intermediates and calculated images in memory. You can directly use these separated images, or reconstruct a single composite movie of the result.

If you click on Concatenate aligned images on the plugin interface, the plugin will create a single composite movie from the aligned images, save it and delete the separated images in the aligned folder.

License

Distributed under the terms of the BSD-3 license, "napari-3dtimereg" is free and open source software

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

napari_3dtimereg-0.0.11.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

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

napari_3dtimereg-0.0.11-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file napari_3dtimereg-0.0.11.tar.gz.

File metadata

  • Download URL: napari_3dtimereg-0.0.11.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for napari_3dtimereg-0.0.11.tar.gz
Algorithm Hash digest
SHA256 e99804a89da1d7b2ebd57700f5ca6860bf2e6521e127e7a1ef23ec4c4b06bca3
MD5 6cbe97b2a75e2c9611bbbd1491cd8d3d
BLAKE2b-256 2cd8f33e0518c1a8245fdcba7ec04aeaafa8975593940321809fa5d36dfe27d7

See more details on using hashes here.

File details

Details for the file napari_3dtimereg-0.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_3dtimereg-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 1f4837b65fbe8cc23d552be06b3952bd37bc5db7290691ef780afe351f393f7e
MD5 d939a1f81eb1b60b7ce7bd7a67dd7f23
BLAKE2b-256 53f12fac6ef4a588e1559621e1c991c283fbef6c09ba4140e49aed469dd74651

See more details on using hashes here.

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