Skip to main content

ZOS-API

Find and share your best practices for using the ZOS-API here!

  • 373 Topics
  • 1,159 Replies
373 Topics
M
ma-sundeInfrared
asked in ZOS-API
Large amount of single ray trace

Hi, I’m currently trying to trace a large amount (~1 million) of rays with very specific output position and trace their path length it takes them to reach a detector and then output the position as well as the specific path length of that beam. Currently not using scattering, but in future, I would like to extend this to scattering as well. My first thought was to create a loop that would create single rays, trace them, return the OPL through a Merit Function and then output in the end, but I assume that this would take forever to compute. Any idea how this would be done more efficiently? I’ve seen that batch ray trace might be an option, but I don’t know enough about it or other alternatives to evaluate correctly. Thank you for any help!

363
David.Nguyen
Luminary
Sebastien G.
Sebastien G.Single Emitter
asked in ZOS-API
Working on a copy and update when done

Hello, I am working on a macro as described in the following article, but converted in Python:https://support.zemax.com/hc/en-us/articles/1500005579082-Modeling-Rotationally-Symmetric-Irregularity-RSI-with-the-APIAs working directly on the system, each modification saves an UNDO file and the action is repeated for each Zernike coefficient, for each surfaces, that slows down the execution.The actual way :Get the system with :TheSystem = TheApplication.PrimarySystemand work on it directly I tried to get a copy of the system with the CopySystem function, modify the copy and push it back :TheSystem = TheApplication.PrimarySystemnew_system = TheSystem.CopySystem()# does work hereTheSystem = new_system.CopySystem() When looking at the surface type of TheSystem, I can see that it changed correctly, however it is not applied in the Zemax main window.I used the TheSystem.UpdateStatus() function, but does not help. Ideally my goal would be to be able to make all modifications outside of Zemax an

553
Sebastien G.
Allie
Zemax Staff
AllieZemax Staff
asked in ZOS-API
Methods for extracting detector data through the API

How can I extract detector data using the API? And how can I be sure I'm using the correct settings?

351217
mocquin
Ultraviolet
mocquin
Ultraviolet
mocquinUltraviolet
asked in ZOS-API
FindMaterialCatalog returns first catalog for material ABSORB

This looks like a bug in ZOS API : when calling FindMaterialCatalog on a row of a non-sequential model with ABSORB as mateial, it returns the first catalog in the available catalog listI would except this call to return None or “”

181
David.Nguyen
Luminary
mocquin
Ultraviolet
mocquinUltraviolet
asked in ZOS-API
Guidelines for spectral depedencies summup

In non-sequential mode, I am trying to automate the process of reviewing any input data that is spectral. The idea is to review how all models (in the wide sense) behave wrt wavelength in a quick way to make sure there’s nothing shady happening, using the ZOS API.For now I’m trying to review :  - all coatings used, and their spectral response wrt incidence angle and wavelength - all materials used and their refractive index and extinction response wrt wavelengthbecause given the complexity of a NSC model, the complexity of coatings definitions/catalogs, material definition/catalogs, a mistake can happen quickly.For now the idea is to review those spectral model dependencies only in a “passive” manner, using the NCE - without running a raytrace specifiicaly.If anyone has ideas or guideline on this process, feel free to comment ! :)

60
mocquin
Ultraviolet
ztystar
ztystarInfrared
asked in ZOS-API
Unable to set up diffraction DLL for User Defined Object in non-sequential mode

Hi all, I am trying to use ZOS API to assign the diffraction-based dll for the User Defined Object in Non-sequential mode. I have tried normal ‘Diffraction Grating’ object and it works good, however, for the User Defined Object, it did not work. Could anybody share some insights for me? Thank you! Part of the code for normal ‘Diffraction Grating’ object: (This works!)TheNCE.InsertNewObjectAt(1);o1 = TheNCE.GetObjectAt(1);o1.ChangeType(o1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DiffractionGrating));o1.DiffractionData.Split=ZOSAPI.Editors.NCE.DiffractionSplitType.SplitByDLL;o1.DiffractionData.DLL='srg_trapezoid_RCWA.DLL';o1.DiffractionData.StartOrder=-1;o1.DiffractionData.StopOrder=1; Part of the code for ‘User Defined Object’: (This  does not work!)TheNCE.InsertNewObjectAt(1);o1 = TheNCE.GetObjectAt(1);o1.ChangeType(o1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.UserDefinedObject));o1.Comment = 'DiffractionGrating.DLL';o1.DiffractionData.Split=ZOSAPI.Editors.NCE.Diff

201
ztystar
mocquin
Ultraviolet
mocquinUltraviolet
asked in ZOS-API
Unable to use the raydatabase and filter on NSC detectorviewer in ZOS API

