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

4961
Hans-Jürgen Feige
5 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?

140713
A
Ultraviolet
5 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 

11788
Amy Entin
5 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

100412
David.Nguyen
Luminary
5 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 

281
David.Nguyen
Luminary
6 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

860
rizaBaymak
6 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.  

450
Munseok
6 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?

951
Benjamin.N
6 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

1391
chaasjes
6 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 

420
John.Hygelund
Fully Spectral
6 months ago
laser-axel
laser-axelSingle Emitter
asked in ZOS-API
New ZRD file format

There used to be the possiblity to export ray trace data into a Ray Database File (ZRD) file with well documented binary file format. I used this a lot to read the data into a python numpy array for further analysis.Documentation still states: “thus the first integer will be 2002 for UFD format, 12002 for CBD format, and 22002 for CFD format ZRD files.”But with Opticstudion 2024.1 when selecting “uncompressed full data” the first integer number in the file is 2003. And the format of the file has changed. Is there a way to make zemax export to the old 2002-Format or at least a documentation for the new format?

1573
R
Ultraviolet
6 months ago
klaus
klausSingle Emitter
asked in Code Exchange
Export volume detector data Zemax?

 Hello Forum,I got a volume detector with 100 x/y-planes in the z direction (#z-pixels). See screenshot below.When running NSC ray tracing I want to save all of them to individual text files 1;2;3;4;5…. 100automatically if possible.Any suggestions of using a macro would be appreciated. Thank you Klaus 

1126
klaus
6 months ago
CJ27
CJ27Student
asked in ZOS-API
Using ZOP-API to trace a set of rays through a non sequential system

Hello there Zemax community,In connection to the post I was wondering if this tool would be the right tool for tracing a sequence of rays in non sequential mode via python.So far, I have tried using this single ray tracing approach in order to trace a sequence of rays from my source through an optical system which includes two freeform surfaces. This is how my system looks like:  At the end, what I want to do, is to trace specific ray directions originating from the source location (the point at the left) and extract the ray directions after refraction from the first surface towards the second surface.However, when I try to do this with the single ray tracing tool, for some reason, the tool always traces the same on axis ray and I cannot get any information about the other rays directions.This is an example of the code that I am using (I am using the python interface to the ZOP-API):nscsrt = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.NSCSingleRayTrace)nscsrt_settings =

1431
laser-axel
6 months ago
William Oak
William OakInfrared
asked in ZOS-API
How to generically change a column value?

Hello,So I’ve been getting into the zos-api. I’ll not that I have little experience in object-oriented programming, so that might be limiting me. I’ve been trying to be able to target specific columns in the NCE editor for editing and having trouble doing so generically.Currently, the only way I’ve found to do is the following (as an example):Object.GetObjectCell(ZOSAPI.Editors.NCE.ObjectColumn.Par1).DoubleValue=valueWith “par1” being the enum element of ObjectColumn. The problem is, I cant find a way to change that without straight-up adding a new line. So if I wanted to be able to, for example, modify several columns, I would need to have multiple lines, each with their own call. I’ve tried to make a function to do it generically, but I cant figure out a way to change it (The “Par1”).I’ve found 2 functions that seem related, but dont really allow my to alter that element on the fly.Enum.Getname finds a string corresponding to the enum element from an interger;Enum.Parse does the oppo

1063
William Oak
6 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
how close analysis window or hide it?

If I make long analysis too many windows seems reduce perfomance.how I can supress them or close?I saw similar topic, but not sure how find it for analysis 

662
David.Nguyen
Luminary
6 months ago
nc9289
nc9289Infrared
asked in Code Exchange
How to sum POP beams coherently

I am interesting in recreating the tutorial on summing POP beams coherently in python, has anyone tried this ?Is there an equivalent ZBFSUM commant for python ? https://support.zemax.com/hc/en-us/articles/1500005487201-How-to-sum-POP-beams-coherentlyThe attachments given in the tutorial donot contain the full code file, therefore I could use some help on the revelant commands in python ? Is writing a macro more suitable for this task ? Regards, NC

430
nc9289
7 months ago
nc9289
nc9289Infrared
asked in ZOS-API
POP analysis

Following the suggestion about using Python with POP from (last message) :  I am trying the following (sharing a code snippet) : # Open fileTheSystem.LoadFile('locally stored file', True)my_pop=TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.PhysicalOpticsPropagation)print(my_pop.HasAnalysisSpecificSettings)# Access the settings interface for the Physical Optics Propagation analysismy_pop_settings = my_pop.GetSettings()settings = my_pop.GetSettings().__implementation__settings.GetParameterName(1)settings.BeamType = ZOSAPI.Analysis.PhysicalOptics.POPBeamTypes.GaussianWaistsettings.SetParameterValue(0, 2.5)I don’t get any error, however  SetParameterValue(0, 2.5), doesn’t reflect the change made to 2.5 for Waist X. Can you please help me spot the error here?  

471
nc9289
7 months ago
Manuel Fragata
Manuel FragataStudent
asked in DLLs
DLL (Diffractive): Binary DOE with terms X0Y1 and X2Y0. Problem in Mirror Space

