FringeLib: Extracting Key Features from Holographic Images

FringeLib is a Python library designed for extracting the main context from holographic images that require amplitude or phase correction. This library provides functionalities to enhance the quality and interpretability of such images, catering to both amplitude and phase correction needs.

Features

frng_a: Function to extract main context from images requiring amplitude correction. (both the functions can be called from FringeLib.pyc)
frng_p: Function to extract main context from images requiring phase correction.
Synthetic Datasets: Includes two synthetic datasets:
- Amplitude Dataset: 100 images requiring amplitude correction.
- Phase Dataset: 100 images requiring phase correction.

Library Installation

pip install numpy
pip install matplotlib
pip install opencv-python

Importing the libraries

import numpy as np
import matplotlib.pyplot as plt
import cv2

Installation

You can utilize FringeLib using the repo:

!git clone https://github.com/PavanMohanN/fringe_pack.git

Usage

Example Usage


import FringeLib

Example usage for image needing amplitude correction


result_a = FringeLib.frng_a(img)
plt.imshow(result_a,cmap='gray')

Example usage for image needing phase correction


result_p = FringeLib.frng_p(img)
plt.imshow(result_p,cmap='gray')

[whl_implementation.ipynb illustrates the utilization of the executable with os, numpy, matplotlib and cv2 as dependencies]

Project Directory Structure


  FringeLib/
├── dist/
│   └── fringe_pack-1.0-py3-none-any.whl  # Distribution package (example)
└── src/
    └── fringe_pack/
        ├── FringeLib.pyc      # Package
        └── fringe_pack.egg-info/         # Package metadata
            ├── dependency_links.txt
            ├── PKG-INFO
            ├── requires.txt
            ├── SOURCES.txt
            └── top_level.txt

dist/: Contains distribution packages (whl files) generated for deployment.

src/: Directory containing the source code for the project.

fringe_pack/: Package directory where your library's modules and initialization reside.

fringe_pack.egg-info/: Directory containing metadata generated by packaging tools (setuptools, wheel). It includes dependency information and other package details.

Created in Jul 2024

@author: Pavan Mohan Neelamraju

Affiliation: Indian Institute of Technology Madras

Email: npavanmohan3@gmail.com

Personal Website 🔴🔵: [pavanmohan.netlify.app]

PavanMohanN/FringeLib