zospy.analyses.systemviewers.base.SystemViewerWrapper

class zospy.analyses.systemviewers.base.SystemViewerWrapper

Bases: BaseAnalysisWrapper[ndarray | None, AnalysisSettings], ABC, Generic[AnalysisSettings]

Base class for SystemViewer analyses.

Attributes:

MODE

TYPE

analysis

The OpticStudio analysis object.

config_file

Path to the temporary configuration file.

image_output_file

Path to the image output 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.
configure_layout_tool()	Configure the layout tool for the analysis.
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[, image_output_file, oncomplete])	Run the analysis.
run_analysis()	Run the layout tool.
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__(settings_kws: dict[str, any])

Create a new analysis wrapper.

Settings can be changed by passing the settings as keyword arguments. Use the with_settings method to specify the settings using a settings object.

Parameters:

settings_kwsdict[str, Any]

Arguments to set the settings of the analysis.

Raises:

ValueError

If settings is not a dataclass.

abstract configure_layout_tool() → ZOSAPI.Tools.Layouts.ICrossSectionExport | ZOSAPI.Tools.Layouts.I3DViewerExport | ZOSAPI.Tools.Layouts.IShadedModelExport | ZOSAPI.Tools.Layouts.INSC3DLayoutExport | ZOSAPI.Tools.Layouts.INSCShadedModelExport

Configure the layout tool for the analysis.

property image_output_file: str | Path | None

Path to the image output file.

run(oss: OpticStudioSystem, image_output_file: str | Path | None = None, oncomplete: OnComplete | Literal['Close', 'Release', 'Sustain'] = 'Close') → AnalysisData

Run the analysis.

Parameters:

**kwargs

run_analysis() → ndarray | None

Run the layout tool.