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.

687 Topics
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
API (CS User Analysis): ZBF Viewer

This Zemax User Analysis generates small images of irradiance and phase for each ZBF selected. Then it displays side by side images of irradiance and phase for a quick checkAuthor: @Michael.Humphreys   Click here to download Date Version OpticStudio Version Comment 2022/03/09 1.0 - Creation

1290
S
Luminary
2 years ago
N
Nicholas.NorthSingle Emitter
asked in ZOS-API
ZOS-API Wavefront map populated by zeros

Hi Zemax community,I am a student who is learning to use the ZOS API in Matlab and I’m having issues with getting results from New_WavefrontMap. How do I correctly pull data from a wavefront map? As the results I plot are always zero.I am running a wavefront analysis and POP analysis in the same program, which uses the ‘Double Gauss 5 degree field.zmx’ file from samples. I apply the analysis then pull the results using the following code to get the data:WF_Map_Data = New_WF_map_results.DataGrids(1).Values.double;matrixData = POP_Results.DataGrids(1).Values.double;and try to plot it in Matlab the matrix will be populated by zeros.Wavefront map populated by 0’sBoth wavefront map and POP are set up in a similar fashion, but when plotting the results of the POP it will not be populated by zeros.POP resultThanks for readingNick

3033
Jeff.Wilde
Luminary
2 years ago
Y
Yao.TIanMonochrome
asked in ZOS-API
Close ToleranceDataViewer window pop out after tolerancing analysis finished

I am running tolerancing analysis (TA) using Matlab. I noticed that one tolerance data viewer window will show up after the TA is finished. I would like to close the viewer window using Matlab script however I was not able to find the right way to do it in ZOS-API manual. Do you know how to close the viewer window using Matlab script? Thank you very much.

1312
Y
2 years ago
Erik.Hebestreit
Erik.HebestreitInfrared
asked in ZOS-API
ZOSAPI_NetHelper cannot be added

Hi. I am using the ZOS-API for Python and try to switch to the new recommended method of using PythonNET instead of the COM interface. To do so, I created a new Python template using 'Programming>Python>Interactive Extension' (same problem occurs with 'Standalone Application'). Running this template fails when trying to add the NetHelper DLL: import clr, os, winreg from itertools import islice # determine the Zemax working directory aKey = winreg.OpenKey(winreg.ConnectRegistry(None, winreg.HKEY_CURRENT_USER), r'Software\Zemax', 0, winreg.KEY_READ) zemaxData = winreg.QueryValueEx(aKey, 'ZemaxRoot') NetHelper = os.path.join(os.sep, zemaxData[0], r'ZOS-API\Libraries\ZOSAPI_NetHelper.dll') winreg.CloseKey(aKey) # add the NetHelper DLL for locating the OpticStudio install folder clr.AddReference(NetHelper) import ZOSAPI_NetHelper --------------------------------------------------------------------------- FileNotFoundException Traceback (most recent call

87113
T
2 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
ZPL Macro: Sequential - Image Simulation Cross Section

This macro reads the text output of the image simulation.  The text output contains the RGB values of the image for each pixel. It then creates a cross section of the image simulation in X or Y for a defined X or Y pixel.In the Image Simulation window, click on Save first before running it.  Click here to download Date Version OpticStudio Version Comment 2021-12-09 1.0 - Creation

2030
S
Luminary
2 years ago
John.Hygelund
Fully Spectral
John.HygelundFully Spectral
asked in Code Exchange
Search all glass across catalogs?

Is there a way to search for a glass across all the catalogs?More broadly, I’d like a Glasscat “database” view where I can view, filter, and combine glasses from all catalogs in an efficient way. Any tips or tricks would be appreciated.Thank you,John

9067
David.Nguyen
Luminary
2 years ago
L
Lieu-Kim.DangInfrared
asked in ZPL
Print array

Hello OS-community,how to write a ZPL-code printing elements of a single or multi-dimensioned array  (ie. Array(i), Arrax(i,j)) in one line in the output of the text viewer?Thanks

8079
L
2 years ago
Sahil
SahilVisible
posted in ZOS-API
How to load BSDF File in scatter model of object properties in ZOS API Matlab and Python

