Skip to main content
Ctrl+K

ZOSPy documentation

  • ZOSPy

Contents

  • Frequently Asked Questions
  • Compatibility
  • Examples
    • Simple thick lens
    • Creating the Escudero-Sanz eye model with ZOSPy
    • Polarization prism with total internal reflection
  • API documentation
    • zospy.zpcore
      • zospy.zpcore.OpticStudioSystem
      • zospy.zpcore.ZOS
    • zospy.analyses
      • zospy.analyses.base
        • zospy.analyses.base.new_analysis
        • zospy.analyses.base.Analysis
        • zospy.analyses.base.AnalysisMessage
        • zospy.analyses.base.AnalysisMetadata
        • zospy.analyses.base.AnalysisResult
        • zospy.analyses.base.AttrDict
        • zospy.analyses.base.OnComplete
      • zospy.analyses.mtf
        • zospy.analyses.mtf.fft_through_focus_mtf
        • zospy.analyses.mtf.fft_through_focus_mtf_fromcfg
      • zospy.analyses.polarization
        • zospy.analyses.polarization.polarization_pupil_map
        • zospy.analyses.polarization.transmission
        • zospy.analyses.polarization.PupilMapData
        • zospy.analyses.polarization.TransmissionData
      • zospy.analyses.psf
        • zospy.analyses.psf.huygens_psf
      • zospy.analyses.raysandspots
        • zospy.analyses.raysandspots.ray_fan
        • zospy.analyses.raysandspots.single_ray_trace
      • zospy.analyses.reports
        • zospy.analyses.reports.cardinal_points
        • zospy.analyses.reports.cardinal_points_fromcfg
        • zospy.analyses.reports.surface_data
        • zospy.analyses.reports.surface_data_fromcfg
        • zospy.analyses.reports.system_data
      • zospy.analyses.surface
        • zospy.analyses.surface.curvature
      • zospy.analyses.systemviewers
        • zospy.analyses.systemviewers.cross_section
        • zospy.analyses.systemviewers.nsc_3d_layout
        • zospy.analyses.systemviewers.nsc_shaded_model
        • zospy.analyses.systemviewers.shaded_model
        • zospy.analyses.systemviewers.viewer_3d
      • zospy.analyses.wavefront
        • zospy.analyses.wavefront.zernike_standard_coefficients
    • zospy.api.constants
      • zospy.api.constants.get_constantname_by_value
      • zospy.api.constants.process_constant
    • zospy.functions
      • zospy.functions.lde
        • zospy.functions.lde.find_surface_by_comment
        • zospy.functions.lde.get_pupil
        • zospy.functions.lde.surface_change_type
        • zospy.functions.lde.PupilData
      • zospy.functions.nce
        • zospy.functions.nce.find_object_by_comment
        • zospy.functions.nce.get_object_data
        • zospy.functions.nce.object_change_type
    • zospy.solvers
      • zospy.solvers.element_power
      • zospy.solvers.fixed
      • zospy.solvers.material_model
      • zospy.solvers.position
      • zospy.solvers.surface_pickup
      • zospy.solvers.variable
  • Contributing to ZOSPy
  • Changelog
  • .md

API documentation

API documentation#

zospy.zpcore

zospy.analyses

OpticStudio Analyses.

zospy.api.constants

Constants for the ZOS-API.

zospy.functions

Utility functions for ZOSPy.

zospy.solvers

OpticStudio Solvers.

previous

Polarization prism with total internal reflection

next

zospy.zpcore

By Jan-Willem M. Beenakker, Luc van Vught, Corné Haasjes

© Copyright 2023, Jan-Willem M. Beenakker, Luc van Vught, Corné Haasjes.