visisipy.opticstudio.analysis.zernike_coefficients#
Zernike coefficients analysis for OpticStudio.
Functions#
Calculate the Zernike standard coefficients at the retina surface. |
Module Contents#
- visisipy.opticstudio.analysis.zernike_coefficients.zernike_standard_coefficients(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 = 64, maximum_term: int = 45, unit: visisipy.types.ZernikeUnit = 'microns') tuple[visisipy.wavefront.ZernikeCoefficients, zospy.analyses.wavefront.zernike_standard_coefficients.ZernikeStandardCoefficientsResult]#
Calculate the Zernike standard coefficients at the retina surface.
- Parameters:
- backendOpticStudioBackend
Reference to the OpticStudio backend.
- field_coordinatetuple[float, float] | None, optional
The field coordinate for the Zernike calculation. When None, the first field in OpticStudio is used. Defaults to None.
- wavelengthfloat | None, optional
The wavelength for the Zernike calculation. When None, the first wavelength in OpticStudio is used. Defaults to None.
- field_typeLiteral[“angle”, “object_height”], optional
The type of field to be used when setting the field coordinate. This parameter is only used when field_coordinate is specified. Defaults to “angle”.
- samplingSampleSize | str | int, optional
The sampling for the Zernike calculation. Defaults to 64.
- maximum_termint, optional
The maximum term for the Zernike calculation. Defaults to 45.
- unitZernikeUnit, optional
The unit for the Zernike coefficients. Must be either “microns” or “waves”. Defaults to “microns”.
- Returns:
- ZernikeCoefficients
Zernike standard coefficients.
- ZernikeStandardCoefficientsResult
The raw Zernike standard coefficients analysis output from ZOSPy.