Welcome to pyMOE’s documentation!

pyMOE is a Python library for designing and producing masks for Micro Optical Elements.

Features

Mask design features:

• Designing multi-layer (grayscale) masks from analytical and/or numerical (e.g. Gerchberg–Saxton) methods

• Designing single layer (binary) dithered masks from grayscale masks

• Designing rudimentary metasurfaces masks

• Numerical scalar propagation methods (Rayleigh-Sommerfeld, Fresnel, Fraunhofer, Angular Spectrum Method, Bluestein) of electric fields from (grayscale) masks

• Rudimentary optimization and inverse design based on gradient-descent methods

Mask production features:

• Image file (binary/grayscale) <-> CAD files input-output conversion

• Operations with/within mask files (e.g. change layer numbers, make intances, CAD file import, merge shapes, …)

Dependencies

A list of dependencies (with versions) is at https://github.com/INLnano/pyMOE/blob/main/requirements.txt . To use the package straighforwardly please make sure you have these dependencies (and versions) installed.

Modular architecture

pyMOE is based on a modular architecture, where each module provides specific functionalities. The use of each module and its inter-modular connections is exemplified at https://www.sciencedirect.com/science/article/pii/S0010465524002546#fg0060 and practically in the example notebooks (there is one notebook for each module).

Literature

For background, theory, package structure, practical results and discussion of package’s performance, please refer to the publication:

10. Cunha, J. Queiroz, C. Silva, F. Gentile and D. E. Aguiam, pyMOE: Mask Design and Modelling for Micro Optical Elements and Flat Optics, Computer Physics Communications 109331 (2024). Link: https://doi.org/10.1016/j.cpc.2024.109331

Example Notebooks

Check the notebooks in the sidebar menu.

• Example Notebooks
  • Example notebook for generating masks with pyMOE
    • Circular aperture
    • Rectangular aperture
    • Fresnel Zone Plate
    • Fresnel phase mask
    • Generate phase mask from arbitrary phase function
    • Generate Alvarez Lenses
    • Operations between masks
    • Extra: Zernike polynomials mask
  • Example notebook for generating masks for metasurfaces with pyMOE
    • Selection of diameters + phases
    • Hexagonal grid metasurface
    • Extra: Large metasurface with pre defined library (Yu et al. 2013)
    • Extra: merge layers in .gds metasurface file
  • Example notebook for import-export operations with pyMOE
    • Export a created mask using gdsconverter
    • Convert phase mask to height map
    • Export mask to gds and dxf files
    • Convert height map dxf file to grayvalue from calibration lookup table
    • Transform layered .gds file into a grayscale image
    • Transform grayscale image into (binary) dithered image
    • Transform binary image file into single layered .gds file
    • Extra: Merging shapes in the single layer .gds file
  • Example notebook for operations with .gds files with pyMOE
    • Preliminary: Generate a Fresnel Phase Mask
    • Operations with/on .gds files
  • Example notebook for holographic phase mask generator
    • Loading target image
    • Calculating hologram phase mask using Gerchberg Saxton Algorithm
    • Creating aperture from calculated phase mask
    • Create GDS layout from calculated phase mask
  • Example notebook for implementing numerical propagation using propagate module
    • Propagation from a circular aperture
      • Propagate field using Angular Spectrum Method
    • Propagation from a Fresnel multilevel mask example #1
      • Create the Fresnel aperture
      • Propagate XY using Rayleigh-Sommerfeld and Bluestein
      • Propagate YZ using Rayleigh-Sommerfeld
      • Propagate XYZ volume with Bluestein
      • Compare ZZ between RS and Bluestein propagation
      • Speed up RS propagation using small bins
    • Propagation of square apertures
      • Propagate with ASM
      • Propagate with Bluestein
      • Propagate field and calculate in plane YZ, using npix bins in Y
      • Band limited ASM
      • ASM with Chirp Z-Transform
      • Propagation with Scalable Angular Spectrum Method propagation
    • Propagation from a Fresnel Zone Plate
      • Propagate with RS
      • Propagate with Bluestein
      • Compare RS and Bluestein propagations
    • Spiral Phase Plate
    • Alvarez Lenses Pair
      • Compare RS and Bluestein
    • Dammann Gratings
      • 2D Dammann Grating
        • Propagation with RS integral
        • Propagation with ASM method
        • Simulation of a subsection of the image plane
        • ASM with CZT
        • ASM with band limits
        • Propagation with Scalable ASM
        • Propagation with Bluestein
      • 1D Dammann Grating
    • Angular Spectrum Method and Scalable Angular Spectrum Method Validation
    • Propagation from Computer Generated Holograms
      • Propagation of Holograms with RS integral
      • Propagation of Holograms with Bluestein
      • Multilevel GS holograms
    • Near Field: Nanojet generation from a circular aperture illuminated by a Gaussian Beam
      • Propagate with RS
      • Propagate with Bluestein
      • Propagate the field from a circular aperture illuminated by a tightly focused Gaussian Beam
    • Evaluation of Oblique Incidence fields
      • Propagation with RS
      • Propagation with Bluestein XY YZ
    • Propagation through two lenses
      • Manually propagate through two sequential apertures
      • Use the ensemble class
  • Example notebook for optimizer module
    • Initializations
      • Optimization framework
    • Optimization with logging
      • Optimization with different forward propagators
        • Bluestein (default)
        • ASM
        • SASM
      • Loss function engineering
      • Target re-definition
      • Other optimizer algorithms
        • Optimization with optax module optimizers
      • Bounds during optimization
    • Hologram creation via inverse design
      • Binary hologram
        • Binary hologram inverse design via MSE loss function
        • Improving uniformity for the binary hologram inverse design via loss function engineering
        • Binary hologram inverse design via Negative Peason Correlation Coefficient (NPCC) loss function
      • Grayscale hologram
        • Grayscale hologram generation with MSE loss function
        • Grayscale hologram generation with NPCC loss function
    • Optimization of ensembles of optical elements
  • Metrics notebook
    • Point Spread Function (PSF)
    • Optical Transfer Function (OTF)
    • Modulation Transfer Function (MTF) and Phase Transfer Function (PTF) & Strehl ratio
    • Encircled energy
    • Ensquared energy
    • Focusing Efficiency
    • Optical Performance Metric (OPM)
    • Comparisons to theoretical (analytical)

Full function/class listings

Please check the function/class Indices and Tables in the sidebar menu or use Search functionality.

• Full function/class listings