zospy.analyses.surface.curvature.CurvatureSettings

class zospy.analyses.surface.curvature.CurvatureSettings

Bases: object

Settings for the Curvature analysis.

Attributes:

samplingstr | int

The size of the used grid, either string (e.g. ‘65x65’) or int. The integer will be treated as if obtained from zospy.constants.Analysis.SampleSizes_Pow2Plus1_X. Defaults to ‘65x65’.

datastr

The used data type. Should be one of [‘TangentialCurvature’, ‘SagittalCurvature’, ‘X_Curvature’, ‘Y_Curvature’] or int. The integer will be treated as if obtained from zospy.constants.Analysis.SurfaceCurvatureData. Defaults to ‘TangentialCurvature’.

removestr

Defines whether a reference volume is removed or not. Should be one of [‘None’, ‘BaseROC’, ‘BestFitSphere’] or int. The integer will be treated as if obtained from zospy.constants.Analysis.RemoveOptions. Defaults to ‘None’.

surfaceint

The surface that is te be analyzed. defaults to 1.

show_asstr

Defines how the data is displayed in OpticStudio. Should be one of [‘Surface’, ‘Contour’, ‘GreyScale’, ‘InverseGreyScale’, ‘FalseColor’, ‘InverseFalseColor’] or int. The integer will be treated as if obtained from zospy.constants.Analysis.ShowAs. Defaults to ‘Contour’.

off_axis_coordinatesbool

Defines whether apertures defined in the Surface Properties of the surface are considered or not. Defaults to False.

contour_formatstr

The contour format. Only usable when showas == ‘Contour’. Defaults to ‘’.

bfs_criterionstr | int

The criterion for BFS removal. Only usable when remove == ‘BestFitSphere’. Should be one of [‘MinimumVolume’, ‘MinimumRMS’, ‘MinimumRMSWithOffset’] or int. The integer will be treated as if obtained from constants.Analysis.BestFitSphereOptions. Defaults to ‘MinimumVolume’.

bfs_reverse_directionbool

Defines if the sign of the BFS radius should be reversed or not. Only usable when remove == ‘BestFitSphere’ and bfs_criterion == ‘MinimumVolume’. Defaults to False.

__init__(*args: Any, **kwargs: Any) → None