In OpticStudio, We can load any BSDF file from our   \Zemax\ScatterData Folder .Here is the available code for Matlab and Python. You can use this code in Standalone or Interactive Extension.-Copy the code in your file .-Change the path of testfileMatlab Code: TheNCE = TheSystem.NCE; Object_2 = TheNCE.GetObjectAt(2); % changes scatter profile on face Scatter_Data=Object_2.CoatScatterData.GetFaceData(0);o3_Scatter = Scatter_Data.CreateScatterModelSettings(ZOSAPI.Editors.NCE.ObjectScatteringTypes.BSDF);      o3_Scatter.S_BSDF_.ReflectFile  = 'BrownVinyl.bsdf'; o3_Scatter.S_BSDF_.TransmitFile = 'BrownVinyl_HighRes.bsdf'; o3_Scatter.S_BSDF_.ScatterFraction = 0.775;  o3_Scatter.S_BSDF_.Angle = 30;  Object_2.CoatScatterData.GetFaceData(0).ChangeScatterModelSettings(o3_Scatter);  Object_2.CoatScatterData.GetFaceData(0).NumberOfRays = 2; Python code :testFile = r"C:\test\Digital_projector_flys_eye_homogenizer.zos"TheSystem.LoadFile(testFile, False)print(TheSystem.SystemFile)TheNCE = TheSystem.

2000
Sahil
2 years ago
J
Julian.IrwinMonochrome
asked in ZOS-API
Access the ZOS-API Enum "constants" dictionary referenced in knowledge base

Hello, I am trying to use the ZOS-API through Python. I have found the knowledgebase articles to be very scattered and confusing. I would like to access the dictionary of enumeration constants referenced multiple times in the linked article. However, the article does not show how to find the constants dict within ZOS-API. And, the source script for the code snippets is not linked in the article attachments! Does anyone know how I can access the constants dict through python? Thanks in advance.https://support.zemax.com/hc/en-us/articles/1500005576662-ZOS-API-using-Python

2061
Allie
Zemax Staff
2 years ago
Sahil
SahilVisible
posted in ZOS-API
Loading User Defined Surface dll with ZOS API python and Matlab

In opticStudio ,we can set User defined surface through Python and Matlab program using standalone and Interactive Extension.-Set the user defined surface -Select the User defined surface from directory-Get the User defined surfaceMatlab Code:You can directly copy the code in Standalone or Interactive Extension:   import ZOSAPI.*;    % Set up primary optical system    TheSystem = TheApplication.PrimarySystem;    sampleDir = TheApplication.SamplesDir;    testFile = System.String.Concat('C:\test\ABCD\ABCD Simple_lens.zmx');    TheSystem.LoadFile(testFile, false);    TheLDE = TheSystem.LDE;    surf2 = TheLDE.GetSurfaceAt(2);    typeSettings = surf2.GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.SurfaceType.UserDefined);    filesAvailable = typeSettings.GetFileNames();    typeSettings.Filename = filesAvailable(5);    surf2.ChangeType(typeSettings);    d=typeSettings.Filename;    disp(d) Interactive Extension Matlab Python  Code:You can directly copy the code in Standalone or Interactive Extensi

3950
Sahil
2 years ago
gkasoev
gkasoevStudent
asked in ZOS-API
ZOS-API unexpectedly fails to open the Wavefront analysis window

Hello! I am trying to retrieve data about wavefront via ZOS-API in Matlab. Since I need to iterate through different positions of mirror, I am using coordinate breaks and iterate through them using arrays and FOR cycle:decenter = [-0.5:0.1:0.5];tilt = [-0.2:0.04:0.2];for i = 1:tilt_length for j = 1:decenter_length disp([i j]); TheSystem.LDE.GetSurfaceAt(3).GetCellAt(13).DoubleValue = decenter(j); % I set decenter here in the coordinate break (surface 3) TheSystem.LDE.GetSurfaceAt(3).GetCellAt(14).DoubleValue = tilt(i); % I set tilt here newWin = TheSystem.Analyses.New_WavefrontMap(); % Requesting new window newWin_Settings = newWin.GetSettings(); % Requesting settings newWin_Settings.Wavelength.SetWavelengthNumber(1); % Setting wavelength number newWin_Settings.Field.SetFieldNumber(1); % Setting field number newWin_Settings.Sampling = ZOSAPI.Analysis.SampleSizes.S_1024x1024; % Setting sampling newWin.ApplyAndWaitForCompletion(); % Applying the settings

2032
gkasoev
2 years ago
J
Jozef.PulkoInfrared
asked in ZOS-API
Mathematica set DoubleValue parameter

