waveorder

This computational imaging library enables wave-optical simulation and reconstruction of optical properties that report microscopic architectural order.

Computational label-free imaging

This vectorial wave simulator and reconstructor enabled the development of a new label-free imaging method, permittivity tensor imaging (PTI), that measures density and 3D orientation of biomolecules with diffraction-limited resolution. These measurements are reconstructed from polarization-resolved images acquired with a sequence of oblique illuminations.

The acquisition, calibration, background correction, reconstruction, and applications of PTI are described in the following preprint:

 L.-H. Yeh, I. E. Ivanov, B. B. Chhun, S.-M. Guo, E. Hashemi, J. R. Byrum, J. A. Pérez-Bermejo, H. Wang, Y. Yu, P. G. Kazansky, B. R. Conklin, M. H. Han, and S. B. Mehta, "uPTI: uniaxial permittivity tensor imaging of intrinsic density and anisotropy," bioRxiv 2020.12.15.422951 (2020).

In addition to PTI, waveorder enables simulations and reconstructions of subsets of label-free measurements with subsets of the acquired data:

1. Reconstruction of 2D or 3D phase, projected retardance, and in-plane orientation from a polarization-diverse volumetric brightfield acquisition (QLIPP)

2. Reconstruction of 2D or 3D phase from a volumetric brightfield acquisition (2D/3D (PODT) phase)

3. Reconstruction of 2D or 3D phase from an illumination-diverse volumetric acquisition (2D/3D differential phase contrast)

PTI provides volumetric reconstructions of mean permittivity ($\propto$ material density), differential permittivity ($\propto$ material anisotropy), 3D orientation, and optic sign. The following figure summarizes PTI acquisition and reconstruction with a small optical section of the mouse brain tissue:

The example notebooks illustrate simulations and reconstruction for 2D QLIPP, 3D PODT, and 2D/3D PTI methods.

If you are interested in deploying QLIPP or PODT for label-free imaging at scale, checkout our napari plugin, recOrder-napari.

Correlative imaging

In addition to label-free reconstruction algorithms, waveorder also implements widefield fluorescence and fluorescence polarization reconstruction algorithms for correlative label-free and fluorescence imaging.

1. Correlative measurements of biomolecular density and orientation from polarization-diverse widefield imaging (multimodal Instant PolScope)

We provide an example notebook for widefield fluorescence deconvolution.

Citation

Please cite this repository, along with the relevant preprint or paper, if you use or adapt this code. The citation information can be found by clicking "Cite this repository" button in the About section in the right sidebar.

Installation

(Optional but recommended) install anaconda and create a virtual environment:

conda create -y -n waveorder python=3.9
conda activate waveorder

Install waveorder from PyPI:

pip install waveorder

Use waveorder in your scripts:

python
>>> import waveorder

(Optional) Download the repository, install jupyter, and experiment with the example notebooks

git clone https://github.com/mehta-lab/waveorder.git
pip install jupyter
jupyter notebook ./waveorder/examples/

(Optional) Use NVIDIA GPUs by installing cupy with these instructions. Check that cupy is properly installed with

python
>>> import cupy

To use GPUs in waveorder set use_gpu=True when initializing the simulator and reconstructor classes.