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.

699 Topics
Michael.Young
Ultraviolet
Michael.YoungUltraviolet
posted in ZPL
ZPL Text Editing, Code Completion, Syntax Highligting, Visual Studio Code

Fellow ZPL programmers,I want to share some of the tools that I use for editing ZPL scripts and code.I use Microsoft Visual Code Studio to edit the ZPL files.I also use an extension from Hiiragi that enables support for ZPL in VS Code. It provides syntax highlighting and some code completion through IntelliSense.For IntelliSense, I would disable the option “Editor>Suggest: Match On Word Start Only”. This allows you to type “MERIT” and pull up all the tags that contain “MERIT”.Option to enable “Fuzzy Search”Example of Code Completion,Example of Code Completion with DEFAULTMERITExample of Sanjay’s PLOT_TEST.ZPL script with indentations provided by me to enable code folding.Example of Sanjay’s Code in VS Code without Code Folding Example of Sanjay’s Code in VS Code with Code FoldingHiiragi supports and requests community contribution to the repository. Please consider supporting the project and providing feedback to Hiiragi, forking the repository, etc.

1140
Michael.Young
Ultraviolet
5 months ago
Nikki-G
Zemax Staff
Nikki-GZemax Staff
asked in Code Exchange
Symmetric Extended Polynomial Surface DLL

This DLL creates a surface identical to the Extended Polynomial surface, but it allows the user to specify if symmetry should be enforced upon the surface, specifically in the x direction, y direction, x & y direction, or no symmetry (identical to the typical Extended Polynomial surface).The source code is not shared.Author: Dominique ‘Nikki’ GalvezDownload SymExtPoly.DLL Here Date Version OpticStudio version 2024/08/15 1.0 24.2  Comparison of Symmetric Extended Polynomial (x & y symmetry active) vs standard Extended Polynomial  

760
Nikki-G
Zemax Staff
5 months ago
D
devin.vega_01Monochrome
asked in ZOS-API
ZOS-API Performance Hit On Software Update

I have a couple scripts I began writing a few software versions ago on Zemax 21.2 and MATLAB 2020b. These were Zemax Zos-API MATLAB scripts that performed a large number of direct unpolarized ray traces. I have noticed that since updating my software to Ansys Zemax Opticstudio 2024 R1.03 and MATLAB R2022b there seems to be a fairly substantial performance hit. Has anyone else noticed this? Have there been changes to the way the ZOS-API functions that I need to implement in my scripts post update? 

670
D
5 months ago
c​hris
c​hrisInfrared
asked in ZOS-API
Problem with rotation matrix article

https://support.zemax.com/hc/en-us/articles/1500005576822-Rotation-Matrix-and-Tilt-About-X-Y-Z-in-OpticStudio is misleading.OpticStudio uses degrees for Tilt About X/Y/Z, and this graphic suggests using theta_x = tilt about x. Tilt about X is in degrees, but theta_x should be in radians. If you do as the graphic suggests and plug in degrees, you'll get the wrong rotation matrix.Please let me know if I'm wrong here.

5065
Sean Turner
Ultraviolet
6 months ago
Yuqiang.Ding
Yuqiang.DingSingle Emitter
asked in DLLs
power calculation of the ray out of a grating DLL in zemax

Dear community,I am wondering how the zemax calculate the power of ray, which comes out of the DLL surface (RCWA model for a grating). In the DLL, data [30] represents relative energy of the ray. Here I assum it is diffraction efficiency, which is power flow. Besides, the output electric is also required to give in data [40-45]. Based on my test, the zemax detector seems to calculate the energy of the ray from DLL based on its square module of electric field instead of diffraction efficiency. However, when the diffraction efficiency of first order of light is high, e.g. 99.9%. The square module of electric field is usually larger than 1 because the k-vector changes. Therefore, I have normalize the electric field and multiple square root of the diffraction efficiency to achieve the right number on detector, which is contradictory to the law of wave propagation. Besides, If I did this, the detector energy will change again when this ray from DLL interact with next surface, which is a gla

400
Yuqiang.Ding
6 months ago
s.ng
s.ngMonochrome
asked in ZOS-API
definition of pathLength in ReadNextSegment

In the API command ReadNextSegment, is pathLength = optical path length or physical path length?ReadNextSegment (out int segmentLevel, out int segmentParent, out int hitObj,out int InsideOf, out double X, out double Y, out double Z, out double L, outdouble M, out double N, out double exr, out double exi, out double eyr, outdouble eyi, out double ezr, out double ezi, out double intensity, out doublepathLength) Where is the documentation on this?Is there a way to select optical or physical with this command?

