zospy.analyses.base.new_analysis

Contents

zospy.analyses.base.new_analysis#

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

Create a new analysis in OpticStudio.

Parameters:
ossOpticStudioSystem

The Zemax OpticStudio system

analysis_typezospy.constants.Analysis.AnalysisIDM

Analysis type from ZOSAPI.Analysis.AnalysisIDM

settings_firstbool

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

Returns:
analysisAnalysis

Examples

>>> import zospy as zp
>>> new_analysis(oss, zp.constants.Analysis.AnalysisIDM.ZernikeStandardCoefficients)
Contents