visisipy.analysis.wavefront

Calculate wavefront maps of the eye.

Functions

opd_map(…)

Calculate the Optical Path Difference (OPD) map at the retina surface.

Module Contents

visisipy.analysis.wavefront.opd_map(model: visisipy.models.EyeModel | None = None, 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, return_raw_result: Literal[False] = False, backend: visisipy.backend.BaseBackend = _AUTOMATIC_BACKEND) → pandas.DataFrame

visisipy.analysis.wavefront.opd_map(model: visisipy.models.EyeModel | None = None, 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, return_raw_result: Literal[True] = True, backend: visisipy.backend.BaseBackend = _AUTOMATIC_BACKEND) → tuple[pandas.DataFrame, Any]

Calculate the Optical Path Difference (OPD) map at the retina surface.

Parameters:

modelEyeModel | None

The eye model to use for the wavefront calculation. If None, the currently built model will be used.

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. This option is not supported by all backends.

return_raw_resultbool, optional

Return the raw analysis result from the backend. Defaults to False.

backendBaseBackend

The backend to be used for the analysis. If not provided, the default backend is used.

Returns:

DataFrame

A pandas DataFrame containing the OPD map values in waves.

Any

The raw analysis result from the backend.