210
s.ng
6 months ago
Borui
BoruiMonochrome
asked in ZOS-API
Confusion about correponding command of 'Insert Object After' function and 'Show As' type.

I have known that using command ‘ZOSAPI.TheSystem.NCE.InsertNewObjectAt(i)’can realize the function ‘Insert Object’, then I tried some commands but still cant find corresponding one for ‘Insert Object After’.The other similar question is similar. I have known that using command ‘Det_Set1.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.GreyScale’can realize the function‘ can realize the function of setting ‘Show As’as ‘Grey Scale’, then ‘InverseGreyScale’and ‘CrossSectionRow’ dont work for corresponding functions.

311
Benjamin.N
6 months ago
Borui
BoruiMonochrome
asked in ZOS-API
How to use 'SetRayData' in ImportanceSampling Interface?

I have set the ‘Scatter To Method’with the commond ‘...ScatterToData.ScatterToMethod = 1’, then I wanna set the Ray data as shown in Fig. 1, but I failed to call the function ‘SetRayData’.According to the Ansys Developer Guideline as shown in Fig. 2/3, it doesnt give more details, I have tried to infer corresponding code but cant work.Fig. 1Fig. 2Fig. 3

332
Borui
6 months ago
s.ng
s.ngMonochrome
asked in ZPL
index a column in array in zpl

If I have a 2D array e.g. 10x2  A(x,y), what’s the syntax to extract one column (or row) in that array so that it’s a 1D array?I’ve tried:col = A(1:10,3)col = A(:,3)

741
David.Nguyen
Luminary
6 months ago
C
Chenting.LaiSingle Emitter
asked in DLLs
Defining wavelength shift in a scattering dll

Hi, I am writing a user-defined scattering dll. I know that Zemax allows users to implement the wavelength shift during the scattering simulation (by specifying a certain shifting ratio in the dialog),  However, my application requires more complex way for determining the wavelength shift, so is it possible that I define the wavelength shift directly in the self-written dll file? If yes, how could I do that? Thanks a lot in advance! 

270
C
6 months ago
I
Indy.MagnusMonochrome
asked in ZOS-API
Image simulation using ZOS-API overwriting existing images when used in a loop

Hi all,I am facing an issue when using the Image Simulation tool via the ZOS-API. The goal is to vary a certain variable in a loop (in this case the object distance), perform each time an image simulation, and save the image with a specific name to a file. However, I notice that the previous images are always overwritten when a new image is saved.This is the simple MATLAB code that I am using in the main body:sampleDir = 'D:\Zemax OpticStudio\';testFile = System.String.Concat(sampleDir, '\Test_ImageTelecentric_Issue.zos');TheSystem.LoadFile(testFile,false);TheSystem = TheApplication.PrimarySystem;TheLDE = TheSystem.LDE;zline = 0;surface = TheLDE.GetSurfaceAt(zline);zvec = [1100,1500]; %variable object distancefor z = zvecsurface.Thickness = z;index = 3; %existing Image Analysis window with correct settingsim_analysis = TheSystem.Analyses.Get_AnalysisAtIndex(index);im_settings = im_analysis.GetSettings;im_settings.OutputFile = ['z',num2str(z),'.png']; %change file name according to vari

1262
I
6 months ago
Travis3
Travis3Monochrome
asked in ZOS-API
RunAndWait vs ApplyAndWait Traces

Hello, Currently I have a program in MATLAB ZOS-API that involves a light source that is shining on an array of detector rectangles. The purpose of the for loop is to tilt the X and Y component of the light source then read out the total power from each detector. The problem I am having is how to extract the data efficiently without opening a new detectorviewer each iteration. Currently I am having the for loop run a new ray trace as well as a newanalysis command which I believe is responsible for opening a new detectorviewer each iteration. Ideally the code would just update one detectorviewer or not open one at all to save me computing time. I will attach a snip of my current for loop where I believe the problem resides. I have tried to follow along to this link: Methods for extracting detector data through the API | Zemax Community… But not much success is being had. Any and all help would be greatly appreciated!

693
Travis3
6 months ago
Sami
SamiSingle Emitter
asked in ZPL
Filter String in Macro

I am rather new in the field of creating Macro. I am trying in a Macro to introduce a Ray tracing. I need to select the ray that I want to display. This function is done with Filter String is the normal use of Zemax. I could i use a filter string in the macro. Is there something special to carry. 

