zospy.analyses.polarization.pupil_map.PolarizationPupilMap

zospy.analyses.polarization.pupil_map.PolarizationPupilMap#

class zospy.analyses.polarization.pupil_map.PolarizationPupilMap#

Bases: BaseAnalysisWrapper[PolarizationPupilMapResult | None, PolarizationPupilMapSettings]

Polarization pupil map 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 polarization pupil map 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__(*, jx: float = 1.0, jy: float = 0.0, x_phase: float = 0.0, y_phase: float = 0.0, wavelength: int = 1, field: int = 1, surface: Literal['Image'] | int = 'Image', sampling: str | int = '11x11', add_configs: str = '', sub_configs: str = '')#

Create a new polarization pupil map analysis.

See also

PolarizationPupilMapSettings

Settings for the polarization pupil map analysis.

run_analysis() → PolarizationPupilMapResult#

Run the polarization pupil map analysis.

Contents