zospy.analyses.raysandspots.ray_fan.RayFan

zospy.analyses.raysandspots.ray_fan.RayFan#

class zospy.analyses.raysandspots.ray_fan.RayFan#

Bases: BaseAnalysisWrapper[RayFanResult, RayFanSettings]

Ray Fan 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 Ray Fan analysis.

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 Ray Fan 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__(*, plot_scale: float = 0, number_of_rays: int = 10, field: int | Literal['All'] = 'All', wavelength: int | Literal['All'] = 'All', tangential: str | constants.Analysis.Settings.Fans.TangentialAberrationComponent = 'Aberration_Y', sagittal: str | constants.Analysis.Settings.Fans.SagittalAberrationComponent = 'Aberration_X', surface: str | int = 'Image', use_dashes: bool = False, vignetted_pupil: bool = True, check_apertures: bool = True)#

Create a new Ray Fan analysis.

See also

RayFanSettings

Settings for the Ray Fan analysis.

get_data_series() → RayFanResult | None#

Get the data series from the Ray Fan analysis.

run_analysis() → RayFanResult#

Run the Ray Fan analysis.

Contents