I don’t understand how I should set the Filter and RayDatabaseFile of the DetectorViewer in non-sequential mode.SHould I use : DetectorView = zos.system.Analyses.New_DetectorViewer()or :DetectorView = zos.system.Analyses.New_Analysis(zos.ZOSAPI.Analysis.AnalysisIDM.DetectorViewer)Then should I use :        settings = DetectorView.GetSettings()and/or ?        settings = zos.ZOSAPI.Analysis.Settings.RayTracing.IAS_DetectorViewer(settings)Then using :         settings.RayDatabaseFilename = db_file        settings.Filter = "h9"Those seems to make the analysis fail       

80
mocquin
Ultraviolet
David
Luminary
DavidLuminary
posted in ZOS-API
Accessing filtered detector data with ZOSAPI

I would like to access, through ZOSAPI, detector data which has been fitered by a filter string. I know how to access detector data through ZOSPI. And it is of course possible to view filtered data in OpticStudio by saving a trace to a ZRD file and specifiying that as the database for a detector viewer. The filter string can be applied as the ZRD is saved, or applied in the settings of the detector viewer. But I would ike to access the filtered data as it is viewed in the detector viewer, rather than the unfiltered data. Is this possible? I am actually using ZOSAPI from Mathematica, but an answer related to Python or C++ would be useful.  Kind regards, David,

4504
mocquin
Ultraviolet
mocquin
Ultraviolet
mocquinUltraviolet
asked in ZOS-API
ZOS API : add cutting plane feature to NSC layouts

Following, Feature Request: ZOS-API Layouts Exports Completion | Zemax Community, I’d also advocate for making the 3 cutting plane tools from the NSC Shaded model available in ZOS API.Those cutting tools are quite efficient in visualisation, and sometimes even absolutely necessary. Now that we can export the shaded model to png easily, it’d be great to be able to enable/disable those cutting planes as well. In the same manner, having access to the Camera View would be nice:  

80
mocquin
Ultraviolet
Brian
BrianInfrared
asked in ZOS-API
Local Optimization failure

I am using the ZOS-API in C# with 4.8.1 framework using Zemax OpticStudio 2024 R1.02 and getting an error message when running the Local Optimization tool.The error message returned from running the tool is “Input settings are invalid”.This occurs only when I load from an Archive File (.ZAR).   If I load from a model file (.ZMX) then the Local Optimization tool works as expected.For the fields that I set, there are only 2; Algorithm = DampedLeastSquares and Cycles = AutomaticIt’s weird and I can’t understand the difference between accessing the model from an Archive would create this issue. NOTE, that I did load the ZAR file from the actual Zemax application and Optimization worked fine. If anyone has any ideas as to the issue then please let me know ThanksB.

884
Brian
Matt H
Matt HMonochrome
asked in ZOS-API
Updating Spot Diagram

The ray density of the spot diagram is not being updated as expected; I have tried two different methods: # spot diagramspot = TheSystem.Analyses.New_StandardSpot()spot.GetSettings.RayDensity = 15spot.ApplyAndWaitForCompletion() newSpot = TheSystem.Analyses.New_StandardSpot()print("Spot has analysis specific settings? ", newSpot.HasAnalysisSpecificSettings) # True; no ModifySettingsnewSettings = newSpot.GetSettings()newSettings.RayDensity = 15newSpot.ApplyAndWaitForCompletion() However, after being run the ray density of the spot diagram does not update as expected - any ideas?

471
David.Nguyen
Luminary
Xianglei
XiangleiMonochrome
posted in ZOS-API
API_Layout_plot_Python

API support for the Cross-Section, 3D Layout, and Shaded Models is added to the OpticStudio API.  The support allow users to change the settings via the API and retrieve a static image.  Layouts in both sequential and non-sequential mode are supported. Some toolbar buttons, such as automatically setting camera viewpoints, will also be accessible via the API. Please download the following Python Standalone codes, including:PythonStandaloneApplication_SEQ_layout.py       (sequential mode and export 2D cross-section) TheSystem.Tools.OpenCrossSectionExport()   # the core command  PythonStandaloneApplication_SEQ_3DViewer.py (sequential mode and export 3D viewer) TheSystem.Tools.Open3DViewerExport() PythonStandaloneApplication_SEQ_ShadedModel.py (sequential mode and export shaded model) TheSystem.Tools.OpenShadedModelExport() PythonStandaloneApplication_NSC_3D.py              (non-sequential mode and export 3D layout) TheSystem.Tools.OpenNSC3DLayoutExport() PythonStandaloneApplication_NS

98627
mocquin
Ultraviolet
Samia.O
Samia.OSingle Emitter
asked in ZOS-API
Connection problems between Zemax and Matlab

