zospy.functions.lde.get_pupil

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

Obtains the pupil data.

Parameters:

oss: zospy.zpcore.OpticStudioSystem

A ZOSPy OpticStudioSystem instance.

Returns:

PupilData

The pupildata.

Examples

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