fouriax.PhaseMask

class PhaseMask(phase_map_rad)

Bases: OpticalLayer

Spatial-domain phase-only modulation layer.

Parameters:

phase_map_rad (Array | float)

__init__(phase_map_rad)

Parameters:

phase_map_rad (Array | float)

Return type:

None

Methods

__init__(phase_map_rad)
forward(field)	Apply this layer's optical transformation to field.
parameters()	Return trainable or configurable layer parameters.
validate_for(field)	Check that field is compatible with this layer.

Attributes

phase_map_rad

phase_map_rad: Array | float

forward(field)

Apply this layer’s optical transformation to field.

Parameters:

field (Field) – Input optical field to transform.

Returns:

Transformed field. Subclasses should preserve batch axes, wavelength axes, and metadata unless the layer explicitly changes them.

Return type:

Field

parameters()

Return trainable or configurable layer parameters.

Returns an empty dict by default. Subclasses override this to expose arrays that should be updated during optimisation.

Return type:

dict[str, Array]