ZOSAPI.Analysis.Settings.Aberrations.IAS_FullFieldAberration Interface Reference
Last update: 17.07.2025
Inheritance diagram for ZOSAPI.Analysis.Settings.Aberrations.IAS_FullFieldAberration:
Public Member Functions | |
| bool | SetAberrationByType (FFA_AberrationTypes type) |
| Use the specified aberration type. | |
| bool | SetAberrationByNumber (int aberrationNumber) |
| Use the specified Zernike term. | |
 Public Member Functions inherited from ZOSAPI.Analysis.Settings.IAS_ | |
| IMessages | Verify () |
| void | Save () |
| Saves the current settings to the default CFG file. | |
| void | Load () |
| Loads settings from the default CFG file. | |
| void | Reset () |
| Resets the settings back to the defaults for the current analysis. | |
| bool | SaveTo (string settingsFile) |
| Saves the current settings to the specified file. | |
| bool | LoadFrom (string settingsFile) |
| Replaces the current settings with settings read from the specified file. | |
| bool | ModifySettings (string settingsFile, string typeCode, string newValue) |
| Changes a single setting in the specified file. See the MODIFYSETTINGS DDE command help documentation for more information. | |
Properties | |
| FFA_FieldShapes | FieldShape [get, set] |
| double | XFieldWidth [get, set] |
| double | YFieldWidth [get, set] |
| FFA_DecompositionTypes | Decomposition [get, set] |
| int | MaximumTerm [get, set] |
| FFA_AberrationTypes | AberrationType [get] |
| Type of aberration. If AberrationType is FFA_AberrationTypes.SpecifiedTerm, see AberrationNumber | |
| int | AberrationNumber [get] |
| The Zernike term of the aberration when AberrationType is FFA_AberrationTypes.SpecifiedTerm, otherwise 0. | |
| IAS_Wavelength | Wavelength [get] |
| IAS_Field | Field [get] |
| int | XFieldSampling [get, set] |
| int | YFieldSampling [get, set] |
| SampleSizes | PupilSampling [get, set] |
| FFA_ShowAsTypes | ShowAs [get, set] |
| FFA_DisplayTypes | Display [get, set] |
Member Function Documentation
◆ SetAberrationByNumber()
| bool ZOSAPI.Analysis.Settings.Aberrations.IAS_FullFieldAberration.SetAberrationByNumber | ( | int | aberrationNumber | ) |
Use the specified Zernike term.
- Parameters
-
aberrationNumber
- Returns
truefor any valid term (1 to 231), otherwisefalse
◆ SetAberrationByType()
| bool ZOSAPI.Analysis.Settings.Aberrations.IAS_FullFieldAberration.SetAberrationByType | ( | FFA_AberrationTypes | type | ) |
Use the specified aberration type.
- Parameters
-
type Any valid aberration type (not FFA_AberrationTypes.SpecifiedTerm)
- Returns
truefor any valid FFA_AberrationTypes, otherwisefalse
Property Documentation
◆ AberrationNumber
|
get |
The Zernike term of the aberration when AberrationType is FFA_AberrationTypes.SpecifiedTerm, otherwise 0.
◆ AberrationType
|
get |
Type of aberration. If AberrationType is FFA_AberrationTypes.SpecifiedTerm, see AberrationNumber
◆ Decomposition
|
getset |
◆ Display
|
getset |
◆ Field
|
get |
◆ FieldShape
|
getset |
◆ MaximumTerm
|
getset |
◆ PupilSampling
|
getset |
◆ ShowAs
|
getset |
◆ Wavelength
|
get |
◆ XFieldSampling
|
getset |
◆ XFieldWidth
|
getset |
◆ YFieldSampling
|
getset |
◆ YFieldWidth
|
getset |