I am able to control IntegerValue parameters of objects in ZEMAX from MathematicatheSystem@NCE@GetObjectAt[8]@GetObjectCell[ObjectColumn`Par2]@IntegerValue = 512; however DoubleValue object returns an errortheSystem@NCE@GetObjectAt[1]@GetObjectCell[ObjectColumn`Par6]@DoubleValue = 10.1; NET::netexcptn: A .NET exception occurred: System.ArgumentException: Expected Double, got 'String'   at ZemaxUI.ZOSAPI.Editors.ZOSAPI_EditorCellBase.set_DoubleValue(Double value). What is the syntax  to control a DoubleValue object? Thank and BR,Jozef

1622
MichaelH
Luminary
2 years ago
joshdfreeman
Ultraviolet
joshdfreemanUltraviolet
asked in ZOS-API
Path Analysis Tools in ZOS-API

Can anyone point me to the tools/commands to call the Non-sequential Path Analysis Tools in ZOS-API? From Matlab, in Interactive Extension mode on a non-sequential object set, I’d like to be able to execute the path analysis to create the .PAF file and then import that .PAF file into Matlab or at least the desired parts of the .PAF file. I could then do some analysis on the individual aspects of the .PAF file. I’ve been looking in the documentation and not having much luck.Thanks!Josh

2906
joshdfreeman
Ultraviolet
2 years ago
R
Ralf.KesslerMonochrome
asked in ZPL
Reding data from .dat-file into ZPL macro

Hi,I would like to read several numeric data as well as text data from a .dat-file into a zpl macro to use some of them for further use.For example, the .dat file has 5 rows and 3 lines, divided by Tabs, e.g.:Pos1    3.7   4.2   6.2   8.7Pos2    9.0   7.5   2.8   5.6Pos3    0.5   1.8   4.6   4.3Is it possible to use the READ command for reading the complete .dat-file and to select afterwards some special data for further optimization?Or would it be possible to read only some special data from the .dat-file for further use, e.g. (Row2, Line 2 = 9.0) and (Row3, Line 3 =1.8)? Best regardsRalf  

5662
R
2 years ago
R
Ramya
asked in ZPL
ZPL Macro for Ray Trace in Mixed mode

Hi,I  am facing an issue when I try to extract ray trace data for a non sequential component in mixed mode of Zemax. In the above data, I want to get the direction cosines of normal and incident ray for NSC object 7 and 2 using a ZPL macro (as I am tracing a 10000 rays). Since for  RANX(surface) (Surface number in the sequential editor has to be given) I don’t know which surface number has to given for this case.  I also tried to save the ray trace data every time I trace the ray, but When I run RAYTRACE hx,hy,px,py,wav, (for different px and py), somehow the data in the Raytrace text is not getting update. Can you please provide me a solution for this. 

4102
R
2 years ago
joshdfreeman
Ultraviolet
joshdfreemanUltraviolet
asked in ZOS-API
Best way to detect rays incident on the back side of a reflective object?

Hi Zemax Community,what’s the best/easiest way to detect rays hitting the back side of a reflective object? It’s a pretty complex Non-sequential system with a source, primary detector and many “parallel” objects in between. I’m trying to understand the losses due to 1) objects blocking rays reflected from another object and preventing them from reaching the primary detector and 2) objects shading other objects and preventing rays from reaching the other objects, to be reflected to the primary detector. One idea for the blocking instances is to create a set of separate, absorbing detectors just off the backsides of the reflective objects. This would work and be a bit cumbersome. Maybe there’s an easier way? Can a reflective object have dual properties on each face? Or?Any thoughts would be appreciated. Thanks,Josh

2922
Jeff.Wilde
Luminary
2 years ago
R
Ralf.KesslerMonochrome
asked in ZPL
Using target values from Merit function in ZPL Macro

Is it possilbe to use target values from a merit function in a zpl macro.For example, there are some defined constraints in the optical path length (OPTH) for e.g. 5 different ray deflections (different Hx or Hy) of an imaging system. Can I use these fixed values in the ZPL macro for further optimization?

4822
R
2 years ago
joshdfreeman
Ultraviolet
joshdfreemanUltraviolet
asked in ZOS-API
Indexing Objects in the NCE (from Matlab)

