Skip to main content

Computational microscopy toolkit for label-free imaging

Project description

recOrder

PyPI - Python Version Python package index download statistics Python package index Development Status

recOrder is a collection of computational imaging methods. It currently provides QLIPP (quantitative label-free imaging with phase and polarization), phase from defocus, and fluorescence deconvolution.

Unveiling the invisible

Acquisition, calibration, background correction, reconstruction, and applications of QLIPP are described in the following E-Life Paper:

Syuan-Ming Guo, Li-Hao Yeh, Jenny Folkesson, Ivan E Ivanov, Anitha P Krishnan, Matthew G Keefe, Ezzat Hashemi, David Shin, Bryant B Chhun, Nathan H Cho, Manuel D Leonetti, May H Han, Tomasz J Nowakowski, Shalin B Mehta, "Revealing architectural order with quantitative label-free imaging and deep learning," eLife 2020;9:e55502 DOI: 10.7554/eLife.55502 (2020).

These are the kinds of data you can acquire with recOrder and QLIPP:

https://user-images.githubusercontent.com/9554101/271128301-cc71da57-df6f-401b-a955-796750a96d88.mov

https://user-images.githubusercontent.com/9554101/271128510-aa2180af-607f-4c0c-912c-c18dc4f29432.mp4

What do I need to use recOrder

recOrder is to be used alongside a conventional widefield microscope. For QLIPP, the microscope must be fitted with an analyzer and a universal polarizer:

https://user-images.githubusercontent.com/9554101/273073475-70afb05a-1eb7-4019-9c42-af3e07bef723.mp4

For phase-from-defocus or fluorescence deconvolution methods, the universal polarizer is optional.

The overall structure of recOrder is shown in Panel B, highlighting the structure of the graphical user interface (GUI) through a napari plugin and the command-line interface (CLI) that allows users to perform reconstructions.

Flow Chart

Software Quick Start

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

conda create -y -n recOrder python=3.10
conda activate recOrder

Install recOrder-napari with acquisition dependencies (napari and pycro-manager):

pip install recOrder-napari[acq]

Open napari with recOrder-napari:

napari -w recOrder-napari

For more help, see recOrder's documentation. To install recOrder on a microscope, see the microscope installation guide.

Dataset

Slides and a dataset shared during a workshop on QLIPP and recOrder can be found on Zenodo, and the napari plugin's sample contributions (File > Open Sample > recOrder-napari in napari).

DOI DOI

Download files

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

Source Distribution

recorder_napari-0.4.2rc1.tar.gz (7.1 MB view details)

Uploaded Source

Built Distribution

recOrder_napari-0.4.2rc1-py3-none-any.whl (12.2 MB view details)

Uploaded Python 3

File details

Details for the file recorder_napari-0.4.2rc1.tar.gz.

File metadata

  • Download URL: recorder_napari-0.4.2rc1.tar.gz
  • Upload date:
  • Size: 7.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for recorder_napari-0.4.2rc1.tar.gz
Algorithm Hash digest
SHA256 c842934d51fed2298941b6eb8c7f1282b72e33943f89a12c4c2149ba69192524
MD5 8547f8a388a3ccc45fa65487641e889c
BLAKE2b-256 c561421965ee427044cc86c1ad12da1d73c90c6b44461b00452936494cd61bb7

See more details on using hashes here.

File details

Details for the file recOrder_napari-0.4.2rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for recOrder_napari-0.4.2rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 55e339201ea0d179f6e581f2b81a4a659fc2772d245f58312bcfe33ce3f4a10c
MD5 5f58406fa4cf83091f6e289d4fb155b9
BLAKE2b-256 2bf685b382ae2ecac8314ff4124c8e119c4fb223117ef3d2b100759f80e1903d

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