apodization.base

Apodization Base Module

This module defines the abstract base class for apodization functions used in optical simulations.

Kramer Harrison, 2025

Classes

BaseApodization()

Abstract base class for apodization functions.
class BaseApodization[source]

Abstract base class for apodization functions.

classmethod from_dict(data)[source]

Creates an instance of the apodization from a dictionary.

Parameters:

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

Returns:

An instance of the apodization class.

Return type:

BaseApodization

abstract get_intensity(Px, Py)[source]

Applies the apodization function to the given pupil coordinates.

Parameters:

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

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

Returns:

Array of intensity scaling factors.

Return type:

be.ndarray

to_dict()[source]

Converts the apodization to a dictionary.

Returns:

A dictionary representation of the apodization.

Return type:

dict