Skip to main content

Main navigation

Documentation
Knowledge base
Forum
App catalog
GitHub

User account menu

Sign in

ZOS-API interface 2024 R1

Breadcrumb

Home
Developer documentation
ZOS-API interface 2024 R1
functions

Main Page
Namespaces
- Namespace List
- Namespace Members
  - All
    - a
    - b
    - c
    - d
    - e
    - f
    - g
    - h
    - i
    - k
    - l
    - m
    - n
    - o
    - p
    - q
    - r
    - s
    - t
    - u
    - v
    - w
    - x
    - y
    - z
  - Functions
  - Enumerations
    - a
    - b
    - c
    - d
    - e
    - f
    - g
    - h
    - i
    - k
    - l
    - m
    - n
    - o
    - p
    - q
    - r
    - s
    - t
    - u
    - v
    - w
    - x
    - y
    - z
Classes
- Class List
- Class Index
- Class Hierarchy
- Class Members
  - All
    - _
    - a
    - b
    - c
    - d
    - e
    - f
    - g
    - h
    - i
    - j
    - k
    - l
    - m
    - n
    - o
    - p
    - q
    - r
    - s
    - t
    - u
    - v
    - w
    - x
    - y
    - z
  - Functions
    - a
    - b
    - c
    - d
    - e
    - f
    - g
    - h
    - i
    - l
    - m
    - n
    - o
    - p
    - r
    - s
    - t
    - u
    - v
    - w
    - x
    - y
    - z
  - Properties
    - _
    - a
    - b
    - c
    - d
    - e
    - f
    - g
    - h
    - i
    - j
    - k
    - l
    - m
    - n
    - o
    - p
    - q
    - r
    - s
    - t
    - u
    - v
    - w
    - x
    - y
    - z
  - Events
Examples
- Example 01: New File and QuickFocus
  - C#
  - C++
  - Mathematica
  - Matlab
  - Python
- Example 02: NSC Ray Trace
  - C#
  - C++
  - Mathematica
  - Matlab
  - Python
- Example 03: Open File and Optimize
  - C#
  - C++
  - Mathematica
  - Matlab
  - Python
- Example 04: Retrieve Data from FFT MTF
  - C#
  - C++
  - Mathematica
  - Matlab
  - Python
- Example 05: Parsing a ZRD File
  - C#
  - C++
  - Mathematica
  - Matlab
  - Python
- Example 06: NSC Phase
  - C#
  - C++
  - Matlab
  - Python
- Example 07: Tilt and Decenter Elements
  - C#
  - C++
  - Matlab
  - Python
- Example 08: NCE Detector Data
  - C#
  - C++
  - Matlab
  - Python
- Example 09: NSC CAD
  - C#
  - C++
  - Matlab
  - Python
- Example 10: NSC ZRD Filter String
  - C#
  - C++
  - Matlab
  - Python
- Example 11: Basic Sequential
  - C#
  - C++
  - Matlab
  - Python
- Example 12: Sequential System Explorer
  - C#
  - C++
  - Matlab
  - Python
- Example 14: Sequential Tolerance
  - C#
  - C++
  - Matlab
  - Python
- Example 15: Sequential Optimization
  - C#
  - C++
  - Matlab
  - Python
- Example 16: User-Defined Operand (UDOC)
  - C#
  - C++
- Example 17: Bulk Scatter
  - C#
  - C++
  - Matlab
  - Python
- Example 18: Multiple Configurations
  - C#
  - C++
  - Matlab
  - Python
- Example 19: Surface Properties
  - C#
  - C++
  - Matlab
  - Python
- Example 20: Exporting as CAD File
  - C#
  - C++
  - Matlab
  - Python
- Example 21: White LED Phosphor
  - C#
  - C++
  - Matlab
  - Python
- Example 22: Sequential Analysis
  - C#
  - C++
  - Mathematica
  - Matlab
  - Python
- Example 23: Ray Fan User Analysis
  - C#
  - C++
  - Matlab
  - Python
- Example 24: Non-Sequential Detector Data
  - C#
  - C++
  - Matlab
  - Python
- Example 25: Source Spectrum Diffraction Grating
  - C#
  - C++
  - Matlab
  - Python
- Example 26: Modify OpticStudio Preferences
  - C#
  - C++
  - Matlab
  - Python

On this page

functions

Last update: 17.07.2025

Here is a list of all class members with links to the classes they belong to:

- _ -

