Skip to main content

Programming OpticStudio

Share your solutions or ask questions about the ZOS-API, ZPL, or DLLs. Code shared in these spaces is not reviewed by Zemax except for the Code Exchange.

713 Topics
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
New to the Code Exchange? Read this!

The Code Exchange is a moderated community where Zemax users can find or share programming solutions to extend OpticStudio’s capabilities. It can be a macro to read the sag of a surface or a DLL to define a phase surface. Browse through our space to find out what we have or share your own!Just a few things before getting started:These solutions are mostly written by optical engineers and not developers. Use them as a starting point and feel free to improve them. Comment on the post if you make an improvement or find something interesting that could be useful to other users!  Do you have a solution to share? Create a topic in the Code Exchange category using the tag Code Exchange. Be sure to include a ReadMe doc. An example template is attached. Once posted, our team will verify it and comment if needed. 

6080
S
Luminary
HM Light
HM LightSingle Emitter
asked in ZPL
Why does my macro output results from 1 previous macro run?

I have a question about Zemax Macro. My macro outputs the results from 1 previous macro setting, even though I edit and save the new setting in the macro every time. I put the screenshot that explain this problem. I have no idea why it happens, so I would like to have any suggestion and comments.  

122
HM Light
KBL
KBLSingle Emitter
asked in ZOS-API
ZOS-API, Python Image simulation. No output

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()   

1222
L
JSavastinuk
JSavastinukSingle Emitter
asked in ZPL
Doesag vs phases macro zones are different

I have run both the “phases” macro to locate where the steps are for a binary 2 on an aspheric surface and the “DoeSag” macro. However, I get different results as the radius increases. Sometimes, the number of zones ends up different.Which one is correct? I’ve used the “phases” macro for a long time without much issue. Recently, we have had requests for the sag tables on a binary, but I’m not sure I can trust the DoeSag results as the number of zones and zone locations do not match.

131
C
Fully Spectral
B
Begad.ElmelligyInfrared
asked in ZOS-API
ZOSAPI Python LSP

Hi, I started working with ZOSAPI in Python. I am aware that since I am using clr.AddReference(<Module>) that means that they are dynamically being imported but is there a way to achieve autocomplete and error checking?

341
B
jhimavanth
jhimavanthMonochrome
posted in ZPL
Getting MTF values for Montecarlo runs

How to get FFT MTF, EFL values of Montecarlo runs when RMS wavefront is selected as criteria in tolerancing, any macro is available or can be done 

383
Y
L
Luc.van VughtVisible
asked in ZOS-API
Incorrect datagrid.MinY for Geometric Image Analysis

We recently implemented the Geometric Image Analysis in ZOSPy 1.30. While doing so, we noticed that IAR_DataGrid.MinY does not return the lower bound of the y-axis for the output (at least when compared to the output in OpticStudio itself). It seems to be returning either the upper bound or the abolute value. E.g., when the analysis is centered at (0,0), the x- an y-axes in OpticStudio start at -25 while the API returns -25 for MinX and 25 for MinY.  Could you elaborate on what MinY (and to an extend MinX) correspond to. So far, we thought the datagrids and their axes follow the normal matrix conventions, which was the case for all analyses we implemented and used. Is this not the case for Geometric Image Analysis, or is there an error in the API?

19611
L
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

713
Jeff.Wilde
Luminary
L
Luc.van VughtVisible
asked in ZOS-API
What is the use of ZOSAPI.AnalysisSettings.IAS_Surface.UseObjectiveSurface()

The usage of ZOSAPI.AnalysisSettings.IAS_Surface.UseObjectiveSurface() is not clearly documented. The only place where is appears is in the ZOSAPI introduction under “Changing Settings” to explain that an errormessage can be returned if it did not work. In contrast to ZOSAPI.AnalysisSettings.IAS_Surface.UseImageSurface(), which selects the image surface whenever available, it is unclear what UseObjectiveSurface() does. The only place where I have actually managed to get it to work is for the Start Surface in the PhysicalOpticsPropagation analysis, where it selects the Entrance Pupil. Is the intended use selecting surfaces that are not an actual surface within the model (such as the entrance pupil)?

372
L
Kris
KrisInfrared
posted in Code Exchange
Matlab script to group rays from ZRD file to separate paths

