zospy.analyses

OpticStudio Analyses.

Analyses in OpticStudio are available through zospy.analyses. This module provides basic classes and functions for interacting with analyses (in zospy.analyses.base), as well as a procedural interface to several analyses.

Examples

Run a Single Ray Trace analysis:

>>> from zospy.analyses.wavefront import ZernikeStandardCoefficients
>>> ZernikeStandardCoefficients(sampling="32x32", maximum_term=15).run(oss)

Open an analysis for which a wrapper function is not yet available:

>>> import zospy as zp
>>> analysis = zp.analyses.new_analysis(
...     oss, zp.constants.Analysis.AnalysisIDM.ImageSimulation
... )

Modules

base	Base functionality for analyses.
decorators	Decorators for Pydantic dataclasses with default configurations.
extendedscene	OpticStudio analyses from the Extended Scene category.
mtf	OpticStudio analyses from the Modulation Transfer Function (MTF) category.
old	Old-style OpticStudio Analyses.
parsers	Parsers for OpticStudio analysis text output files.
physicaloptics	OpticStudio analyses from the Physical Optics category.
polarization	OpticStudio analyses from the Polarization category.
psf	OpticStudio analyses from the PSF category.
raysandspots	OpticStudio analyses from the Rays and spots category.
reports	OpticStudio analyses from the Reports category.
surface	OpticStudio analyses from the Surface category.
systemviewers	OpticStudio system viewers.
wavefront	OpticStudio analyses from the Wavefront category.