Knowledgebase
Ansys Zemax Support FAQs
User Groups

Community
Programming OpticStudio
ZPL

ZPL

Find out how you can save time and energy using the Zemax Programming Language!

193 Topics
513 Replies

When you subscribe we will email you when there is a new topic in this category

193 Topics

Most replies

Most views

Newest first

Ariel11Single Emitter

asked in ZPL

ZLPM file location

Hi,How do I know where my macro files are stored? are they in the general Zemax/macro directory or in the local project? After assuming its local, when reopening the file (after closing Zemax) it went to the general one instead. Is there a way to control this? Thanks

301

8 months ago

Sean TurnerUltraviolet

asked in ZPL

ZPL Edit/Run UI status does not show actual ZPL code line number

I was just testing a macro when I noticed something strange. The number shown in the Edit/Run UI does not match the actual line number in the ZPL macro editor. I grabbed this image while the UPDATE ALL line was running, but the Status indicates line 5 is currently running. Line 5 is just a comment. It appears the lines with “!” are being ignored by the status indicator. For reference, I am using Zemax OpticStudio 23.2.1

170

9 months ago

Roger.Conley SmithMonochrome

asked in ZPL

ZRD2MAT Multi-Threading Failure Error

I am running a macro that sweeps through different source ray angles, traces the system, and then saves the .ZRD file to a matlab .MAT file. There are only 4 rays being traced and the system is somewhat simple, so the ray trace time is quick. However, I have started to see this error regarding multi-threading. Since I have many .ZRD files I would like to convert, is there a way to turn off multi-threading in a command so I don’t have to click through the error message for every .ZRD file? Thanks in advance. Code section:FOR io, ip_ang_start, ip_ang_end, 1 #Change angle SETNSCPOSITION 1, ip_source, 5, io #Create file name traceName$ = $STR(io) fileName$ = "\inputRays" + traceName$ + ".ZRD" matFileName$ = "\inputRays" + traceName$ + ".MAT" PRINT PRINT "Input Angle: ", io PRINT fileName$ #PRINT matFileName$ #NSTR surf, source, split, scatter, usepolar, ignore_errors, random_seed, save, savefilename, filter, zrd_format NSTR 1, 0, 1, 1, 1, 1, 0, 1, fileNa

796

10 months ago

Matthew.ThrossellSingle Emitter

asked in ZPL

Numeric Function SURC(A$) in NSC

It appears that SURC(A$) only works for sequential files. Is there an equivalent function that will work with Non-Sequential files?

722

11 months ago

xavier_bthMonochrome

asked in ZPL

Solutions to hide details of a ZPL macro

Dear Zemax community,I currently have a ZPL macro that has two inputs taken from the MCE and computes the radius of curvature of a surface, based on these two values. What is useful is that I can set my two inputs as variables and run some optimization so i’m quiet happy about it.Now I would like to hide the equation so that my zemax file performs the same but no one can access the details of the computation within my ZPL macro. I understand there is no way to encapsulate a ZPL macro or create a black box around it. What other options do I have that would work in the same fashion as this ZPL macro?Thanks

1233

1 year ago

yonghong.LiMonochrome

asked in ZPL

Output length limit

When using print to output in zpl, there is a limit to the length of one output. How can we break through this limit and output multiple parameters at once?

382

1 year ago

Harvey.SpencerMonochrome

asked in ZPL

How to SETSURFACEPROPERTY using a variable?

I have defined an array variable with various surface parameters called L1(i,j)for example:L1(1,1) is the value of a curvatureL1(1,2) is the value of a thickness I would like to use the numeric values of this array variable in a .ZPL so for instance I could say: SETSURFACEPROPERTY 12, 2, L1(1,1)but I see that I cannot use a variable that is a number for the value of the curvature., has to be converted to a STRING Why the heck not, the curvature is not a string but IS a number? Just another backward ancient programming ZEMAX thing. Anyway, I guess that the value of the lens parameter to set has to be a STRING, a number, or a numerical expression, not a variable? So how do I convert L1(1,1) to a STRING to set the curvature parameter in the lens which is actually not a string but a number? Retarded. I thank anyone for the time taken to help. I tried to use the $STR(val) and FORMAT but loe and behold can’t get that to work.Like $STR(L1(1,1)) gets rewarded an error message.……………………………

bdocMonochrome

Hello, I want to change the x-pos in the NSC editor. How can I do that using SURP? The NSC surface is at 13 in the lens data editor, NSC object is 8.Please let me if you need more information. Thanks in advance!

