zospy.analyses.systemviewers.cross_section.CrossSection

zospy.analyses.systemviewers.cross_section.CrossSection#

class zospy.analyses.systemviewers.cross_section.CrossSection#

Bases: SystemViewerWrapper[CrossSectionSettings]

Cross section 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 cross section 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__(*, start_surface: int = 1, end_surface: int = -1, number_of_rays: int = 3, y_stretch: float = 1.0, fletch_rays: bool = False, wavelength: int | Literal['All'] = 'All', field: int | Literal['All'] = 'All', color_rays_by: constants.Tools.Layouts.ColorRaysByCrossSectionOptions | str = 'Fields', upper_pupil: float = 1.0, lower_pupil: float = -1.0, delete_vignetted: bool = False, marginal_and_chief_only: bool = False, image_size: tuple[int, int] = (800, 600), rays_line_thickness: constants.Tools.Layouts.LineThicknessOptions | str = 'Standard', surface_line_thickness: constants.Tools.Layouts.LineThicknessOptions | str = 'Standard')#

Create a new cross section viewer.

See also

CrossSectionSettings

Settings for the cross section viewer.

configure_layout_tool() → ZOSAPI.Tools.Layouts.ICrossSectionExport#

Configure the cross section viewer.

Contents