zospy.functions.lde.get_pupil

Contents

zospy.functions.lde.get_pupil#

zospy.functions.lde.get_pupil(oss: OpticStudioSystem)#

Obtain the pupil data from the optical system.

Parameters:
osszospy.zpcore.OpticStudioSystem

A ZOSPy OpticStudioSystem instance.

Returns:
PupilData

The pupildata.

Examples

>>> import zospy as zp
>>> zos = zp.ZOS()
>>> oss = zos.connect()
>>> zp.functions.lde.get_pupil(oss)