zospy.functions.lde.surface_change_aperturetype

zospy.functions.lde.surface_change_aperturetype(surface: ZOSAPI.Editors.LDE.ILDERow, new_type: constants.Editors.LDE.SurfaceApertureTypes | str, aperture_file: str | None = None, aperture_x_decenter: float | None = None, aperture_y_decenter: float | None = None, maximum_radius: float | None = None, minimum_radius: float | None = None, number_of_arms: int | None = None, uda_scale: float | None = None, width_of_arms: float | None = None, x_half_width: float | None = None, y_half_width: float | None = None) → None

Change the aperturetype of a surface in the Lens Data Editor.

Be aware that while all aperture parameters can be specified, only the ones accepted by the new_type should be given, any parameter that is not None but not accepted by the new type will result in a UserWarning and will not be used. Keeping a parameter on None will result in the default values used by the local OpticStudio instance.

Parameters:

surfaceZOSAPI.Editors.LDE.ILDERow

The Row/Surface for which the change is to be made.

new_typezospy.constants.Editors.LDE.SurfaceApertureTypes | str

The new surface aperture type.

aperture_filestr | None

The aperture file. Defaults to None.

aperture_x_decenterint | None

The x decenter of the aperture. Defaults to None.

aperture_y_decenterint | None

The y decenter of the aperture. Defaults to None.

maximum_radiusfloat | None

The maximum radius. Defaults to None.

minimum_radiusfloat | None

The minimum radius. Defaults to None.

number_of_armsint | None

The number of arms. Defaults to None.

uda_scalefloat | None

The UDA scale. Defaults to None.

width_of_armsfloat | None

The width of arms. Defaults to None.

x_half_widthfloat | None

The x half width. Defaults to None

y_half_widthfloat | None

The y half width. Defaults to None

Returns:

None