Skip to main content

a package for simulations of laser beam shaping experiments

Project description

Beamshapy: Laser Beam Shaping Module

Beamshapy is a Python-based module designed for crafting laser beam shaping masks for use on phase-only Spatial Light Modulators (SLM). It leverages Fast Fourier Transform (FFT) propagation and relies on the Lightpipes package for its core functionality.

Features

Beamshapy provides two primary methods for mask design:

  1. Manual Design:

    • Craft appropriate masks for a targeted profile using the method described in Encoding amplitude information onto phase-only filters, JA Davis, 1999 Read the article
    • Suitable for controlling amplitude and phase in the conjugate Fourier plane.
  2. Gerchberg and Saxton Algorithm:

    • Design masks when only the intensity profile is important.
    • Optimizes the phase mask to achieve the targeted intensity in the conjugate Fourier plane.

Examples

Beamshapy includes several examples to demonstrate its capabilities:

  • example_simple_FT_propagation.py: Simple propagation with a wrapped wedge displayed on the SLM.
  • example_mask_design_BG_modul.py: Mask design and propagation, used to design the masks featured in the associated article.
  • example_mask_design_fresnel.py: Mask design for a Fresnel lens.
  • example_mask_design_GSA.py: Target intensity design and Gerchberg and Saxton optimization routine to obtain the phase mask for the targeted intensity in the conjugate Fourier plane.

For a practical application of Beamshapy, refer to our article: Selective excitation of high-order modes in two-dimensional cavity resonator integrated grating filters, A. Rouxel et al, 2024. Read the article

Installation

To install beamshapy, follow these steps:

  1. Clone the repository from GitHub:

    git clone https://github.com/a-rouxel/beamshapy.git
    cd beamshapy
    
  2. Create a dedicated Python environment using Miniconda: If you don't have Miniconda installed, follow the instructions here.

    # Create a new Python environment
    conda create -n beamshapy python=3.9
    
    # Activate the environment
    conda activate beamshapy
    
  3. Install the necessary Python packages: The required packages are listed in the requirements.txt file in the repository.

    # Install necessary Python packages with pip
    pip install -r requirements.txt
    

License

Beamshapy is open-source and available under the MIT License.

Contributions

Contributions are welcome! Please feel free to submit issues, fork the repository, and send pull requests.

Contact

For any questions or feedback, please contact the repository owner at arouxel@laas.fr.

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

beamshapy-0.1.13.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

beamshapy-0.1.13-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file beamshapy-0.1.13.tar.gz.

File metadata

  • Download URL: beamshapy-0.1.13.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1022-azure

File hashes

Hashes for beamshapy-0.1.13.tar.gz
Algorithm Hash digest
SHA256 9ce445e6d0053f94315bb60cd1bea059e11e56199c6d1f100ae528a15ac03ef0
MD5 d226e3b765a333d50649d0291dbcd682
BLAKE2b-256 ffc41750756469e5e489221e4bc18a4f98d8aa01e2c836665da8f186ba7af5cd

See more details on using hashes here.

File details

Details for the file beamshapy-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: beamshapy-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1022-azure

File hashes

Hashes for beamshapy-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 a19946bcb2d3e1ccfbe684b1ceac16aac7a52fd98ed63c28cd02508905b4c236
MD5 34afc00495c90049cd52ee471621bc74
BLAKE2b-256 231a2319106c6077c33ea7887f3e08dde3b6d1b1a73656f27bec70a84d3f59a9

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