zospy.analyses.mtf.fft_through_focus_mtf_fromcfg

zospy.analyses.mtf.fft_through_focus_mtf_fromcfg(oss: OpticStudioSystem, cfgfile: str, oncomplete: OnComplete | str = OnComplete.Close)

Wrapper around the OpticStudio FFT Through Focus MTF using a configuration file.

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

Parameters:

oss: zospy.zpcore.OpticStudioSystem

A ZOSPy OpticStudioSystem instance. Should be sequential.

cfgfile: str

Full filepath (including extension) to a configuration file.

oncomplete: OnComplete | 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

An FftThroughFocusMtf analysis result. Next to the standard data, the cfgfile will be added under ‘UsedCfgFile’