zospy.analyses.wavefront.wavefront_map

zospy.analyses.wavefront.wavefront_map(oss: OpticStudioSystem, field: int = 1, surface: Literal['Image', 'Object'] | int = 'Image', wavelength: int = 1, show_as: constants.Analysis.ShowAs | str = 'Surface', rotation: constants.Analysis.Settings.Rotations | str = 'Rotate_0', sampling: constants.Analysis.SampleSizes | str = '64x64', polarization: constants.Analysis.Settings.Polarizations | str | None = None, reference_to_primary: bool = False, use_exit_pupil: bool = True, remove_tilt: bool = False, scale: float = 1.0, subaperture_x: float = 0.0, subaperture_y: float = 0.0, subaperture_r: float = 1.0, contour_format: str = '', oncomplete: OnComplete | str = OnComplete.Close) → AnalysisResult

Wavefront map analysis.

Parameters:

osszospy.zpcore.OpticStudioSystem

A ZOSPy OpticStudioSystem instance. Should be sequential.

field

The field that is to be analyzed. Defaults to 1.

surface str | int

The surface that is to be analyzed. Either ‘Image’, ‘Object’ or an integer. Defaults to ‘Image’.

wavelengthint

The wavelength number to use for the analysis. Defaults to 1.

show_asconstants.Analysis.ShowAs | str

Defines the output plot format. Defaults to ‘Surface’.

rotationconstants.Analysis.Settings.Rotations | str

The rotation or surface plots for viewing. Defaults to ‘Rotate_0’.

samplingconstants.Analysis.SampleSizes | str

The sampling. Defaults to ‘64x64’.

polarizationconstants.Analysis.Settings.Polarizations | str | None

The polarization that is accounted for. When set to None, polarization is ignored. Defaults to None.

reference_to_primarybool

Defines whether the aberrations are referenced to the reference sphere for the used wavelength or for the primary wavelength. If True, the reference sphere for the primary wavelength is used. Defaults to False.

use_exit_pupilbool

Defines whether the exit pupil shape is used. Defaults to True.

remove_tiltbool

Defines whether linear x- and y-tilt is removed from the data. Defaults to False.

scalefloat

The scale factor for surface plots. Defaults to False.

subaperture_xfloat

The subaperture x. Defaults to 0.0

subaperture_yfloat

The subaperture t. Defaults to 0.0

subaperture_rfloat

The subaperture r. Defaults to 1.0

contour_formatstr

The contour format. Only used when show-As is set to ‘Contour’. If set to an empty string, OpticStdio ignores it. Defaults to ‘’.

oncompleteOnComplete | str

Defines behaviour upon completion of the analysis. Should be one of [‘Close’, ‘Release’, ‘Sustain’]. If ‘Close’, the analysis will be closed after completion. If ‘Release’, the analysis will remain open in OpticStudio, but the link with python will be destroyed. If ‘Sustain’ the analysis will be kept open in OpticStudio and the link with python will be sustained. To enable interaction when oncomplete == ‘Sustain’, the OpticStudio Analysis instance will be available in the returned AnalysisResult through AnalysisResult.Analysis. Defaults to ‘Close’.

Returns:

AnalysisResult

A wavefront map analysis result.