1012
Atalha
6 months ago
Xianglei
XiangleiMonochrome
posted in ZOS-API
API_Layout_plot_Python

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

67520
Brian
6 months ago
Yang.Yongtao
Fully Spectral
Yang.YongtaoFully Spectral
asked in ZOS-API
Python _PythonStandaloneApplication object has no attribute 'TheApplication'

Hi Zemaxers I am trying the python sample code of ZOS-API (as attached below). But it does not work at the first step.https://support.zemax.com/hc/en-us/articles/4403605141267-Generate-the-executable-in-Python-for-ZOS-API-User-Extensions The error shows as belowAttributeError: 'PythonStandaloneApplication' object has no attribute 'TheApplication'(after checking the zemax install root , I guess it has something with 'TheApplication'  attribute) Environmentpython 3.10PyCharm Community Edition 2022.1Ansys Zemax OpticStudio 2024 R1.03pythonnet version 3.0.3Attached code  What I have done:checked the address below, it is correct Could you give me some advice on this issue? Thank you YANG 

2184
Yang.Yongtao
Fully Spectral
6 months ago
Julia
Fully Spectral
JuliaFully Spectral
posted in ZOS-API
ZOS-API- How to use sequential ray tracing tools?

to_surf = TheSystem.LDE.NumberOfSurfaces-1; Ex=0;Ey=1;phaX=0;phaY=90;waveNumber=2;Hx=0;Hy=0;Px=0;Py=1; raytrace = TheSystem.Tools.OpenBatchRayTrace(); [success,errCode,exro,exio,eyro,eyio,ezro,ezio,intensity]=raytrace.SingleRayNormPol(ZOSAPI.Tools.RayTrace.RaysType.Real,Ex,Ey,phaX,phaY, to_surf, waveNumber,Hx,Hy,Px,Py,0,0,0,0,0,0); Open the batch ray trace tool Create polarized real raytracing in which a single ray with normalized pupil coordinates will be added waveNumber=2;Hx=0;Hy=0.5;Px=0;Py=0.5; raytrace = TheSystem.Tools.OpenBatchRayTrace(); [success,X,Y,Z,L,M,N]=raytrace.GetDirectFieldCoordinates(2,ZOSAPI.Tools.RayTrace.RaysType.Real,Hx,Hy,Px,Py) Open the batch ray trace tool Get direct field coordinates with input normalized field and pupil coordinates raytrace = TheSystem.Tools.OpenBatchRayTrace(); max_rays = 4; pwav = 0; for a = 1:TheSystem.SystemData.Wavelengths.NumberOfWavelengths if TheSystem.SystemData.Wavelengths.GetWavelength(a).IsPrimary == 1; p

5191
Hans-Jürgen Feige
6 months ago
Allie
Zemax Staff
AllieZemax Staff
asked in ZOS-API
How can I pull Peak Irradiance or Total Hits from the Detector Viewer analysis in the API?

Within the API, we are able to quickly pull Peak Irradiance, Total Power, and Total Hits by using the property GetDetectorData as described in the forum post 'Methods for extracting detector data through the API.' However, this property will not take into account an applied ZRD file. We can apply a ZRD file to a Detector Viewer window, so is there a way to extract the same information from there?

144913
A
Ultraviolet
6 months ago
Y
Yoshikazu.KawamataInfrared
asked in ZOS-API
How to save detector viewer graphical plot into image file by ZOS-API ?

Hello, I would like to save graphical plot in detector viewer into a picture file by ZOS-API.I looked at some similar questions in community but most of those tell that “get numerical data and draw a plot using the numerical data” or “that feature is in request” 1 year go.So, I am wondering if that feature is implemented already or not.To me, GUI already has that feature and hence it seems that if there is a function in ZOS-API  to call that feature in GUI, it gets the job done.  Does anybody know that? RegardsKazu 

12218
Amy Entin
6 months ago
Jeff.Wilde
Luminary
Jeff.WildeLuminary
posted in Code Exchange
Ideal Lens DLL (user-defined sequential surface satisfying the Abbe sine law)

NOTE (added 2/5/2024): A new version of the DLL is now available, so I have deleted the older one supplied with the posting below.  Please see this link for latest version:Ray-tracing model of a perfect lens compliant with Fermat’s principle: the Cardinal Lens ***********************Attached is a user-defined surface DLL that functions as an ideal thin lens obeying the Abbe sine condition.  It is distinctly different than a paraxial lens surface and is particularly well-suited for simulation of high-NA objectives.  The Ideal Lens surface requires two user-supplied parameters, namely the effective focal length and the paraxial magnification at which the lens yields optimal performance.  It supports arbitrary conjugates (i.e., finite conjugate, or infinite conjugate in either object or image space) and is designed to work in both standard space and mirror space.  A detailed description is provided in the included summary document, along with a discussion of several examples.  The source