Hello everyone,I can't connect Zemax and Matlab since I installed the new version of zemax 2025 R1.01. I am using Matalb version 2019a Updates 9 and it worked with previous versions of zemax.The error in question Unable to load one or more of the required types.My two applications are installed in 64bits I've already tried uninstalling and reinstalling the applications. Thanks for your help 

380
Samia.O
L
Leonid.PascarInfrared
asked in ZOS-API
retrieving pop beam via ZOS_API Python

Hi, I try to retrieve the output POP field distrubution via python. I looked in the help at IAS_PhysicalOpticsPropagation and couldn't find direct way to do it. I know I can manually save ZBF files and then load, but I need a script as I change parameters and want to retrieve the output beam. How would you advise to do so?   Thanks, Leonid

5373
SJ314
S
Sebastián.GedeonSingle Emitter
asked in ZOS-API
Ignoring multiple surfaces at once, ZOSAPI, python

Hello fellow optics enthusiasts,I’m currently working on a task where I need to ignore multiple surfaces in a Zemax optical system using the ZOS-API. At the moment, I’m using the following loop:for i in range(150, 160): surface = TheSystem.LDE.GetSurfaceAt(i) surface.TypeData.IgnoreSurface = TrueHowever, this approach seems to be quite slow. Has anyone found a more efficient way to ignore multiple surfaces at once?Any insights or suggestions would be greatly appreciated!Thanks in advance,Sebastián

472
S
A
Ultraviolet
AmitUltraviolet
asked in ZOS-API
Genarating Wavefront maps while varying sag on a surface

Hello Everyone,What is the best way to create sag on a lens surface (one of the two surfaces would be the beginning, and then I would move to both surfaces) and parametrize it using python so that i can create wavefront maps and the changes in the wavefront maps based on the localized changed in the sag?Here is what I want to do:Create sag on a lens surface that can be parametrized (conic constant and the other asphere constants can be varied) For each combination of these parameters, evaluate the wavefront mapSo far, the knowledgebase articles show how to use a .dat file to induce sag on surfaces, but there is nothing about parameterization.Is there a Python example that does something similar?Or is there any other method that would make more sense? Thank you for your insights.Amit

230
A
Ultraviolet
joshdfreeman
Ultraviolet
joshdfreemanUltraviolet
asked in ZOS-API
Access coating properties in ZOS-API?

Is there a way to access the properties of a coating in the ZOS-API? The article below shows how to access the name of the coating, but does not show how to get the properties of the coating.I’m not finding any handles that give the actual coating information. Thanks!

1573
mocquin
Ultraviolet
c​hris
c​hrisInfrared
posted in ZOS-API
ZOS API: says the coating is None in the API, but OpticStudio says there is a coating

In the API, I make some checks on the ZMX file before running simulations. One of the checks is that at least face 0 has a coating. The API tells me there is no coating, but I can see in OpticStudio that there is a coating. Here is the object in OpticStudio: And the coating from the API: I'm certain I have the right object - why is the coating incorrect in the API? How can I check for the existence of coatings on face 0? Right now I'm using face_data.Coating not in {'None', 'NULL'}.

1304
mocquin
Ultraviolet
Daniel Dominguez
Daniel DominguezSingle Emitter
asked in ZOS-API
How to perform Standard Zernike Analysis across multiple files simultaneously using Zemax Python API and Multiprocessing

Hi all - As the title states, I’m attempting to perform a Standard Zernike Analysis across multiple files simultaneously using the Zemax Python API and Multiprocessing (running 4 instances of Zemax). My attempt is shown below. Failures I’ve encountered include: *** FRU__delta_init(): Attempt to start when running!andUnboundLocalError: local variable 'zos' referenced before assignmentI’m not sure if my approach is flawed or if I’m just attempting something that’s not allowed with Zemax or something else. Any insight you can provide would be greatly appreciated. Thanks! Also, thank you to David Nguyen for his example code on performing a Zernike Standard Analysis here.if __name__ == '__main__': import multiprocessing as mp import os import glob from ShortZernMonolith import ShortZernMonolith documents_path = os.path.join(os.path.expanduser("~"), "Documents") directory_path = documents_path + "\\SenseCheck" # Create list of TSAV*.zmx files found in folder TSAV_File

571
chaasjes
Matt H
Matt HMonochrome
asked in ZOS-API
Cannot Set Source Sampling in NSC

