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!

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

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-API As 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.PrimarySystem and 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.PrimarySystem new_system = TheSystem.CopySystem() # does work here TheSystem = 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

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

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 “”

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 wavelength because 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 ! :)

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.Edito

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,

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:

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 = Automatic It’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 Thanks B.

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?

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_NSC_ShadedModel.py (non-seque

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

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

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 = True However, 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

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 map So 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

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!

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'}.

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! and UnboundLocalError: local variable 'zos' referenced before assignment I’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_Files = [] for files in

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 Enum implici

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

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 int

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 Thanks Hans-Jürgen

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

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