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.

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

5770
S
Luminary
3 years ago
L
Luc.van VughtInfrared
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?

1066
L
3 days ago
Erkang Wang
Erkang WangInfrared
asked in ZOS-API
How to read out X half width and Y half width of a detector Rectangle using python.

I need to read out the X half width and Y half width of a Detector Rectangle. The above code used to work but now it says no AttributeError: 'IObject' object has no attribute 'XHalfWidth'. Could you tell me a way to circumvent this problem. 

473
David.Nguyen
Luminary
10 days ago
Ryan.Burdick
Ryan.BurdickSingle Emitter
asked in ZPL
Simple ZPL print statements not appearing anywhere

I’m trying to run a simple macro to test printing to screen:PRINT “Hello world”When I run this, all that appears is a text viewer saying “Executing path/to/macro...” and nothing else. I tried adding OUTPUT SCREEN before the print statement to make sure the statement prints to screen, but same issue.Any advice?

412
Ryan.Burdick
16 days ago
Rizwan
RizwanSingle Emitter
asked in ZOS-API
Why aren't C# ZOS-API updating their dlls to be compatible with all target frameworks?

Recently I am developing an internal software by using c# ZOS-API dll. I have chosen .Net 8.0 for my application. After adding the refrences of ZOS-API, it gives me error due to incompatibility of frameworks. ZOS-API has been developed by using .Net framework v4.6.2. If I build my assembly with net framework 4.8, it works fine, but not supports in net 8.0. Why aren't they developing dlls with Microsoft .Net (support cross platform) instead of .Net framework? I have also seen that the headless remoting connection is taking long time. Why aren't they using modern remote procedure framework like gRPC?

634
Mark.Nicholson
Luminary
23 days ago
JenR
JenRInfrared
asked in ZPL
How can you write slope cross-section analysis text results to a file?

Hi,I would like to write a macro that runs the surface slope analysis and outputs the “Text” tab results (X-Coord, Y-Coord, and Slope) to a file. I was thinking of using GetTextFile, but I don’t see a string code for surface slope cross section (or slope either). What’s the best way to do this?Thank you,-Jen

818
JenR
24 days ago
Kris
KrisMonochrome
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

2893
E
Zemax Staff
1 month ago
Rahul
RahulSingle Emitter
asked in ZOS-API
Uploading multiple merit function via loop in MATLABStandaloneApplication code

Hello, I am working on designing lenses (Intraocular lens) of a power range and each power has unique merit function. I could manage to load merit function using the command below - TheMFE = TheSystem.MFE;mf3_filename = System.String.Concat(sampleDir,'\API\Matlab\MeritFunc\10.0D MF.MF');TheMFE.LoadMeritFunction(mf3_filename); In the same location I have merit functions for different power lenses. Can anyone suggest me a way how can I successfully load power specific merit function?Thanks in advance! Regards,Rahul

541
L
1 month ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
published in Code Exchange
Python Reading Writing Binary Files (ZRD, ZBF, DAT, SDF)

The download contains 3 Python scripts:a script to read / parse a ZRD (Zemax Ray Database) file a script to read / parse a Binary ZBF (Zemax Beam File) file a script to read / parse a Binary DAT / SDF Source File  Click here to download Date Version OpticStudio Version Comment 2022/01/01 1.0 - Creation

197116
Kris
1 month ago
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? 

370
Hossein
1 month ago
mlunin
mluninMonochrome
asked in ZOS-API
Is there a way to extract information about ray path through a GRIN optic (sequential mode) via ZOS-API?

Title. I can easily get the entry/exit points into a GRIN lens via tracing rays to a surface using SingleRayNormUnpol() and BatchRayTrace.However, this only gives me the entry/exit points into a surface. Is there a way to get information out about the beam path within a GRIN optic via ZOS-API?As an additional note, the GRIN optic is modelled via a custom *.dll extension I developed (not a ZEMAX Gradient 1-12 surface).My alternative is to write my own GRIN raytracer for the intermediate steps.

544
mlunin
1 month ago
cmanoopckr
cmanoopckrSingle Emitter
asked in Code Exchange
Obtaining a tight focus of laser beam after a multimode fiber

