zospy.analyses.wavefront.zernike_standard_coefficients.ZernikeStandardCoefficients

class zospy.analyses.wavefront.zernike_standard_coefficients.ZernikeStandardCoefficients

Bases: BaseAnalysisWrapper[ZernikeStandardCoefficientsResult, ZernikeStandardCoefficientsSettings]

Zernike Standard Coefficients 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 Standard Coefficients 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 = '64x64', maximum_term: int = 37, wavelength: str | int = 1, field: str | int = 1, reference_opd_to_vertex: bool = False, surface: str | int = 'Image', sx: float = 0.0, sy: float = 0.0, sr: float = 0.0)

Create a new analysis wrapper.

Settings can be changed by passing the settings as keyword arguments. Use the with_settings method to specify the settings using a settings object.

Parameters:

settings_kwsdict[str, Any]

Arguments to set the settings of the analysis.

Raises:

ValueError

If settings is not a dataclass.

run_analysis() → ZernikeStandardCoefficientsResult

Run the Zernike Standard Coefficients analysis.