zospy.analyses.psf.fft_psf.FFTPSF

zospy.analyses.psf.fft_psf.FFTPSF#

class zospy.analyses.psf.fft_psf.FFTPSF#

Bases: BaseAnalysisWrapper[DataFrame | None, FFTPSFSettings]

FFT Point Spread Function (PSF) 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 FFT 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__(*, sampling: str | int = '32x32', display: str | int = '32x32', rotation: Literal[0, 90, 180, 270] = 0, wavelength: WavelengthNumber = 'All', field: int = 1, psf_type: str | constants.Analysis.Settings.Psf.FftPsfType = 'Linear', use_polarization: bool = False, image_delta: float = 0, normalize: bool = False, surface: Literal['Image'] | int = 'Image')#

Create a new FFT PSF analysis.

See also

FFTPSFSettings

Settings for the FFT PSF analysis.

run_analysis() DataFrame | None#

Run the FFT PSF analysis.