zospy.analyses.raysandspots.single_ray_trace.SingleRayTrace

zospy.analyses.raysandspots.single_ray_trace.SingleRayTrace#

class zospy.analyses.raysandspots.single_ray_trace.SingleRayTrace#

Bases: BaseAnalysisWrapper[SingleRayTraceResult, SingleRayTraceSettings]

Single Ray Trace 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 Single Ray Trace 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__(*, hx: float = 0, hy: float = 0, px: float = 0, py: float = 0, wavelength: int = 1, field: int = 0, raytrace_type: constants.Analysis.Settings.Aberrations.RayTraceType | str = 'DirectionCosines', global_coordinates: bool = False)#

Create a new Single Ray Trace analysis.

See also

SingleRayTraceSettings

Settings for the Single Ray Trace analysis.

run_analysis() → SingleRayTraceResult#

Run the Single Ray Trace analysis.

Contents