fouriax.KSpaceAmplitudeMask

class KSpaceAmplitudeMask(amplitude_map, aperture_diameter_um=None)

Bases: OpticalLayer

k-space amplitude modulation layer.

Parameters:

• amplitude_map (Array | float)

• aperture_diameter_um (float | None)

__init__(amplitude_map, aperture_diameter_um=None)

Parameters:

• amplitude_map (Array | float)

• aperture_diameter_um (float | None)

Return type:

None

Methods

__init__(amplitude_map[, aperture_diameter_um])
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

aperture_diameter_um
amplitude_map

amplitude_map: Array | float

aperture_diameter_um: float | None = None

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]