Skip to main content

A scalar diffraction simulation package

Project description

openphoton

The latest version allows you to simulate light propagation from a laser, passing through lens, and passing through your test object. More features will be added soon.

Examples of How To Use (Alpha Version)

Add openphoton to your operating system or python virtual environment :

pip install openphoton

Create a laser beam :

import openphoton as op

# side length (m)
# aperture radius (m)
u0 = op.devices.laser_beam(
    side_length=0.06,
    aperture_radius=0.026,
    pixels=1024)

In order to forward propagate the wave field, you must choose between fresnel (near-field) approximation and fraunhoffer (far-field) approximation. To determine which approximation is best for your system, you have to calculate the Fresnel number F_N. If F_N = [1, +infinity], then use fresnel approximation. Otherwise, use fraunhoffer approximation.

# uo = wave field to propagate
# L = source plane side length (m)
# wavelength = wavelength of light (m)
# z = propagation distance (m)
# u1 = resulting wave field after propagation
u1 = op.rayleigh_sommerfeld.fresnel_approx(
    u0, L, wavelength, z)

Apply converging lens or diverging lens on the laser beam :

import numpy as np

# u1 = wave field before the lens
# L = u1 side length (m)
# wavelength of light (m)
# f_length = lens focal length (m)
# u2 = wave field after the lens
u2 = np.multiply(u1, op.lenses.converging_lens(u1,L,wavelength,f_length))

Apply SLM or test object on the laser beam :

import numpy as np

# filename = image of test object file name
filename : str = "USAF_1951_1024p.png"

# SLM_amplitude() converts RGB image into numpy array
# pixel_size = number of pixels of image, ideally this must be the same with u1
test_object = op.devices.SLM_amplitude(filename, pixel_size)

# u1 = wave field before the test object
# L = u1 side length (m)
# wavelength of light (m)
# u2 = wave field after the test object
u2 = np.multiply(u1, test_object)

References:

  • Shen, Fabin, and Anbo Wang. "Fast-Fourier-transform based numerical integration method for the Rayleigh-Sommerfeld diffraction formula." Applied optics 45, no. 6 (2006): 1102-1110.
  • Schmidt, Jason D. "Numerical simulation of optical wave propagation with examples in MATLAB." SPIE (2010).
  • Voelz, David G., and Michael C. Roggemann. "Digital simulation of scalar optical diffraction: revisiting chirp function sampling criteria and consequences." Applied optics 48, no. 32 (2009): 6132-6142.

Check out: https://www.youtube.com/c/boyfriendnibluefairy

Project details


Download files

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

Source Distribution

openphoton-0.1.4.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

openphoton-0.1.4-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file openphoton-0.1.4.tar.gz.

File metadata

  • Download URL: openphoton-0.1.4.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for openphoton-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f8f6b5ae1b6340e8a2480856e9ebc3fd0cacbb8c9f0cd7cd5e99756bb75f1e77
MD5 845c097c91f11f610fd500f6a37a0d39
BLAKE2b-256 7e909a7011d8e6dd5ce20b065513c510c6388c1059f1412c74da88358db8e127

See more details on using hashes here.

File details

Details for the file openphoton-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: openphoton-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for openphoton-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4999d8f2d896cf4d7a36df5ffc71da40ef03f3b4483d65a33354b218d974fee0
MD5 edd95e9e8578db5eb1b7bf1d90e7541b
BLAKE2b-256 7576265d78924e7e0551431509cb557057ef77a74379f94e38e11974d3835135

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