Hello guys, I have a multimode fiber of 1mm core (1000 um) of 0.22 NA. I will be using this fiber to deliver my laser beam of wavelength either 450 nm or 530 nm. The beam after the fiber will be collimated and then will be refocused. The final goal to have a spot size of 50 - 60 um at the focus. I am beginer in zemax and any help would be appreciated. If any of you had done similar project in the past it would be helpful if you could share the file and i could use it as starting point. Thanks a lot.

622
cmanoopckr
1 month ago
P
Paula Sola.de la SernaMonochrome
asked in ZOS-API
Extracting Combined Huygens PSF of a Multiconfiguration System in ZPL/ZOS-API

Hello everyone,I'm trying to extract the combined Huygens Point Spread Function (PSF) of a multiconfiguration system using either ZPL or the ZOS-API. In OpticStudio, I can achieve this directly by selecting "All" in the configuration button under the Huygens PSF settings, which provides the result I need. However, I'm having trouble replicating this setting in ZPL or ZOS-API, as I haven't been able to find an equivalent command or setting to retrieve the combined PSF programmatically.Has anyone here managed to access this setting through ZPL or ZOS-API, or is there an alternative approach to obtaining the combined Huygens PSF across configurations?Thanks in advance for any guidance or examples you might be able to provide!Cheers!

1153
L
1 month ago
Leon
LeonInfrared
asked in ZPL
Question about ZPLM parameters in merit function editor box

Question 1: what de Ex and Ey mean? I cannot find answers in user manuQuestion 2: non-sequential mode launches rays in a partial random manner, how Hx, Hy, Px, Py work for random rays? 

682
Leon
1 month ago
gsun86
gsun86Monochrome
asked in ZPL
Is there a build-in ZEMAX macro command to delete all surfaces in the lens table except the object and image?

I wrote a macro to do this but it is slow (line by line).  Is there a build-in method to do this?  I can’t find it in the user manual. Thanks! sub clear_all_lenses    num_s = nsur()    if (num_s > 2)        for i, num_s-1, 1, -1            !print "delete surface ",i            delete i        next    endifreturn

334
gsun86
1 month ago
L
Luc.van VughtInfrared
asked in ZOS-API
PlotScale missing in ZOS-API for Geometric Image Analysis

We recently implemented the Geometric Image Analysis in ZOSPy 1.30. While doing so, we noticed that the setting PlotScale seems not to exposed in the ZOS-API for this analysis. Is that correct?

742
L
1 month ago
gsun86
gsun86Monochrome
asked in ZPL
In ZEMAX macro, is there a solve operand to do coordinate return for tilt + decenter on a coordinate surface?

I searched in the help files but didn’t find one.  Thanks.

532
gsun86
1 month ago
gsun86
gsun86Monochrome
asked in ZOS-API
ZOS-API C++ sample code can't compile in Visual Studio - no ZOSAPI.tlb was generated

Need help to run through the ZOS-API C++ sample.  In zosapi.h:#import "C:\\Users\\gangs\\OneDrive - kochind.com\\Documents\\Zemax\\ZOS-API\\Libraries\\ZOSAPII.tlb"#import "C:\\Users\\gangs\\OneDrive - kochind.com\\Documents\\Zemax\\ZOS-API\\Libraries\\ZOSAPI.tlb"// Note - .tlh files will be generated from the .tlb files (above) once the project is compiled.// Visual Studio will incorrectly continue to report IntelliSense error messages however until it is restarted.But the *.tlb files were not generated after build and restart the Visual Studio, and can’t proceed.Thanks,

290
gsun86
1 month ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
published in Code Exchange
DLL (User-Defined Surface): Sequential Vortex Phase Plate

This DLL models a Vortex Phase Plate. It is useful in laser applications to convert a Gaussian laser beam into a donut-shaped energy ring. For more information, check the following links:https://www.holoor.co.il/wp-content/uploads/2017/11/vortex_zemax_tutorial.pdfhttps://www.holoor.co.il/application/optical-vortex-phase-plate-application-notes/https://www.holoor.co.il/optical-calculator/vortex-lenses/ The Vortex phase plate is a phase surface:   Click here to download Date Version OpticStudio Version Comment 2021/03/20 1.0 - Creation  

6404
Michael Cheng
Zemax Staff
1 month ago
B
bgdi10262Infrared
asked in ZPL
How to use ZBFTILT?

