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

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_NS

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 

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

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

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!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

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

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 intended

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

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

I’m using the ZOS-API (ver. 2024 R1) with C# and creating an Open3DViewerExport (I3DViewerExport) bitmap of the Ray Trace.The bitmap gets generated to a file but includes the axis (X,Y,Z) in the lower left corner of the image.The application allows to turn this access off but I don’t see the option within the API. Is there anyway that the API can turn this off as well?Thanks.B.

In the last few weeks, I have received questions regarding how we can use the ZOS-API to pull single ray trace information. For convenience, I will post my answers here in a single post. I pulled together three different methods for extracting single ray trace data. Below I will list the methods with sample code in Python and Mathematica. I’m happy to provide samples in other languages if needed! If you have other methods you use for this kind of analysis, feel free to add them as a reply! Method 1 - Use the Single Ray Trace analysisThis method can be used to pull the results of the Single Ray Trace analysis window.  The benefit of this method is that the results are pulled for all surfaces at once. The drawback of this method is that the data is provided in text form. The output is a TXT file which must be parsed back into the program you are using. This is discussed in a bit more detail here: How to set RayInfo.Vignetted in ZOS-API_Python Python########### Define the constants across

Hi everyone, is there a way to select several cells of interest at once using ZOSAPI? Commands like GetObjectAt() and GetCellAt() allow you to select a certain object and certain cell, but - for instance - I want to select the Ref Object column in the NCE specifically for rows 2-5 and set a common value for them. Is there a command to select these cells at once (without having to loop through each object and set them individually) and then set a common value?

Hello,I have a question about a glass for the thermal infrared region, specifically IRG26 glass, present in the SCHOTT_IRG catalog.The Tolerance Wizard is not able to insert the tolerance on the Abbe number of this glass. Why? If the Abbe number is not clearly defined, can we trust the raytrace and therefore the evaluation of the chromatic aberrations?Thanks! 

Hi all, I’ve been modifying .zmx files using Python for a few years now and have been using my own module and PyZOS for a majority of it now.  However, my current project has a bit of a road block I’m not sure how to get around. What I would like to do is take a surface from a file I’ve already created and have it be the exact same surface in a different file.  I could have the code insert the surface, but if possible I’d like to avoid inserting and deleting surfaces as it may effect other parameters in the system (i.e. Merit Functions operands and whatnot).What I’m hoping to code is something like the followingimport zospy as zp zos = zp.ZOS()oss = zos.connect()oss.load(‘file1’)oss2 = zos.create_new_system()oss2.load(‘file2’) first_surface_file1 = oss.LDE.GetSurfaceAt(1)first_surface_file2 = oss2.LDE.GetSurfaceAt(1) #Modify somehow first_surface_file1 == first_surface_file2 #would like to be True I was thinking of somehow looping through the surface params but that’s proving difficult

In the IAS_ZernikeStandardCoefficients settings, there is a setting called :      ReferenceOBDToVertex  (not sure what OBD means)while in the GUI it is called:     Reference OPD to vertexwhich makes more sense 

Dear all, in progress of fully automating my data export  for my customized documentation, I am trying to access the data generated by the Zemax analysis windows by a standalone API application in python. While this works for most of the analysis, I am having trouble to get data from the vignetting window for further processing by using the GetResults() function. There is not data retrieved. Debugging shows, that there is indeed no data listed in the respective item. I double checked by exporting the data to a text file - this is also empty with respect to data.   My Code therefore  (simple example based on the available python api example 1) works as follows: vig = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.VignettingDiagramSettings) vig.WaitForCompletion() vig.ToFile(sampleDir + '\\API\\Python\\TextResults.txt') However, when I save the lens file, and reopen with a Zemax Instance, the vignetting window is displayed correctly and the

Hey, I’m very naïve to Zemax and ZOS-API. I just tried to find the setting and run the code, but I couldn’t see the results from the image simulation.I used the standalone application and here is my code.     # load local variables    ZOSAPI = zos.ZOSAPI    TheApplication = zos.TheApplication    TheSystem = zos.TheSystem        # Insert Code Here    file = "C:/2021/Zemax_Image_Simulation/test.zmx"    cfg = "C:/2021/Zemax_Image_Simulation/test.CFG"    TheSystem.LoadFile(file, False)    TheImageSimulation = TheSystem.Analyses.New_ImageSimulation()    analysisSettings = TheImageSimulation.GetSettings()        analysisSettings.ModifySettings(cfg, 'ISM_INPUTFILE', "Text_100p_3x3_2_g1196x1279_dist.png")    analysisSettings.ModifySettings(cfg, 'ISM_FIELDHEIGHT', '15')    analysisSettings.ModifySettings(cfg, 'ISM_FLIPIMAGE', '3')    analysisSettings.ModifySettings(cfg, 'ISM_OUTPUTFILE', 'Test1.png')        analysisSettings.LoadFrom(cfg)    a = TheImageSimulation.ApplyAndWaitForCompletion()