This Matlab function imports a raw Zemax ray database stored in ZRD file, groups the rays into distinct paths based on i) the exact same sequence of objects hit and ii) ray events (such as reflection, splitting etc.), and outputs this information in a form of graphs, human-readable variables and, most importantly, a summary table storing each path in descending total power, object sequence, total ray events and so on. It can be further processed either using Matlab's native capabilities, or exported and processed using Excel or a simple text editor.It DOES NOT need Zemax to be installed onto your system and does not use any API to connect to it. It is a completely standalone function.The need for this custom function came clear during one project at work as the native Zemax ray paths tool is simply not sufficient. For instance, ray grouping criteria is not clearly specified, also, the explicit sequence of objects is lost (if a ray enters the lens, is backreflected and leaves the lens t

46316
Kris
L
Luc.van VughtVisible
asked in ZOS-API
Geometric Image Analysis with negative Image Size

I am implementing a fix for the incorrect MinY of the Geometric Image Analysis in Python, as discussed in this post. While doing so, I noticed an odd behavior. It is allowed to specify the Image Size as negative for the Geometric Image Analysis, but this causes problems with the resulting output. With the example Double Gauss 28 degrees field, I can create the following analyses using the API with slightly different settings:API output for 4 slightly different analyses Showing that the extent of the axis with a negative image size and the number of pixels set to 100 will always equal 100. First I thought this was an API problem, but this is the same output in OpticStudio:The same analyses in OpticStudio.  Field widths: Analysis 1: 50, Analysis 2: -50, Analysis 3: 100, analysis 4: -100 Note that the image width of Analysis 2 is 100 millimeters while it should be (-)50 millimeters:Settings for analysis 2 Increasing the number of pixels to 200 increases the field width of the analyses wit

250
L
clo
cloMonochrome
asked in ZOS-API
How to ignore Object in API ?

Hello to all,I read the topic about : “how to ignore Surface in API”. I tried to do something similar for non-sequential object but it is not working.         surf4 = TheSystem.NCE.GetObjectAt(4)        surf4.TypeData.IgnoreObjects = 1First TypeData.IgnoreObjects want a string but I don’t know what to write. Thank you very much in advance fir your answer. Clotilde 

2204
David.Nguyen
Luminary
Imaad
ImaadSingle Emitter
asked in ZOS-API
Zemax C++ ZOS API COM Error

Hi all,I am trying to run a simple standalone c++ application which gives  “Microsoft C++ exception: _com_error at memory location” The error is on line 29 // Create the initial connection classIZOSAPI_ConnectionPtr TheConnection(__uuidof(ZOSAPI_Connection)); Does someone have an idea on what could be the issue? I prefer to use C++ as I have to integrate other code with it. Thank you.

501
Imaad
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in DLLs
OpticStudio grating tools beta function update history

This forum post is a place to collect update history of diffractive tools beta functions, which includes all RCWA DLLs (and visualization API), polygon DLL, and Zemax Grating Data (ZGD) DLL. Content:1. Overview2. Resources3. Change history OverviewCurrently in OpticStudio, we are adding some useful DLLs to enhance the ability of fully simualting gratings. They allow OpticStudio to consider the efficiency when rays pass through diffractive optical elements (DOE), such like 1D/2D gratings, binary optics, or volume holograms. These extensions can be found in OpticStudio installations.These tools improve frequently based on users’ feedback. We decide to provide functions with DLL so it can be updaetd fast upon users' request. Between each OpticStudio public releases, there might be several minor updates and bug fixes. This forum post is a place for changes history.Note all tools provided here are only available with OpticStudio Premium Subscription. If users are interested in these functio

179113
Michael Cheng
Zemax Staff
HCY
HCYMonochrome
asked in DLLs
How to disable fixed data in UDS

In some surface types, e.g. Paraxial XY or Grid Gradient, data entry for Radius and Conic is disabled (their cell value is returned to a blank after typing in a value).Can this behaviour be programmed in a UDS?

190
HCY
Hans-Jürgen Feige
Hans-Jürgen FeigeVisible
asked in ZOS-API
ZOS-API Suppress UNDO files

Hello All,how can I suppress writing UNDO files in an interactive zosAPI extension?This is important to speed up the process!Thanks!Hans-Jürgen