_S_ABg : ZOSAPI.Editors.LDE.ISurfaceScatteringType, ZOSAPI.Editors.NCE.IObjectScatteringSettings
_S_ABgFile : ZOSAPI.Editors.LDE.ISurfaceScatteringType, ZOSAPI.Editors.NCE.IObjectScatteringSettings
_S_AngleScattering : ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings
_S_Aplanatic : ZOSAPI.Editors.ISolveData
_S_Automatic : ZOSAPI.Editors.ISolveData
_S_Birefringent : ZOSAPI.Editors.NCE.IIndexModelSettings
_S_BlackBodySpectrum : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_BSDF : ZOSAPI.Editors.LDE.ISurfaceScatteringType, ZOSAPI.Editors.NCE.IObjectScatteringSettings
_S_Catalog : ZOSAPI.Editors.LDE.ISurfaceScatteringType
_S_CenterOfCurvature : ZOSAPI.Editors.ISolveData
_S_ChiefRayAngle : ZOSAPI.Editors.ISolveData
_S_ChiefRayHeight : ZOSAPI.Editors.ISolveData
_S_ChiefRayNormal : ZOSAPI.Editors.ISolveData
_S_CIE1931Chromaticity : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_CIE1931RGB : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_CIE1931Tristimulus : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_CIE1976 : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_CircularAperture : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_CircularObscuration : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_CocentricRadius : ZOSAPI.Editors.ISolveData
_S_CocentricSurface : ZOSAPI.Editors.ISolveData
_S_ColorTemperature : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_Compensator : ZOSAPI.Editors.ISolveData
_S_ConfigPickup : ZOSAPI.Editors.ISolveData
_S_D65White : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_DLLDefinedScattering : ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings
_S_DuplicateSag : ZOSAPI.Editors.ISolveData
_S_EdgeThickness : ZOSAPI.Editors.ISolveData
_S_ElementPower : ZOSAPI.Editors.ISolveData
_S_EllipticalAperture : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_EllipticalObscuration : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_FieldPickup : ZOSAPI.Editors.ISolveData
_S_Fixed : ZOSAPI.Editors.ISolveData
_S_FloatingAperture : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_FNumber : ZOSAPI.Editors.ISolveData
_S_Gaussian : ZOSAPI.Editors.LDE.ISurfaceScatteringType, ZOSAPI.Editors.NCE.IObjectScatteringSettings
_S_GRIN : ZOSAPI.Editors.NCE.IIndexModelSettings
_S_InvertSag : ZOSAPI.Editors.ISolveData
_S_Isotropic : ZOSAPI.Editors.NCE.IIndexModelSettings
_S_ISScatterCatalog : ZOSAPI.Editors.NCE.IObjectScatteringSettings
_S_Lambertian : ZOSAPI.Editors.LDE.ISurfaceScatteringType, ZOSAPI.Editors.NCE.IObjectScatteringSettings
_S_MarginalRayAngle : ZOSAPI.Editors.ISolveData
_S_MarginalRayHeight : ZOSAPI.Editors.ISolveData
_S_MarginalRayNormal : ZOSAPI.Editors.ISolveData
_S_MaterialModel : ZOSAPI.Editors.ISolveData
_S_MaterialOffset : ZOSAPI.Editors.ISolveData
_S_MaterialSubstitute : ZOSAPI.Editors.ISolveData
_S_Maximum : ZOSAPI.Editors.ISolveData
_S_None : ZOSAPI.Editors.ISolveData, ZOSAPI.Editors.LDE.ISurfaceApertureType, ZOSAPI.Editors.LDE.ISurfaceScatteringType, ZOSAPI.Editors.NCE.IObjectScatteringSettings, ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings
_S_ObjectPickup : ZOSAPI.Editors.ISolveData
_S_OpticalPathDifference : ZOSAPI.Editors.ISolveData
_S_PhotoluminescenceModel : ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings
_S_PickupChiefRay : ZOSAPI.Editors.ISolveData
_S_Position : ZOSAPI.Editors.ISolveData
_S_PupilPosition : ZOSAPI.Editors.ISolveData
_S_RectangularAperture : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_RectangularObscuration : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_SpectrumFile : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_Spider : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_SurfacePickup : ZOSAPI.Editors.ISolveData
_S_SystemWavelengths : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_ThermalPickup : ZOSAPI.Editors.ISolveData
_S_UniformPowerSpectrum : ZOSAPI.Editors.NCE.ISourceColorSettings
_S_User : ZOSAPI.Editors.LDE.ISurfaceScatteringType, ZOSAPI.Editors.NCE.IObjectScatteringSettings
_S_UserAperture : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_UserObscuration : ZOSAPI.Editors.LDE.ISurfaceApertureType
_S_Variable : ZOSAPI.Editors.ISolveData
_S_ZPLMacro : ZOSAPI.Editors.ISolveData

Home

Documentation

Latest Articles
Ansys.com
Ansys Careers

Bottom center center

Ansys Help
Ansys Learning Hub
Ansys Support

Connect with Ansys

©2026 Copyright ANSYS, Inc

Footer menu

Legal Notices
Privacy Notice
Cookie Policy
Export Compliance
Terms and Conditions