zospy.analyses.systemviewers.nsc_shaded_model.NSCShadedModel

class zospy.analyses.systemviewers.nsc_shaded_model.NSCShadedModel

Bases: SystemViewerWrapper[NSCShadedModelSettings]

Nonsequential Shaded Model viewer.

Attributes:

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 nonsequential shaded model viewer.
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__(*, image_size: tuple[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = (800, 600))

Create a new nonsequential shaded model viewer.

See also

NSCShadedModelSettings

Settings for the nonsequential shaded model viewer.

configure_layout_tool() → ZOSAPI.Tools.Layouts.IShadedModelExport

Configure the nonsequential shaded model viewer.