zospy.analyses.physicaloptics.physical_optics_propagation.PhysicalOpticsPropagation

zospy.analyses.physicaloptics.physical_optics_propagation.PhysicalOpticsPropagation#

class zospy.analyses.physicaloptics.physical_optics_propagation.PhysicalOpticsPropagation#

Bases: BaseAnalysisWrapper[DataFrame | None, PhysicalOpticsPropagationSettings]

Physical Optics Propagation analysis.

Attributes:
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 Physical Optics Propagation 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__(*, wavelength: WavelengthNumber = 'All', field: int = 1, start_surface: Literal['Ent. Pupil'] | int = 1, end_surface: Literal['Image'] | int = 'Image', surface_to_beam: float = 0, use_polarization: bool = False, separate_xy: bool = False, use_disk_storage: bool = False, beam_type: constants.Analysis.PhysicalOptics.POPBeamTypes | str = 'GaussianWaist', beam_file: str = '', beam_parameters: dict | None = None, x_sampling: constants.Analysis.SampleSizes | str | int = 32, y_sampling: constants.Analysis.SampleSizes | str | int = 32, x_width: float = 1, y_width: float = 1, use_total_power: bool = False, total_power: float = 1, use_peak_irradiance: bool = True, peak_irradiance: float = 1, show_as: constants.Analysis.PhysicalOptics.POPShowAsTypes | str = 'FalseColor', data_type: constants.Analysis.PhysicalOptics.POPDataTypes | str = 'Irradiance', project: constants.Analysis.PhysicalOptics.POPProjectionTypes | str = 'AlongBeam', contour_format: str = '', plot_scale: float = 0, scale_type: constants.Analysis.PhysicalOptics.POPScaleTypes | str = 'Linear', zoom_in: constants.Analysis.PhysicalOptics.POPZoomTypes | str = 'NoZoom', row_or_column: int | str = 'Center', zero_phase_level: float = 0.001, save_output_beam: bool = False, output_beam_file: str = '', save_beam_at_all_surfaces: bool = False, compute_fiber_coupling_integral: bool = False, ignore_fiber_polarization: bool = True, fiber_type: constants.Analysis.PhysicalOptics.POPFiberTypes | str = 'GaussianWaist', fiber_position: constants.Analysis.PhysicalOptics.POPFiberPositions | str = 'ChiefRay', tilt_about_x: float = 0, tilt_about_y: float = 0, fiber_type_file: str = '', fiber_parameters: dict | None = None, auto_calculate_beam_sampling: bool = False, settings: PhysicalOpticsPropagationSettings | None = None)#

Create a Physical Optics Propagation analysis.

See also

PhysicalOpticsPropagationSettings

Settings for the Physical Optics Propagation analysis.

run_analysis() → DataFrame#

Run the Physical Optics Propagation analysis.

Contents