zospy.analyses.wavefront.zernike_coefficients_vs_field.ZernikeCoefficientsVsFieldSettings

class zospy.analyses.wavefront.zernike_coefficients_vs_field.ZernikeCoefficientsVsFieldSettings

Bases: object

Settings for the Zernike vs. Field analysis.

For an in depth explanation of the parameters, see the OpticStudio user manual.

Attributes:

coefficientsstr

The Zernike coefficients that are calculated, as a comma-separated list of positive integers of ranges. For example, ‘1-8’ calculates coefficients 1 through 8 and ‘1,3-5,7’ calculates coefficients 1, 3, 4, 5 and 7. Defaults to ‘1-8’.

wavelengthint

The wavelength number that is to be used. Defaults to 1.

coefficients_typestr | constants.Analysis.Settings.Aberrations.ZernikeCoefficientTypes

Determines which Zernike coefficients are to be calculated. Should be one of [‘Fringe’, ‘Standard’, ‘Annular’]. Defaults to ‘Standard’.

field_scanstr | constants.Analysis.Settings.Aberrations.FieldScanDirections

The field scan direction. Should be one of [‘+y’, ‘-y’, ‘+x’, ‘-x’]. Defaults to ‘+y’.

field_densityint

The field density. Defaults to 20.

samplingstr | constants.Analysis.SampleSizes

The sampling, formatted as ‘…x…’ where the dots represent numbers (e.g. ‘64x64’). Defaults to ‘64x64’.

obscurationfloat

The obscuration factor. Is only used when coefficient_type == ‘Annular’. Defaults to 0.5.

minimum_plot_scalefloat

The minimum plot scale. When 0, OpticStudio will choose the value. Defaults to 0.

maximum_plot_scalefloat

The maximum plot scale. When 0, OpticStudio will choose the value. Defaults to 0.

__init__(*args: Any, **kwargs: Any) → None