apodization.gaussian

Gaussian Apodization Module

This module provides a class for Gaussian apodization, which applies a Gaussian profile to scale the intensities of rays based on their position in the pupil.

Kramer Harrison, 2025

Classes

GaussianApodization([sigma])

Gaussian apodization, scaling intensities based on a Gaussian profile.

class GaussianApodization(sigma: float = 1.0)

Gaussian apodization, scaling intensities based on a Gaussian profile.

classmethod from_dict(data)

Creates an instance of GaussianApodization from a dictionary.

Note

The dictionary must contain the key “sigma” with a positive float value. Otherwise, it defaults to 1.0.

Parameters:

data (dict) – A dictionary representation of the apodization.

Returns:

An instance of the GaussianApodization class.

Return type:

GaussianApodization

get_intensity(Px, Py)

Applies Gaussian apodization.

Parameters:

• Px (be.ndarray) – Normalized x pupil coordinates.

• Py (be.ndarray) – Normalized y pupil coordinates.

Returns:

Array of intensity scaling factors based on Gaussian profile.

Return type:

be.ndarray

to_dict()

Converts the Gaussian apodization to a dictionary.

Returns:

A dictionary representation of the Gaussian apodization.

Return type:

dict