visisipy.opticstudio.analysis.wavefront#
Wavefront analysis for OpticStudio.
Functions#
|
Calculate the Optical Path Difference (OPD) map at the retina surface. |
Module Contents#
- visisipy.opticstudio.analysis.wavefront.opd_map(backend: visisipy.opticstudio.backend.OpticStudioBackend, field_coordinate: visisipy.types.FieldCoordinate | None = None, wavelength: float | None = None, field_type: visisipy.types.FieldType = 'angle', sampling: visisipy.types.SampleSize | str | int = 128, *, remove_tilt: bool = True, use_exit_pupil_shape: bool = False) tuple[pandas.DataFrame, pandas.DataFrame]#
Calculate the Optical Path Difference (OPD) map at the retina surface.
- Parameters:
- backendOpticStudioBackend
Reference to the OpticStudio backend.
- field_coordinateFieldCoordinate | None
The coordinate of the field for which the wavefront is calculated. If None, the current field coordinate will be used.
- wavelengthfloat | None
The wavelength (in nm) for which the wavefront is calculated. If None, the current wavelength will be used.
- field_typeFieldType
The type of field coordinate provided. Either ‘angle’ (degrees) or ‘object_height’ (mm). Defaults to ‘angle’.
- samplingSampleSize | str | int
The sampling of the OPD map. Can be an integer (e.g., 128 for 128x128), a string like ‘128x128’, or a SampleSize object. Defaults to 128.
- remove_tiltbool, optional
If True, the tilt component is removed from the OPD map. Defaults to True.
- use_exit_pupil_shapebool, optional
If True, the OPD map is distorted to show the shape of the exit pupil. Defaults to False.
- Returns:
- DataFrame
A pandas DataFrame containing the OPD map values in waves.
- DataFrame
The raw analysis result from the backend.
- Raises:
- RuntimeError
If the wavefront analysis fails or returns no data.