zospy.analyses.systemviewers.nsc_shaded_model

zospy.analyses.systemviewers.nsc_shaded_model(oss: OpticStudioSystem, oncomplete: OnComplete | str = OnComplete.Release) → AnalysisResult

Wrapper around the OpticStudio NSC Shaded Model Viewer.

Parameters:

oss: zospy.zpcore.OpticStudioSystem

A ZOSPy OpticStudioSystem instance. Should be non-sequential.

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 ‘Release’.

Returns:

AnalysisResult

A NSC Shaded Model analysis result. As the viewers do not return data, the AnalysisResult can mainly be used to further control the analysis when oncomplete is set to Sustain.