Python implementation of holographic image reconstruction algorithms
Project description
In-line Holographic Reconstruction
Python implementation of angular spectrum and multi-height phase recovery algorithms to reconstruct digital in-line holograms.
What's inside?
This package includes solvers for the holographic reconstruction problem. Computations can be performed on both cpu and gpu. The gpu-accelerated version is programmed on tensorflow and is auto-gradient friendly, thus can be easily employed on machine learning models.
Installation
To install the package, run:
pythom -m pip install fringe
The example files are not included in the package. To import them, clone the repository. In the git bash, run:
$ git clone https://github.com/farhadnkm/Fringe.Py
How to use
- Import images
Images must be ndarrays or tensors. A simple i/o functionality for this purpose is integrated inside the package:
from fringe.utils.io import import_image, import_image_seq, export_image
from fringe.utils.modifiers import ImageToArray, PreprocessHologram, ConvertToTensor
Modifiers are preprocessing classes. These classes have a process method which is called by the import functions on any image import and returns the processed image.
image_path = 'IMAGE_PATH.tif'
background_path = 'BACKGROUND_PATH.tif'
p1 = ImageToArray(bit_depth=16, channel='gray', crop_window=None, dtype='float32')
bg = import_image(background_path, preprocessor=p1)
p2 = PreprocessHologram(background=bg)
hologram = import_image(background_path, preprocessor=[p1, p2])
- Reconstruct holograms
Solvers are reconstruction algorithms having a solve function. solve functions give hologram(s) and axial distance(s) as input parameters and return a complex-valued reconstructed image.
solver = AsSolver(shape=h.shape, dx=1.12, dy=1.12, wavelength=532e-3)
z = -300
amp = np.abs(solver.solve(hologram, z))
phase = unwrap_phase(np.angle(solver.solve(hologram, z)))
- Export outputs
export_image(amp, os.path.join('PATH', 'amplitude.png'), dtype='uint8')
export_image(phase, os.path.join('PATH', 'phase.png'), dtype='uint8')
Examples and further details for multi-height phase recovery and gpu processing are included in the example notebooks.
Outcomes
A Hologram:
Reconstructed Amplitude and phase images obtained by back propagation:
Reconstructed Amplitude and phase images obtained by MHPR method using 8 axially displaced holograms:
======= History
0.0.1 (2021-02-19)
- First release on PyPI.
0.0.2 (2021-02-25)
- Some bugs and errors fixed
0.0.3 (2021-02-25)
- Minor bugs fixed
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fringe-0.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e33ec5a3413d204f39544dc729b52ff8f4b4453b31b325c5c1b7586b3fcacb19 |
|
MD5 | e796793c5e22524370fb3d88dc687287 |
|
BLAKE2b-256 | d0c82eb713106c06c3756fe036919ccfd78d1caced0c0f5aeb260a63c83c3a37 |