zospy.analyses.mtf.fft_through_focus_mtf#
- zospy.analyses.mtf.fft_through_focus_mtf(oss: OpticStudioSystem, sampling: str | int = '64x64', deltafocus: float = 0.1, frequency: float = 0, numberofsteps: int = 5, wavelength: str | int = 'All', field: str | int = 'All', mtftype: constants.Analysis.Settings.Mtf.MtfTypes | str = 'Modulation', use_polarization: bool = False, use_dashes: bool = False, oncomplete: OnComplete | str = OnComplete.Close) AnalysisResult#
Wrapper around the OpticStudio FFT Through Focus MTF.
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.
- sampling: str | int
The sampling, either string (e.g. ‘64x64’) or int. The integer will be treated as a ZOSAPI Constants integer.
- deltafocus: float
The delta focus, defaults to 0.1
- frequency: float
The frequency. Defaults to 0.
- numberofsteps: int
The number of steps. Defaults to 5.
- wavelength: str | int
The wavelength to use in the MTF. Either ‘All’ or an integer specifying the wavelength number.
- field: str | int
The field to use in the MTF. Either ‘All’ or an integer specifying the field number.
- mtftype: zospy.constants.Analysis.Settings.Mtf.MtfTypes.Modulation
The MTF type (e.g. Modulation) that is calculated.
- use_polarization: bool
Use polarization. Defaults to False.
- use_dashes: bool
Use dashes. Defaults to False.
- 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
A FftThroughFocusMtf analysis result