I am unable to set the source sampling in NSC; here is my code: led_source = TheNCE.GetObjectAt(1)led_source_type = led_source.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.SourceRadial)led_source.ChangeType(led_source_type) led_source.SourcesData.PrePropagation = -1print("Preprop: ", led_source.SourcesData.PrePropagation)print("Sampling: ", led_source.SourcesData.SamplingMethod)led_source.SourcesData.SamplingMethod = "Sobol"print("Sampling: ", led_source.SourcesData.SamplingMethod) Note Pre-propagation can be [set, get] through SourceData, whereas SamplingMethod can only be [get]. When I execute this code I get the following: Preprop:  -1.0Sampling:  SobolTraceback (most recent call last):  File "C:\Users\matthew.haines\Documents\Zemax\ZOS-API Projects\PythonStandaloneApplication4\PythonStandaloneApplication4\PythonStandaloneApplication4.py", line 226, in <module>    led_source.SourcesData.SamplingMethod = "Sobol"TypeError: since Python.NET 3.0 int can not be converted to

482
Matt H
L
Luca.OggioniMonochrome
asked in ZOS-API
Error using ZOS-API in Matlab

My codes (that were working with the 2024 version) do not work anymore with the 2025 release.this is the error I get in the function “InitConnection()”:Message: Could not load file or assembly 'ZemaxEngine.dll' or one of its dependencies. The dynamic link library (DLL) initialization routine failed. (Exception from HRESULT: 0x8007045A)Source: mscorlibHelpLink: None

53511
Prasath R
Zemax Staff
M
ma-sundeInfrared
asked in ZOS-API
ZOS-API: NumSegs=0 from IRayTraceNSCData.ReadNextResult for All Manually Added Rays

Hi all,I'm using the ZOS-API in Python (OpticStudio 2024 R1) with IBatchRayTrace to trace manually defined NSC rays. I'm creating the interface using teh batch tool and adding rays using nscData.AddRay(...).The trace completes successfully (batchTool.Succeeded is True, and RunAndWaitForCompletion() doesn't crash ). However, when I read the results using nscData.ReadNextResult(), the numSegments output parameter is consistently 0 for all rays. This happens even when:The system is minimal (new file, 1 wavelength, 1 Standard Lens, 1 Detector Rectangle). Rays are defined with various trace options (None, UsePolarization, UseSplitting, UseScattering, and combinations). The ray path clearly interacts with objects (e.g., passes through the lens and hits the detector).It also doesnt show any errors...Is it expected that IRayTraceNSCData.ReadNextResult will return numSegments = 0 for simple interactions like refraction or absorption when rays are launched via AddRay? If so, what is the intended

605
MichaelH
Ansys Staff
Hans-Jürgen Feige
Hans-Jürgen FeigeVisible
asked in ZOS-API
ZOS-API "GETZERNIKE"

Hello,We are urgently looking for an alternative to ZPL-GETZERNIKE using ZOS-API.The point is that we cannot tell “TheSystem.MFE.GetOperandValue(MeritOperandType_ZERN, “ the maximum term of Zernike.“TheSystem.MFE.GetOperandValue(MeritOperandType_ZERN, “ always develops only up to the given coefficient :-(MAny ThanksHans-Jürgen

93917
Michael Cheng
Zemax Staff
Jeff.Wilde
Luminary
Jeff.WildeLuminary
asked in ZOS-API
ZOS-API Initialization Error in Matlab

It appears that there is a known ZOS-API initialization error when using OpticStudio 2025 R1.  Here’s what is stated in the 2025 R1 release notes: I’m currently using OpticStudio 2025 R1.01 and encountering this problem with Matlab R2021a (which previously worked fine with OpticStudio versions prior to 2025).Does anyone know if updating to the latest Matlab release will solve the problem?  If not, I wonder how/when this bug will be resolved?Thanks,Jeff

2355
B
mocquin
Ultraviolet
mocquinUltraviolet
asked in ZOS-API
Dispersion Diagram in ZOS API

Can you confirm that neither setting the paramters of a dispersion diagram or reading the results is possible through the API ?I couldn’t find any settings neither extract some dataseries results

181
mocquin
Ultraviolet

Badge winners

  • Allow me to introduce myself
    Bharathas earned the badge Allow me to introduce myself
  • Allow me to introduce myself
    Yryxhas earned the badge Allow me to introduce myself
  • Allow me to introduce myself
    curiouslearnerhas earned the badge Allow me to introduce myself
  • Allow me to introduce myself
    Bharadwajhas earned the badge Allow me to introduce myself
  • Visibly Un-Polarized
    John.Hygelundhas earned the badge Visibly Un-Polarized
Show all badges
Community Posting GuidelinesCookie settings


Zemax Community

Need more help?

To Chinese users:

Do not provide any information or data that is restricted by applicable law, including by the People’s Republic of China’s Cybersecurity and Data Security Laws ( e.g., Important Data, National Core Data, etc.).


不要提供任何受适用法律，包括中华人民共和国的网络安全和数据安全法限制的信息或数据（如重要数据、国家核心数据等）。



Privacy policy   License Agreements    Terms of use    Cookie Policy   Zemax Account Licensing Policies