zospy.analyses.mtf.huygens_mtf

zospy.analyses.mtf.huygens_mtf(oss: OpticStudioSystem, pupil_sampling: str | int = '32x32', image_sampling: str | int = '32x32', image_delta: float = 0.0, wavelength: str | int = 'All', field: str | int = 'All', mtftype: constants.Analysis.Settings.Mtf.HuygensMtfTypes | str = 'Modulation', maximum_frequency: float = 150.0, use_polarization: bool = False, use_dashes: bool = False, oncomplete: OnComplete | str = OnComplete.Close) → AnalysisResult

Wrapper around the OpticStudio Huygens MTF.

For an in depth explanation of the parameters, see the Zemax OpticStudio user manual

Parameters:

osszospy.zpcore.OpticStudioSystem

A ZOSPy OpticStudioSystem instance. Should be sequential.

pupil_samplingstr | int

The pupil sampling, either string (e.g. ‘64x64’) or int. The integer will be treated as a ZOSAPI Constants integer.

image_samplingstr | int

The image sampling, either string (e.g., ‘64x64’) or int. The integer will be treated as a ZOSAPI Constants integer.

image_deltafloat

The Image Delta, defaults to 0.0.

wavelengthstr | int

The wavelength to use in the MTF. Either ‘All’ or an integer specifying the wavelength number.

fieldstr | int

The field to use in the MTF. Either ‘All’ or an integer specifying the field number.

mtftypezospy.constants.Analysis.Settings.Mtf.MtfTypes.Modulation

The MTF type (e.g. Modulation) that is calculated.

maximum_frequencyfloat

The maximum frequency at which the MTF is calculated. Units are either cycles/mm or cycles/mr, depending on system setting. Defaults to 150.0, which is more appropriate when units are set to cycles/mm.

use_polarizationbool

Use polarization. Defaults to False.

use_dashesbool

Use dashes. Defaults to False.

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 HuygensMTF analysis result