833

1 year ago

a_crtSingle Emitter

asked in ZPL

Calling a .ZPL macro from a tolerance script

Hello!TLDR: Is there a way to run a .ZPL macro from within a tolerance script? I’m trying to add and remove fields during the tolerance script used in my Monte Carlo simulation because I suspect this could make things run a little faster but so I made an “add_fields.ZPL” and a “remove_fields.ZPL”. Context: Have a tolerance script that has a few optimizations and a final performance evaluation merit function is called. I don’t need all the fields for the optimization but I do for the final performance evaluation. So two questions…1) I’m assuming more fields (especially with ray aiming) will slow down my nested optimizations even if I’m not calling all of the fields in the merit function, is this true? 2) Any way to call the macros I made “add_fields.ZPL” and a “remove_fields.ZPL”? Or alternatively, can I play around with SYSP during a tolerance script?

1781

1 year ago

Daoming.DongInfrared

asked in ZPL

Encapsulate ZPL marco

Dear all, I’m currently developing several Marcos for a specific system. I’m wondering if there is a method in ZEMAX that can let me to encapsulate my code like a black box? Best wishesDaoming

1313

1 year ago

JonaszVisible

asked in ZPL

Semi-Diameter larger than Mechanical Semi-Diameter

The semi-diameter of some radially symetric surface is set to “automatic”. From the Zemax help, I understood that the diameter is adjusted so that no rays are clipped.I´m confused by the mechanical semi-diameter, which in some cases takes a smaller value than the semi-diameter. See picture. Shouldn´t the mechanical semi-diameter always be larger than the semi-diameter? Why isn´t it so, when all the values are set to automatic?

3415

1 year ago

Michael.YoungVisible

asked in ZPL

Record GUI interaction as ZPL commands?

I was helping a colleague with ZPL the other day. He wanted to know how to set a field as a variable and then constrain it. Additionally, he wanted to do this through a ZPL.The first part is easy enough. My approach was to expose the field as a variable through the multi-configuration editor using “YFIE”, declaring the solve as “Variable” and then constraining it in the merit function editor with “MCOL”, “MCOG”, or “MCOV”.For the ZPL portion, I wrote a small script for him demonstrating how to assign a variable in the MCE with ZPL.CLOSEWINDOW ! INSERTMCO, 1 # insert a row into the mce.SETMCOPERAND 1, 0, "YFIE", 0 # changes the operand to "YFIE"SETMCOPERAND 1, 0, 1, 1 # assigns YFIE to field no. 1 SETMCOPERAND 1, 1, 15, 0 # changes the value of row 1 config 1 to 15SETMCOPERAND 1, 1, 1, 3 # changes the solve type to "V"BEEP This made me think that it would be useful if there were a way to record GUI interactions as lines in a ZPL. For example, I could turn on the propose

902

1 year ago

liz_strongInfrared

posted in ZPL

Geometric image analysis ZPL API incomplete

Hello! A feature request -- could you please complete the ZPL API for geometric image analysis? It would be handy to be able to modify parameters available in the GUI that aren’t included in the API yet like the “use polarization” check box & the reference dropdown menu. Thanks!Liz

1424

1 year ago

Renaud.LigotInfrared

asked in ZPL

saving txt files in a loop with incremental file name

HiI would like to save a txt file at each step of a loop. So I need to change the name of the saved file to not overwrite the previous one. Does someone have an example to share?Thank you.

1122

1 year ago

Keiya.YoshidaSingle Emitter

asked in ZPL

Where is the detail explanation of MODIFYSETTINGS key word "Tfg"?

Hi, I’m trying to develop a ZPL macro that can get the Through Focus Geometic MTF which modifysettings key word is “Tfg”. But I’m not able to find detail explanation of “Tfg” in UserManual.PDF. In case of “Tfm”, I know the Modifysettings of “Tfm” is supported. I was able to run the ZPL code like below. MODIFYSETTINGS tfmcfg$, TFM_SAMP, calc_tfm_sampBut the ZPL code include “Tfg” like below has errored.MODIFYSETTINGS tfgcfg$, TFG_SAMP, calc_tfg_sampERROR in MODIFYSETTINGS: Incorrect version number in settings file.Please let me know whether “Tfg” code is supported or not?Keiya Yoshida

1277

1 year ago

alexander_dumontInfrared

asked in ZPL

Why does the merit function have different values than when I run ray trace?

