zospy.solvers.pickup_chief_ray

zospy.solvers.pickup_chief_ray(cell: ZOSAPI.Editors.IEditorCell, field: int = 1, wavelength: int = 0) → ZOSAPI.Editors.ISolvePickupChiefRay

Chief Ray solver.

Adjusts the value of cell so the chief ray passes through the center of the surface.

Parameters:

cellZOSAPI.Editors.IEditorCell

fieldint, optional

Field index to take the chief ray from, defaults to 1.

wavelengthint, optional

Wavelength index of the chief ray, defaults to 0.

Returns:

ZOSAPI.Editors.ISolvePickupChiefRay

The solve data for the chief ray pickup