442
Hans-Jürgen Feige
I
Iari.MarinoInfrared
asked in ZOS-API
Save eulumdat/ies file via ZOS-API

Hello,still can't we save polar detector data in eulumdat/ies files with ZOS-API? Is there an alternative solution? And most importantly, can we hope that it will be implemented?Thank you!

353
David.Nguyen
Luminary
P
Patrick.CronkiteVisible
posted in ZPL
Access to field "Convert To" function in ZPL macro

Is there a way to access the field 'Convert To' function in a ZPL macro?  If not, can this be added to the new features list? Thanks. Pat.

1987
Jay.Bernal
ZachDerocher
ZachDerocherSingle Emitter
posted in Code Exchange
Create Ray File from Sequential System (ZOSAPI Interactive Extension)

This python ZOS-API interactive extension creates a ray file based on batch ray tracing in a sequential system. This allows import of image-space ray data from a sequential model into NS mode, including black-boxed lens systems. For a user selected field coordinate, rays are randomly selected in the pupil and traced to the image plane. The image plane intercept ray data are saved as a ray file (.dat) into the ...\Zemax\Objects\Sources\Source Files\ directory. After loading into an NS system, the “pre-propagation” source setting can be used to back the rays off from the image plane. Note that is merely intended as an example. The implementation of the function is very basic; the tool should be adapted and validated based on individual cases. Click here to Download 

540
ZachDerocher
ellenlee619
ellenlee619Single Emitter
asked in DLLs
Validating FIXED_DATA5 parameters

What is the best way to validate that the parameters input by the user are valid? For example, say that I have a parameter “n_rows” that needs to be an integer greater than zero. Should I check this upon initialization of the DLL (case 8)? If the input is invalid, should I then change the corresponding FD->param[i] it to be a valid value (e.g., if the user input 0 then change it to 1)? Or is this a bad idea? The example files state that the DLL should only modify FIXED_DATA in case 7, when Zemax is asking for safe data. Thanks

210
ellenlee619
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

1634
Julia
Fully Spectral
Matteo
MatteoSingle Emitter
asked in ZOS-API
Universal 1-D Plot with NSD: ZOS-API in Python

Hi everybody,I need your advice / help for using the API.I am currently trying to run my Zemax file over the interactive mode with python. So far, I have managed with the help of the ZOS-API Syntax help and the examples presented there, but I am not getting any further at this point. The Zemax file I want to control is a non-sequential system.I would like to create a Universal 1-D Plot where I plot the value of one operand (=NSDD) in my merit function in dependence of the tilt angle of an object in my system. In the image attached at the bottom you can see the settings I would like to set over python. I am struggling with setting the field “NSC Data” with python. In the documentation under KEYWORDS-->MODIFYSETTINGS I cannot find any setting for this option: UN1_CATEGORY: Use 0 for surface, 1 for system, 2 for config.  I tried 3 for “NSC data” without success. You can find the python snippet I used below. My question boiled down:Is there a way to set the NSC category in an univ

1515
Matteo
satoru
satoru
asked in DLLs
バルク散乱モデルの設計方法について

溶液中に存在する粒子の吸光、散乱を評価できるようなモデルをノンシーケンシャル系で作成していて質問があります。Mie.1dllを使用し、光源、溶液、ディテクタの３つのオブジェクトで評価しているのですが、Particle Indexの設定時にわからないことがございます。シェードモデルで光線を確認しながらParticle indexを大きく（初期値から溶液の屈折率より上）していくと、散乱が発生する回数が増える事象が起きました。（光線を保存して光線データベースビューアで確認し、実際に代わっていることも確認しました）想定では屈折率が変わったときに散乱方向や散乱強度に影響はあるが、散乱回数は変わらないと思っていたのですが、こちらはどういった理由で起きているのでしょうか。 

110
satoru
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?

316416
MRudolf
Hossein
HosseinSingle Emitter
asked in ZPL
How to write a Macro to scan in XY and get efficiency

Hi everyone,I am new here and trying to write a macro for a simple setup that I have. I have a beam at source with specific NA and goes through few optics and get focused on a surface with floating aperture. My inputs are relative position of source/object respect to image in X and Y and output is efficiency at “Geometric Image Analysis”. How can I write such a Macro? 

1173
Hossein

Badge winners

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