Hi Everyone,I would like to ask how to use zbftilt? The help document reads a bit confusing: This keyword requires the name of the ZBF file and four numbers. The phase of the beam is modified by a phase angle given by θ = ( x – cx )tx + ( y – cy )ty . The cx and cy values are the center of the phase tilt, and tx and ty are the slopes of the tilt in units of radians per lens unit length. The coordinates x and y refer to positions within the beam file, with the center coordinate (x = 0, y = 0) being at the point (nx/2 + 1, ny/2 + 1) where nx and ny are the number of points in the x and y directions. The length units in the ZBF file are converted automatically to the current lens units. The resulting data is written back to the same file name. If I want to rotate an elliptical beam mode by 90°, how should I write it?Thanks!Di

747
S
Ansys Staff
1 month ago
joachim
joachimMonochrome
asked in DLLs
Update values from custom object DLL

I have created a custom object based on the sample of the HalfCylinder.DLL object. So far, this works. I would like to return a value directly to the non-sequential component editor. E.g. for the half cylinder, add a field volume and return the current volume. This way during optimization, I can control the volume of the cylinder without using extra scripts to use the volume. I tried to use an extra field, and then attribute a value inside the code:in the given half cylinder, in line 64 (just before the switch(code)):data[104] = volume;but the volume field in zemax’ non-sequential component editor is not updated.I hope to get along the idea of I want to do. For the volume, I could use a script in zemax, but imagine it is value that I calculate in cpp anyway, it would be more efficient to reuse this. Is this possible?

451
David.Nguyen
Luminary
2 months ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in DLLs
Simulate 2D diffraction grating using customized diffractive DLL

In OpticStudio, currently we only support one dimensional grating. However, it's not difficult to simulate 2D grating. Here we will show an example using diffractive DLL.You may compile it with the instructions or use the DLL file attached to this article. Before we start, here are some articles for required background knowledge that we will not repeat in this forum post. How diffractive surfaces are modeled in OpticStudio (KBA) How diffraction ray-tracing is calculated | Zemax Community(forum post) Custom DLLs in OpticStudio: An overview of user-defined surfaces, objects, and other DLL types (KBA) How to compile a User-Defined DLL (KBA) Let's simply open the attached cpp file and observe how it works in non-sequential mode.This example is mainly modified from the built-in sample \Documents\Zemax\DLL\Diffractive\diff_samp_1.c To compile the program as C++ code. We package the functions with extern 'C'.  In this example, we only want to return diffraction ray direction and its rel

288017
Michael Cheng
Zemax Staff
2 months ago
MichaelH
Luminary
MichaelHLuminary
published in Code Exchange
ZPL Macro: Create automatically annotations on a 3D layout to display distances between optics

The attached ZPL will calculate the air space gaps between all elements and then will place the annotation text on the Windows clipboard.  After you run the script, simply open the Edit Annotation window, paste the text and click the Use Annotations checkbox: For the Double Gauss 28 degree field.zmx, the 3D Layout will look like:and for the Cooke 40 degree field.zmx: Limitations:You have to use the 3D Layout and not the 2d Layout.  The 3D Layout uses global coordinates for annotations while the Layout uses “window” units, meaning the values for LINE and TEXT would change based on the current zoom position. For complete control, you should use LINE3D and TEXT3D (this would allow you to place things like Comment, Radius, or Material on the plot as well.  For this simple example of air spaces, we will use MEASURE3D which is slightly easier to implement. Since we're only looking at air spaces, you need to consider when you “enter” a cemented element (doublet, triplet, etc) and when you “ex

5294
John.Hygelund
Fully Spectral
2 months ago
N
Fully Spectral
nadav.amitaiFully Spectral
asked in ZPL
float to integer

Hi, Is there a way to change variable from float to integer?I want to use it to write list of polygons in loop:for i:n:polygon_name 1.pobpolygon_name 2.pobpolygon_name 3.pob….In other words, i dont want something like that: Thanks,Nadav….. 

482
N
Fully Spectral
2 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
single IMAE operand

can I calculate and get operand IMAE without adding it to MF with python api?IMAE work as geometric image analysis? what if I need “geometric bitmap image analysis”?they have different settings and from it different efficiency values. 

551
A
Ultraviolet
3 months ago

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