Hey everyone![All necessary files are attached]I am coding a User-Defined Surface (.dll) to simulate the behaviour of a Diffractive Optical Element (DOE), which in this case will have a phase profile given by the following equation:phase  = (X0Y1 * y) + (X2Y0 * x^2) where X0Y1, and X2Y0 will be coefficients that the user can input in the LDE to later use it for optimization.So far, the code I wrote for compiling the DLL was based on the code written by  @Michael Cheng : “us_binary_mix12.c”, where I adapted it according to my needs. To check whether or not the code is working correctly, I am comparing the rays/beams behaviour when this User-Defined surface is used and when the equivalent “Binary 1” surface is used. If the coefficients X0Y1, and X2Y0 are the same, then I expect the same results, regardless of the surface I use. (Of course, assuming that the units for these coefficients are consistent with each other).Problem: In the front pass of the system, i.e. no mirror space, the res

1320
Manuel Fragata
7 months ago
Chanitti
ChanittiMonochrome
asked in ZPL
Save macro files

Dear all, I have a macro code and works fine but couldn’t save the text files. Here is part of macro code that I am using the commands to save the data.……………...fileNameHMF$ = folderPath$ + "hmf"+ index1Str$+".txt"UPDATE ALL PAUSE THREADSGettextfile fileNameHMF$, "Hmf", settingFile1$, 1CONVERTFILEFORMAT fileNameHMF$ ,1 I used to work on this macro code on another desktop. However, when I switched to other desktop the macro code runs but doesn’t save the txet files. Please anyone have an idea!

483
Mark.Nicholson
Luminary
7 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
how to parse CFG?

if I have .CFG of geometric bitmap analysis. How I can extract pixel size and other info out of it with python or similar tool?

230
A
Ultraviolet
7 months ago
William Oak
William OakInfrared
asked in ZOS-API
Difference between ZOS-API and Zemax Flux Measurements

Hello Folks,I’ve recently started working with the ZOS-API in python, and I’m concerned there’s something fundamental I’m not understanding. Namely, whenever I use a GetDetectorData(DetObj, 0,0,0), the number generated does not match the value of “Total Power” obtained through zemax. So I prepared an example with Example02; I’ve attached the modified file.When I call the detector data to get flux (ret1, p_val = TheSystem.NCE.GetDetectorData(4, 0, 0, 0)), I get p_val=14710.99 ; however, when I check the Total Power on the associated zemax file*, I get 7.3533 lumens. I’ve made attempts with the other data types, and with other functions (GetCoherentData), with similar issues.Question remains, how to measure total power on a detector through the ZOS-API? *"C:\Users\william.deschenes\Documents\Zemax\Samples\Non-sequential\Miscellaneous\Digital_projector_flys_eye_homogenizer.ZDA"

793
William Oak
7 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
how supress double calculation for analysis?

@David Nguyen  below video with problem. in each window calculation maded 2 times. How this can reduce it to 1?https://youtu.be/1cIMvsqjmDsTheSystemData.Wavelengths.GetWavelength(2).Wavelength = wave_umgeometric_bitmap_analysis = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.GeometricBitmapImageAnalysis)geometric_bitmap_settings = geometric_bitmap_analysis.GetSettings()geometric_bitmap_settings.ModifySettings(geometric_bitmap_settings_filepath, "GBM_OUTPUT", file_name)geometric_bitmap_settings.LoadFrom(geometric_bitmap_settings_filepath)geometric_bitmap_analysis.ApplyAndWaitForCompletion()

391
David.Nguyen
Luminary
7 months ago
liz_strong
liz_strongInfrared
asked in ZOS-API
zos api: change surface for geometric image analysis

Hello! Can somebody please help me figure out how to change the surface for geometric image analysis? I’d like it to default to the image surface. gia_run = TheSystem.Analyses.New_Analysis_SettingsFirst( ZOSAPI.Analysis.AnalysisIDM.GeometricImageAnalysis ) # make new analysis, but don't run itgia_settings = gia_run.GetSettings() # I was hoping for something like the following (this doesn't work though)gia_settings.Surface = ZOSAPI.Analysis.Settings.Surface.IAS_Surface.UseImageSurfaceThanks!Liz

23913
David.Nguyen
Luminary
7 months ago
Liang
LiangSingle Emitter
posted in ZOS-API
Minor Correction of Example 02 Python Code

Hi everyone,In sample file 「PythonStandalone_02_NSC_ray_trace.py」, I found several slight mistakes and going to share here.First in Line 192, pix = 0setting parameter pix as 0 may cause unexpected detector data of the firt pixel(Line 199). Changing pix to 1 may fix the problem. And in Line 216, detectorData = zos.transpose(detectorData)「transpose」should be function of 「numpy(np)」,this may be typing mistake. Please confirm and I hope it helps.

431
David.Nguyen
Luminary
7 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
ZOSAPI changing settings

I try to use code from example e23s08_py for changing settings of analysis window, but meet error with ray_settings.Field.UseAllFields()ray_settings.Wavelength.UseAllWavelengths()Traceback (most recent call last):  File "C:\Program Files\JetBrains\PyCharm 2023.1.2\plugins\python\helpers\pydev\pydevconsole.py", line 364, in runcode    coro = func()           ^^^^^^  File "<input>", line 126, in <module>AttributeError: 'IAS_' object has no attribute 'Field' ray = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.RayFan) ray_settings = ray.GetSettings() ray_settings.NumberOfRays = max_rays / 2 ray_settings.Field.UseAllFields() ray_settings.Wavelength.UseAllWavelengths() ray.ApplyAndWaitForCompletion() ray_results = ray.GetResults()but even if I supress them   ray_settings.NumberOfRays = 0dont change default value, silently. 

1768
David.Nguyen
Luminary
7 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