zospy.analyses.surface.curvature.Curvature

class zospy.analyses.surface.curvature.Curvature

Bases: BaseAnalysisWrapper[CurvatureResult, CurvatureSettings]

Surface Curvature analysis.

Attributes:

MODE

analysis

The OpticStudio analysis object.

config_file

Path to the temporary configuration file.

oss

The OpticStudio system.

settings

Settings of the analysis.

text_output_file

Path to the temporary text output file.

Methods

__call__(oss, *args, **kwargs)	Run the analysis and return the results.
get_data_grid()	Get the data grids from the Curvature analysis.
get_data_series()	Get the data series from the analysis result.
get_text_output()	Get the text output of the analysis.
parse_output(grammar, transformer, result_type)	Parse the text output of the analysis.
run(oss[, config_file, text_output_file, ...])	Run the analysis and return the results.
run_analysis()	Run the Curvature analysis.
update_settings(*[, settings, settings_kws])	Update the settings of the analysis using a settings object or keyword arguments.
with_settings(settings)	Create a new analysis with the specified settings.

__init__(*, sampling: str | int = '65x65', data: str | constants.Analysis.SurfaceCurvatureData = 'TangentialCurvature', remove: str | constants.Analysis.RemoveOptions = 'None_', surface: int = 1, show_as: str | constants.Analysis.ShowAs = 'Contour', off_axis_coordinates: bool = False, contour_format: str = '', bfs_criterion: str | constants.Analysis.BestFitSphereOptions = 'MinimumVolume', bfs_reverse_direction: bool = False)

Create a new Curvature analysis.

See also

CurvatureSettings

Settings for the Curvature analysis.

get_data_grid() → CurvatureResult | None

Get the data grids from the Curvature analysis.

run_analysis() → list[CurvatureResult] | None

Run the Curvature analysis.