visisipy.opticstudio.analysis.helpers

Helper functions for OpticStudio analyses.

Functions

set_wavelength(→ int)	Set the wavelength in the OpticStudio backend.
set_field(→ int)	Set the field coordinate in the OpticStudio backend.

Module Contents

visisipy.opticstudio.analysis.helpers.set_wavelength(backend: visisipy.opticstudio.backend.OpticStudioBackend, wavelength: float | None = None) → int

Set the wavelength in the OpticStudio backend.

Parameters:

backendOpticStudioBackend

Reference to the OpticStudio backend.

wavelengthfloat | None, optional

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

Returns:

int

The wavelength number that was set.

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

Set the field coordinate in the OpticStudio backend.

Parameters:

backendOpticStudioBackend

Reference to the OpticStudio 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:

int

The field number that was set.