So I’m trying to optimize a design in Zemax non-sequential. However I’m noticing that there is a discrepancy between what the MF editor reports, and what I see from running ray trace and running detector viewer. My MF looks like the following: And I see that the total flux (line 7) is 0.619 out of .75. This is a very good number. So then I cancel the optimization, and perform a ray trace, and when I take a look at the detector viewer, I get the following:How can the MF editor be displaying 0.619, yet the total power, which I think is the same metric on the detector viewer is indicating 0.422?

1531

1 year ago

LuciaSingle Emitter

asked in ZPL

ZPL to save geometric image analysis images in a loop

Hi, I’m trying to use ZPL to run a couple of loops and save geometric image analysis. This loops aim to change the field and wavelength in the settings of the image, but I cannot make it work. If I go for the text-only saving option, it doesn’t change either. To guide you into the code, first I define the x and y of the fields:DECLARE setxfields, DOUBLE, 1, 9DECLARE setyfields, DOUBLE, 1, 9setxfields(1) = 0.0setxfields(2)=9.68938 …setyfields(1)=-0.0 setyfields(2)=-0.034… Then define the folders and filenames and then start the loopFOR wave2, 1, 9, 1 FOR field, 1, 9, 1 field_x = setxfields(field) field_y = setyfields(field) SETSYSTEMPROPERTY 101, 9 SYSP 102, 1, FLDX(field) SYSP 103, 1, FLDY(field) SYSP 202,1,WAVL(wave2) window=WINL() OPENANALYSISWINDOW "IMA" UPDATE ALL filename$ = arm$+"_"+mode$+"_"+"test_wave_"+$str(WAVL(wave2))+"_field_"+$str(field)+".bim" filename2$ = arm$+"_"+mode$+"_"+"test_wave_"+$str(WAVL(wave2))+"_field_"+$str(field)

2102

1 year ago

JiYMonochrome

asked in ZPL

How can I import Grid Sag in macro using buffer

Hi all, I am writing a ZPL macro which calculates phase patterns and imports the phase into Grid Phase Surface automatically. (There is a typo in title. I’m using a Grid Phase Surface) I found a way to import the grid phase using IMPORTEXTRADATA keywords in a below questionMacro import of .dat file onto a Grid Phase surface | Zemax CommunityBut it requires “reading” .dat files; so, I should firstly generate .dat file for the calculated phase profiles, and after that I could read again the phase from those .dat files to import. It seems to be very inefficient method and takes too long time to write and read my phase profile. Is there any way to import phase data directly from another data types in ZPL (like array or vec) instead of writing and reading .dat files? With best regards,Jiwoon.

734

1 year ago

cameron.voStudent

asked in ZPL

ZPL Macros: Efficient ways of getting data points from the MTF

Hello,I am trying to develop a ZPL macro that will be used in my merit function so that different wavelengths and different fields will all share the same MTF. I am currently getting very good results with my code, but it is a little bit slow at roughly 8 seconds per cycle which is worrisome as I am currently only doing 1 field with 3 wavelengths. I was wondering how GETMTF actually works since it seems like it is calculating the entire MTF and only extracts the value for a single specified frequency when GETMTF is ran. For my purpose, it would be more efficient to calculate the entire MTF once for each wavelength/field, and then I could just grab the values directly from the MTF rather than having to run a loop combined with GETMTF to get the values I need to calculate MSE. Please let me know if you have any suggestions on making my code more efficient or any alternative methods to solve this problem.

2441

1 year ago

William OakInfrared

asked in ZPL

How to stop NSTR from resetting number of cores?

Hello,So I’ve been trying to alter the number of cores through a macro by using “SYSP 901, []”. However, each time I run the ray trace (NSTR 1, 0, 0, 0, 0, 0, 0), the number of cores resets to its maximum value.To attempt to identify why, I re-used the code proposed HERE, adding a “print SYPR(901)”, and I get the following.The elapsed time varies somewhat, but stays close enough to one another to conclude that the NSTR is somehow resetting the # of core before running the ray trace.-The duration is coherent with 20 cores (~7.8s) if I run it using the Ray Trace Control window; the time at 1 core is ~40s, 16 cores 7.4 s-I’ve tried using the advanced options in the system explorer to Turn Off Threading, without it having any apparent effect.-Apparently NSTR does an update to everything before running, but I’ve not been able to reproduce the bug with “UPDATE” so I don't think that's the cause.-I’ve tried other files and seen the same issue (namely Projector Modeled Using an IES Data File.Z

spacebabaMonochrome

