zospy.analyses.base.new_analysis

zospy.analyses.base.new_analysis(oss: OpticStudioSystem, analysis_type: constants.Analysis.AnalysisIDM, settings_first: bool = True) → Analysis

Creates a new analysis in Zemax.

Parameters:

oss: OpticStudioSystem

The Zemax OpticStudio system

analysis_type: zospy.constants.Analysis.AnalysisIDM

Analysis type from ZOSAPI.Analysis.AnalysisIDM

settings_first: bool

Do not run the analysis immediately, which allows to adjust settings. Defaults to True.

Returns:

analysis: Analysis

Examples

>>> new_analysis(oss, zp.constants.Analysis.AnalysisIDM.ZernikeStandardCoefficients)