zospy.analyses.reports.surface_data.SurfaceData

class zospy.analyses.reports.surface_data.SurfaceData

Bases: BaseAnalysisWrapper[SurfaceDataResult, SurfaceDataSettings]

Surface Data 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([cell_origin])	Get the data grids from the analysis result.
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 Surface Data 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__(*, surface: int = 1)

Create a new Surface Data analysis.

See also

SurfaceDataSettings

Settings for the Surface Data analysis.

run_analysis() → SurfaceDataResult

Run the Surface Data analysis.