Hi guys, I am new to learning ZPL. I have a list of macros that I am tasked to write at work. Here are the list below with their purpose. I was hoping anyone have written similar macro, p[lease share or give me tips on how to write them. Thanks.Compute the paraxial ABCD matrix between 2 surfaces. Bend a lens. Given one radius, compute the other radius to maintain the focal length. Macro to plot and optionally list the distortion over the full image format Calculate relative or absolute dn/dT values based on the Schott equations Draw the aperture(s) associated with a surface. Define a macro function to compute the clearance between two surfaces, including the sags of the two surfaces Compute the angular boresight error in object space of the system due to the decentration of a surface or a group of surfaces. Compute the edge thickness between two surfaces at a specified x,y location Plot the FOV points Tabulate the focal lengths of each component in the specified surface range. A compon

10004

1 year ago

OranVisible

asked in ZPL

SETNSCPOSITION/ SETNSCPARAMETER In ZPLM

Hello, I want to push into my model an input file with data regarding new position/ parameters.When I execute the ZPL code through the GUI (Programing>Edit/Run, F9) it works just fine, but when I try to execute it through the merit function with a ZPLM row it seems that the SETNSCPARAMETER/ SETNSCPOSITION just isn’t working.I know the MFE is executing the ZPLM since I made a debug output which looks just fine, feels like I’m missing something very basic.Code snippet:OPEN INPUT_FILENAMEOUTPUT OUTPUT_FILENAMEREAD NUM_OF_PARAMS NUM_OBJPRINT NUM_OF_PARAMS, " ", NUM_OBJFOR II, 1, NUM_OF_PARAMS, 1 READ PARAM_NUMBER PARAM_VALUE PRINT PARAM_NUMBER, " ", PARAM_VALUE SETNSCPARAMETER 1, NUM_OBJ, PARAM_NUMBER, PARAM_VALUENEXTCLOSE An input/output example of the code above:## INPUT ##3 181 50 2 50000.0 3 0.005## OUTPUT ##3.0000 18.00001.0000 50.00002.0000 50000.00003.0000 0.0050 Edit: Wanted to point out that my ZPL files are located in Zemax/Macros

1842

1 year ago

James.FryUltraviolet

asked in ZPL

Macro import of .dat file onto a Grid Phase surface

I have a macro that converts .tif files to .dat files via the CONVERTIMAGETOGRID keyword and that all works like a charm and it creates wagonloads of .dat files. What I’d like to do next is import those files into a prescription with an established Grid Phase surface via the same macro . . . but I don’t see a ZPL way to do that?Anybody have any ideas?Thanks!

2162

1 year ago

David.NguyenLuminary

posted in ZPL

Adding easing to animations

Hello everyone, I just wanted to share some work I’ve been doing today with adding easing to animations for OpticStudio.In March 2021, Dan Hill published his fine article: How do I create presentation quality graphics and animations? At the end of the article, Dan demonstrates how to produce a 360 degree animated GIF using ZPL.However, one may want to rotate an object over a smaller angular range, and go back and forth from the original position. If you were to do so naively using Dan’s approach, every frame would be at a fixed angular position from the previous one, and you would obtain a “linear” GIF. However, you can obtain a slightly different result if you apply an easing function. There’s an outstanding website, called https://easings.net/, that demonstrates how to make use of such easing functions and the website also includes the formulas necessary to calculate these easing functions.Let me demonstrate the result with an example first, and then show you the workflow I used.I wa

1810

1 year ago

JuliaFully Spectral

posted in ZPL

ZPLM tricks that you may don't know, but can be incredibly useful

I will share examples of using ZPLM as a workaround to solve some problems that I see/ you may experience in my daily support 😀.

13007

1 year ago

Page 2 / 8

Badge winners

Bharadwajhas earned the badge Allow me to introduce myself
John.Hygelundhas earned the badge Visibly Un-Polarized
guangjun.gao@nasa.govhas earned the badge Allow me to introduce myself
Michael.Younghas earned the badge Visibly Un-Polarized
nadav.amitaihas earned the badge Visibly Un-Polarized

Show all badges

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.

Enter your e-mail address

Back to overview

Scanning file for viruses.

Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.

Zemax Community

Manage email notification
Private Message Inbox
My Subscriptions
Posting guidelines

Need more help?

Ansys Zemax OpticStudio
Knowledgebase
Software Downloads
Consultants
Open a Case

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

不要提供任何受适用法律，包括中华人民共和国的网络安全和数据安全法限制的信息或数据（如重要数据、国家核心数据等）。