If I have say, five more or less identical objects in the NCE, that are in different X,Y positions, and I’m accessing the NCE via an Interactive Extension, is there a way to index the assigned names of the NCE rows somehow? For example, in the Matlab extensioninstead of having to create five unique Objects: Heliostat1, Heliostat2,… Heliostat5, as shown below, Heliostat1 = TheNCE.GetObjectAt(2);Heliostat2 = TheNCE.GetObjectAt(3);Heliostat3 = TheNCE.GetObjectAt(4);Heliostat4 = TheNCE.GetObjectAt(5);Heliostat5 = TheNCE.GetObjectAt(6);is there a way to index the left side variable names so that they can be used in a loop? Such as: for h = 1:5Heliostat(1) = TheNCE.GetObjectAt(h+1);end;When I try the above, I get something like: “Array formation and indexing are not allowed on .NET objects.” I’m hoping there is some sensible way to do this.  This would be extremely helpful when performing looped calculations to alter the physical properties of each of these objects in the NCE and then wantin

2765
joshdfreeman
Ultraviolet
2 years ago
A
Ultraviolet
AmitUltraviolet
asked in ZOS-API
Extration of PSF and MTF data via Python

Hello Everyone, I have the model for an automotive camera lens. I also have the samples of the lenses to perform measurements.Here is what I would like to do with the model (I am an absolute novice in programming):I would like to specify points in the objects space (varying the object distance and the object height position) and would I would like to extract the Huygen’s MTF and PSF for all these points. I would also like to know the position of the image (of the point) on the imager.So far, I have understood that I can vary the object height points in Python, I am however, not sure how I can vary the object distance!I tried to use the example code for “Retrieve Data from FFT MTF” and made some modifications to extract the MTF information for my lens file. It seems to work for the FOV points (by object height) already specified in the lens model and a constant object distance but I would like to do the same for a list of points in the object space and would be nice if it can be automat

97710
David.Nguyen
Luminary
2 years ago
yuan.chen
Zemax Staff
yuan.chenZemax Staff
asked in ZOS-API
混合模式系统中有多个non-sequential components时怎么使用ZOSAPI进行物体的增减和参数修改

如图，系统的表面1和3都是非序列表面。应该怎么对于这两个components进行修改？ 

901
yuan.chen
Zemax Staff
2 years ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange
Python: Source File - fixing error with zero flux

This Python script will read the binary source file and will try to fix any errors related to zero-flux rays.  Click here to download Date Version OpticStudio Version Comment 2022/01/01 1.0 - Creation

1110
Michael Cheng
Zemax Staff
2 years ago
M
Manuel.EndresSingle Emitter
posted in DLLs
substitute for surface apodization in basic version

Hello I have a license for basic version of OpticStudio. I need to apply an apodization filter to a surface in order to program the transmission to be a Gaussian function. But it seems that the 'filter' type of surface is only available in the premium version. Is there any substitute for this function that I can use? Thank you.

1566
S
Luminary
2 years ago
Oliver Schwanke
Oliver SchwankeSingle Emitter
asked in ZPL
Reading in Detector Data to e.g. python

I use Detectorviewers in text mode to export the results of my simulations to disk.Futher processing is done via python, where the plain textfile gets parsed.I prefer to not using  the ZOS API as this limits me in the python verison i use. Problem is: The Detector Viewer numbers are really error-prone as sometimes i close a window and open another one and the numbers i have to put into SAVEWINDOW keyword are just wrong by then.I would prefer using the detector number instead using SAVEDETECTOR keyword. But this saves in some binary format i did not find any specs upon for reading that in. Is there any description on the DDR/DDx file format?Is there any way to obtaining the detector data into python? Best regardsOlli 

10363
Sahil
2 years ago
V
Vincent (En Hung).LinMonochrome
asked in ZPL
How to optimize POP by use merit function in ZPL?

I would like to write the Macro script of ZPL about how to optimize the POP by merit function like as “POPD” optimized operand1.Set the one surface of Thickness or parameter 1,2,3… as the value of  0.5mm, 0.6mm , 0.7mm to run a loop2.Set the someone surface “Thickness or parameter 1,2,3…..” as variable factor. 3.Execute to optimize the MF as POPD to run 10,15 circles as you want 4.In the end, shows the final optimized value to 1st step different cases you setEx. Surface 3 thickness as 0.5mm, 0.6mm, 0.7mmOptimized the surface 7 of thickness as variable factor by using POPD MFto get value under surface 3 as 0.5mm, 0.6mm, 0.7mm respectively.  

5621
David.Nguyen
Luminary
2 years ago
Harel.Shfaram
Harel.ShfaramSingle Emitter
asked in ZPL
Change solve NSQ parameter from pickup to fixed(off) using Macro

I am looking for ZPL command which change NSQ parameter solve from pickup to fixed(off).There is command SOLVETYPE and code PF_p to remove pickup for sequential but this option not available for NSQ parameter pick up. Any suggestion how to do so?

3302
J
2 years 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