zospy.analyses.psf.huygens_psf.BaseHuygensPSF

zospy.analyses.psf.huygens_psf.BaseHuygensPSF#

class zospy.analyses.psf.huygens_psf.BaseHuygensPSF#

Bases: BaseAnalysisWrapper[AnalysisData, HuygensPSFSettings], ABC, Generic[AnalysisData]

Base class for Huygens Point Spread Function (PSF) analyses.

Attributes:
MODE
TYPE
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 Huygens PSF 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__(*, pupil_sampling: str | int = '32x32', image_sampling: str | int = '32x32', image_delta: float = 0, rotation: int = 0, wavelength: str | int = 'All', field: str | int = 1, psf_type: str | constants.Analysis.Settings.HuygensPsfTypes = 'Linear', show_as: str | constants.Analysis.HuygensShowAsTypes = 'Surface', use_polarization: bool = False, use_centroid: bool = False, normalize: bool = False)#

Create a new Huygens PSF analysis.

See also

HuygensPSFSettings

Settings for the Huygens PSF analysis.

run_analysis() → DataFrame | None#

Run the Huygens PSF analysis.

Contents