zospy.solvers.surface_pickup

zospy.solvers.surface_pickup(cell: ZOSAPI.Editors.IEditorCell, from_surface: ZOSAPI.Editors.IEditorRow | int, from_column: constants.Editors.LDE.SurfaceColumn | str = None, scale: float = 1, offset: float = 0) → ZOSAPI.Editors.ISolveSurfacePickup

Set the cell solve type to Surface Pickup.

This solver picks up the value from another surface and optionally applies a scale and offset to it.

Parameters:

cellZOSAPI.Editors.IEditorCell

Cell for which the value should be set

from_surfaceZOSAPI.Editors.IEditorRow

Index of the surface or surface from which the value is picked up

from_columnzospy.api.constants.Editors.LDE.SurfaceColumn | str, optional

Column from which the value is picked up

scalefloat

Factor by which the picked up value is scaled. This value is only set if the cell supports a scale factor. Defaults to 1.

offsetfloat

Offset which is added to the picked up value. This value is only set if the cell supports an offset. Defaults to 0.

Returns:

The SolveData object for the surface pickup.