Skip to content

Latest commit

 

History

History
174 lines (121 loc) · 6.41 KB

README.rst

File metadata and controls

174 lines (121 loc) · 6.41 KB
Raw

LenslessPiCam

Documentation Status DOI

A Hardware and Software Toolkit for Lensless Computational Imaging with a Raspberry Pi

Lensless imaging example

This toolkit has everything you need to perform imaging with a lensless camera. We make use of a low-cost implementation of DiffuserCam [1], where we use a piece of tape instead of the lens and the Raspberry Pi HQ camera sensor (the V2 sensor is also supported). Similar principles and methods can be used for a different lensless encoder and a different sensor.

If you are interested in exploring reconstruction algorithms without building the camera, that is entirely possible! The provided reconstruction algorithms can be used with the provided data or simulated data.

We've also written a few Medium articles to guide users through the process of building the camera, measuring data with it, and reconstruction. They are all laid out in this post.

Setup

If you are just interested in using the reconstruction algorithms and plotting / evaluation tools you can install the package via pip:

pip install lensless

For plotting, you may also need to install Tk.

For performing measurements, the expected workflow is to have a local computer which interfaces remotely with a Raspberry Pi equipped with the HQ camera sensor (or V2 sensor). Instructions on building the camera can be found here.

The software from this repository has to be installed on both your local machine and the Raspberry Pi. Note that we highly recommend using Python 3.9, as some Python library versions may not be available with earlier versions of Python. Moreover, its end-of-life is Oct 2025.

Local machine

Below are commands that worked for our configuration (Ubuntu 21.04), but there are certainly other ways to download a repository and install the library locally.

# download from GitHub
git clone [email protected]:LCAV/LenslessPiCam.git

# install in virtual environment
cd LenslessPiCam
python3 -m venv lensless_env
source lensless_env/bin/activate
pip install -e .

# -- extra dependencies for local machine for plotting/reconstruction
pip install -r recon_requirements.txt

# (optional) try reconstruction on local machine
python scripts/recon/admm.py

Note (25-04-2023): for using reconstruction method based on Pycsou lensless.apgd.APGD, V2 has to be installed:

pip install git+https://github.com/matthieumeo/pycsou.git@v2-dev

If PyTorch is installed, you will need to be sure to have PyTorch 2.0 or higher, as Pycsou V2 is not compatible with earlier versions of PyTorch. Moreover, Pycsou requires Python within [3.9, 3.11).

Moreover, numba (requirement for Pycsou V2) may require an older version of NumPy:

pip install numpy==1.23.5

Raspberry Pi

After flashing your Raspberry Pi with SSH enabled, you need to set it up for passwordless access. Do not set a password for your SSH key pair, as this will not work with the provided scripts.

On the Raspberry Pi, you can then run the following commands (from the home directory):

# dependencies
sudo apt-get install -y libimage-exiftool-perl libatlas-base-dev \
python3-numpy python3-scipy python3-opencv
sudo pip3 install -U virtualenv

# download from GitHub
git clone [email protected]:LCAV/LenslessPiCam.git

# install in virtual environment
cd LenslessPiCam
virtualenv --system-site-packages -p python3 lensless_env
source lensless_env/bin/activate
pip install --no-deps -e .
pip install -r rpi_requirements.txt

Acknowledgements

The idea of building a lensless camera from a Raspberry Pi and a piece of tape comes from Prof. Laura Waller's group at UC Berkeley. So a huge kudos to them for the idea and making tools/code/data available! Below is some of the work that has inspired this toolkit:

A few students at EPFL have also contributed to this project:

  • Julien Sahli: support and extension of algorithms for 3D.
  • Yohann Perron: unrolled algorithms for reconstruction.

Citing this work

If you use these tools in your own research, please cite the following:

@article{Bezzam2023,
   doi = {10.21105/joss.04747},
   url = {https://doi.org/10.21105/joss.04747},
   year = {2023},
   publisher = {The Open Journal},
   volume = {8},
   number = {86},
   pages = {4747},
   author = {Eric Bezzam and Sepand Kashani and Martin Vetterli and Matthieu Simeoni},
   title = {LenslessPiCam: A Hardware and Software Platform for Lensless Computational Imaging with a Raspberry Pi},
   journal = {Journal of Open Source Software}
}

References

[1]Antipa, N., Kuo, G., Heckel, R., Mildenhall, B., Bostan, E., Ng, R., & Waller, L. (2018). DiffuserCam: lensless single-exposure 3D imaging. Optica, 5(1), 1-9.
[2]Monakhova, K., Yurtsever, J., Kuo, G., Antipa, N., Yanny, K., & Waller, L. (2019). Learned reconstructions for practical mask-based lensless imaging. Optics express, 27(20), 28075-28090.