102612
David.Nguyen
Luminary
7 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
How use DoNotDrawObject?

How use DoNotDrawObject?I trued like below but seems it wrongObject = TheNCE.GetObjectAt(obj)Object.TypeData.RaysIgnoreObject = ZOSAPI.Editors.NCE.RaysIgnoreObjectType.NeverObject.TypeData.DoNotDrawObject = True 

301
David.Nguyen
Luminary
7 months ago
rizaBaymak
rizaBaymakMonochrome
asked in ZPL
Z Scan Simulation

Hi, I am trying to simulate the Z-Scan experiment with Zemax, but I need a macro program. I am sharing the experimental setup. It will move the piece used as a sample from 400mm to 600mm, and in the meantime, I need to reach the normalized transmittance value from the detectors. This will be graphed later, and how can I write a macro for this? I'll be happy if you can help me.# Numune numbernumune = 4# dedector numberlaserDedector = 5dedector_1 = 6dedector_2 = 7# Minimum Z positionz_min = 400# Maximum Z positionz_max = 600# Z rangez_range = z_max - z_min# Number of samplessamples = 10# Z step sizez_step = z_range / ( samples - 1 )# Z position arrayDECLARE z_position, DOUBLE, 1, samplesDECLARE transmittance, DOUBLE, 1, samples# Loop over the different Z positionsFOR z_indx, 0, samples-1, 1    # Calculate new Z position    z_pos = z_indx * z_step + z_min    z_position(z_indx+1) = z_pos        # Update detector Z position    SETNSCPOSITION 1, numune, 3, z_pos       # Clear detectors    cl

910
rizaBaymak
7 months ago
Munseok
MunseokMonochrome
asked in DLLs
Gaussian beam generation in DLL file without random seed

I have used Gaussian.dll in Non-sequential mode for my application (Stray Radiation in the Launcher). However, there is a problem because Gaussian.dll can only generate the ray bundle with random seed (Stray radiation shows different results in each of calculation). Can I use Gaussian.dll without random seeds? Another option is the generation of Gaussian source using a source file but I also failed to find the direction cosine of the Gaussian beam.  

500
Munseok
7 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
how make thickness variable

I need remove all variables and add it to specified surface. which used in multiconfig.How I can do it?var_sufrace = 6 TheSystem.Tools.RemoveAllVariables()surface_user = TheSystem.LDE.GetSurfaceAt(var_sufrace)surface_user.ThicknessCell.MakeSolveVariable() and how I can make Par1 variable in SC mode?

961
Benjamin.N
7 months ago
fabian358
fabian358Monochrome
asked in ZOS-API
ZOS-API material model Python

Hello,I was trying to set the material model properties through Python API but it did not work. The result I get is implementation of material model to my Zemax modelm but with the refractive index of 0. Could you help me with this?Thank you in advance! The code I use is visible below:materialModel = surface.MaterialCell.CreateSolveType(ZOSAPI.Editors.SolveType.MaterialModel)materialModel.IndexNd = 1.33materialModel.AbbeVd = 5surface.MaterialCell.SetSolveData(materialModel)Best wishes,Fabian

1471
chaasjes
7 months ago
John.Hygelund
Fully Spectral
John.HygelundFully Spectral
asked in Code Exchange
Matlab function to read .bim files

For anyone that finds it useful:Below is a simple function to read .bim files into matlabThe inputs are the .bim file name and image widthThis was written to consume the output from ‘Geometric Image Analysis’.Values are consistent with units displayed in zemax as long as the Total Watts = 1function [im] = imReadBIM(fileName,image_width)% read Zemax .bim file format% John Hygelund, May 28, 2024% example use: imagesc(imReadBIM('spot.bim',.003)), axis image, colorbar, colormap jetfid = fopen(fileName, 'r');size = fread(fid, 1:2, 'int32');im = fread(fid, inf, 'float64');fclose(fid);im = reshape(im,[size(1) size(2)]);im = im';im = flip(im);im = im ./ sum(im(:)); % normalize to total weight of raysim = im ./ (image_width./size(1)).^2; % normalize to area of pixel 

440
John.Hygelund
Fully Spectral
8 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