Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guiwitz/microfilm

Creating figures and animations for multi-channel images with a focus on microscopy.
https://github.com/guiwitz/microfilm

matplotlib microscopy-images plotting

Last synced: about 8 hours ago
JSON representation

Creating figures and animations for multi-channel images with a focus on microscopy.

Awesome Lists containing this project

README 

        
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/guiwitz/microfilm/master?urlpath=lab)

[![build](https://github.com/guiwitz/microfilm/actions/workflows/test_build.yml/badge.svg)](https://github.com/guiwitz/microfilm/actions/workflows/test_build.yml)

![PyPI - License](https://img.shields.io/pypi/l/microfilm)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/microfilm)

![PyPI](https://img.shields.io/pypi/v/microfilm)

![PyPI - Status](https://img.shields.io/pypi/status/microfilm)

# microfilm



This package is a collection of tools to display and analyze 2D and 2D time-lapse microscopy images. In particular it makes it straightforward to create figures containing multi-channel images represented in a *composite* color mode as done in the popular image processing software [Fiji](https://imagej.net/software/fiji/). It also allows to easily complete such figures with standard annotations like **labels** and **scale bars**. In case of time-lapse data, the figures are turned into **animations** which can be interactively browsed from a Jupyter notebook, saved in standard movie formats (mp4, gif etc.) and completed with **time counters**. Finally, figures and animations can easily be combined into larger **panels**. These main functionalities are provided by the ```microfilm.microplot``` and ```microfilm.microanim``` modules.



Following the model of [seaborn](https://seaborn.pydata.org/index.html), ```microfilm``` is entirely based on [Matplotlib](https://matplotlib.org/) and tries to provide good defaults to produce good microcopy figures *out-of-the-box*. It however also offers complete access to the Matplotlib structures like axis and figures underlying the ```microfilm``` objects, allowing thus for the creation of arbitrarily complex plots.



## Installation



You can install this package directly with pip using: 



```

pip install microfilm

```



To get the latest stage of the package with yet unreleased features use:



```

pip install git+https://github.com/guiwitz/microfilm.git

```



To test the package via the Jupyter interface and the notebooks available [here](notebooks) you can create a conda environment using the [environment.yml](binder/environment.yml) file:



```

conda env create -f environment.yml

```



### Optional installs



If you want to use the ```dataset``` submodule (see below in Additional functionalities) and need to handle multipage tiff files or nd2 files, use:



```

pip install "microfilm[multipage]"

```



or 



```

pip install "microfilm[nd2]"

```



If you plan to not just use simple plotting but want to create animations, you need to install:



```

pip install "microfilm[animation]"

```



To install all options use:



```

pip install "microfilm[all]"

```



## Simple plot



It is straightforward to create a ready-to-use plot of a multi-channel image dataset. In the following code snippet, we load a Numpy array of a multi-channel time-lapse dataset with shape ```CTXY``` (three channels). The figure below showing the time-point ```t=10``` is generated in a single command with a few options and saved as a png:



```python

import numpy as np

import skimage.io

from microfilm.microplot import microshow



image = skimage.io.imread('../demodata/coli_nucl_ori_ter.tif')

time = 10



microim = microshow(

    images=image[:, time, :, :], fig_scaling=5,

    cmaps=['pure_blue','pure_red', 'pure_green'],

    unit='um', scalebar_size_in_units=3, scalebar_unit_per_pix=0.065, scalebar_font_size=20,

    label_text='A', label_font_size=0.04)



microim.savefig('../illustrations/composite.png', bbox_inches = 'tight', pad_inches = 0, dpi=600)

```



image



## Animation



It is then easy to extend a simple figure into an animation as both objects take the same options. Additionally, a time-stamp can be added to the animation. This code generates the movie visible below:



```python

import numpy as np

import skimage.io

from microfilm.microanim import Microanim



image = skimage.io.imread('../demodata/coli_nucl_ori_ter.tif')



microanim = Microanim(data=image, cmaps=['pure_blue','pure_red', 'pure_green'], fig_scaling=5,

                      unit='um', scalebar_size_in_units=3, scalebar_unit_per_pix=0.065,

                      scalebar_thickness=0.02, scalebar_font_size=20)



microanim.add_label('A', label_font_size=30)

microanim.add_time_stamp('T', 10, location='lower left', timestamp_size=20)



microanim.save_movie('../illustrations/composite_movie.gif', fps=15)

```



image



## Panels



Both simple figures and animations can be combined into larger panels via the ```microplot.Micropanel``` and ```microanim.Microanimpanel``` objects. For example we can first create two figures ```microim1``` and ```microim2``` and then combine them into ```micropanel```:



```python

from microfilm import microplot

import skimage.io



image = skimage.io.imread('../demodata/coli_nucl_ori_ter.tif')



microim1 = microplot.microshow(images=[image[0, 10, :, :], image[1, 10, :, :]],

                               cmaps=['Greys', 'pure_magenta'], flip_map=[False, False],

                               label_text='A', label_color='black')

microim2 = microplot.microshow(images=[image[0, 10, :, :], image[2, 10, :, :]],

                               cmaps=['Greys', 'pure_cyan'], flip_map=[False, False],

                               label_text='B', label_color='black')



micropanel = microplot.Micropanel(rows=1, cols=2, figsize=[4,3])



micropanel.add_element(pos=[0,0], microim=microim1)

micropanel.add_element(pos=[0,1], microim=microim2)



micropanel.savefig('../illustrations/panel.png', bbox_inches = 'tight', pad_inches = 0, dpi=600)

```



image



And similarly for animations:



```python

from microfilm import microanim

import skimage.io



image = skimage.io.imread('../demodata/coli_nucl_ori_ter.tif')



microanim1 = microanim.Microanim(data=image[[0,1],::], cmaps=['Greys', 'pure_magenta'],

                                 flip_map=[False, False], label_text='A', label_color='black')

microanim2 = microanim.Microanim(data=image[[0,2],::], cmaps=['Greys', 'pure_cyan'],

                                 flip_map=[False, False], label_text='B', label_color='black')



microanim1.add_time_stamp(unit='T', unit_per_frame='3', location='lower-right', timestamp_color='black')



animpanel = microanim.Microanimpanel(rows=1, cols=2, figsize=[4,3])

animpanel.add_element(pos=[0,0], microanim=microanim1)

animpanel.add_element(pos=[0,1], microanim=microanim2)



animpanel.save_movie('../illustrations/panel.gif')

```



image



## Additional functionalities



In addition to these main plotting capabilities, the packages also offers:

- ```microfilm.colorify```: a series of utility functions used by the main functions to create the composite color images. It contains functions to create colormaps, to turn 2D arrays into 3D-RGB arrays with appropriate colormaps etc.

- ```microfilm.dataset```: a module offering a simple common data structure to handle multi-channel time-lapse data from multipage tiffs, series of tiff files, Nikon ND2 files, H5 and Numpy arrays. Requirement to use this module are at the moment very constrained (e.g. dimension order of Numpy arrays, name of H5 content etc.) but might evolve in the future.



## Authors



This package has been created by Guillaume Witz, Microscopy Imaging Center and Science IT Support, University of Bern.