zospy.analyses.systemviewers.viewer_3d.Viewer3D

zospy.analyses.systemviewers.viewer_3d.Viewer3D#

class zospy.analyses.systemviewers.viewer_3d.Viewer3D#

Bases: SystemViewerWrapper[Viewer3DSettings]

3D system 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 3D 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, wavelength: int | Literal['All'] = 'All', field: int | Literal['All'] = 'All', ray_pattern: constants.Tools.General.RayPatternType | str = 'XYFan', color_rays_by: constants.Tools.Layouts.ColorRaysByOptions | str = 'Fields', delete_vignetted: bool = False, hide_lens_faces: bool = False, hide_lens_edges: bool = False, hide_x_bars: bool = False, draw_paraxial_pupils: bool = False, fletch_rays: bool = False, split_nsc_rays: bool = False, scatter_nsc_rays: bool = False, draw_real_entrance_pupils: constants.Tools.Layouts.RealPupilOptions | str = 'Pupils_Off', draw_real_exit_pupils: constants.Tools.Layouts.RealPupilOptions | str = 'Pupils_Off', surface_line_thickness: constants.Tools.Layouts.LineThicknessOptions | str = 'Standard', rays_line_thickness: constants.Tools.Layouts.LineThicknessOptions | str = 'Standard', configuration_all: bool = False, configuration_current: bool = False, configuration_offset_x: float = 0, configuration_offset_y: float = 0, configuration_offset_z: float = 0, camera_viewpoint_angle_x: float = 0, camera_viewpoint_angle_y: float = 0, camera_viewpoint_angle_z: float = 0, image_size: tuple[int, int] = (800, 600))#

Create a new 3D system viewer.

zospy.analyses.systemviewers.viewer_3d.Viewer3D

Contents

zospy.analyses.systemviewers.viewer_3d.Viewer3D#