zospy.analyses.wavefront.zernike_coefficients_vs_field.ZernikeCoefficientsVsField

zospy.analyses.wavefront.zernike_coefficients_vs_field.ZernikeCoefficientsVsField#

class zospy.analyses.wavefront.zernike_coefficients_vs_field.ZernikeCoefficientsVsField#

Bases: BaseAnalysisWrapper[DataFrame, ZernikeCoefficientsVsFieldSettings]

Zernike Coefficients vs. Field 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 Zernike Coefficients vs. Field 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__(*, coefficients: str = '1-8', wavelength: int = 1, coefficients_type: str | constants.Analysis.Settings.Aberrations.ZernikeCoefficientTypes = 'Standard', field_scan: FieldScanDirection | constants.Analysis.Settings.Aberrations.FieldScanDirections = '+y', field_density: int = 20, sampling: str = '64x64', obscuration: float = 0.5, minimum_plot_scale: float = 0, maximum_plot_scale: float = 0)#

Create a new Zernike Coefficients vs. Field analysis.

See also

ZernikeCoefficientsVsFieldSettings

Settings for the Zernike Coefficients vs. Field analysis.

run_analysis() → DataFrame#

Run the Zernike Coefficients vs. Field analysis.

Contents