visisipy.optiland.analysis.helpers

Helper functions for Optiland analyses.

Functions

set_wavelength(→ float)	Set the wavelength in the Optiland backend.
set_field(→ tuple[float, float])	Set the field coordinate in the Optiland backend.

Module Contents

visisipy.optiland.analysis.helpers.set_wavelength(backend: visisipy.optiland.backend.OptilandBackend, wavelength: float | None = None) → float

Set the wavelength in the Optiland backend.

Parameters:

backendOptilandBackend

Reference to the Optiland backend.

wavelengthfloat | None, optional

The wavelength to set, in μm. If None, the first wavelength in the system will be used. Defaults to None.

Returns:

float

The wavelength that was set. If None was passed, the first wavelength in the system is returned.

visisipy.optiland.analysis.helpers.set_field(backend: visisipy.optiland.backend.OptilandBackend, field_coordinate: tuple[float, float] | None = None, field_type: visisipy.types.FieldType = 'angle') → tuple[float, float]

Set the field coordinate in the Optiland backend.

Parameters:

backendOptilandBackend

Reference to the Optiland backend.

field_coordinatetuple[float, float] | None, optional

The field coordinate to set. If None, the first field in the system will be used. Defaults to None.

field_typeFieldType, optional

The type of field to be used when setting the field coordinate. Defaults to “angle”.

Returns:

tuple[float, float]

The normalized field coordinate of the field that was set.