Knowledgebase
Ansys Zemax Support FAQs
User Groups

Community
Programming OpticStudio

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

Recently active

Most replies Most views Newest first

GregDark Energy

asked in ZOS-API

Simulating relative radiant intensity sensitivity to angle of a photodiode in Non Sequential Mode

Hello, I need to simulate a VEMD2000X01 photodiode in Non-sequential mode using ZOS-API. The photodiode has a small lens above giving it the attached radiance intensity dependence to angle. I would like first to avoid having to simulate the lens above the photodiode and would like instead to give the detector an "angular sensitivity". I was thinking of using a polar detector to do so, as described in example 8 of the ZOS-API: "PythonStandalone_08_NSCEDetectorData.py" with enough "polar pixels" and then weight the number of measured rays in each polar pixel by the relative sensitivity above using python:-Is this the correct way to go forward?-Alternatively, can all this be done entirely in Zemax: Enter relative radiant sensitivity to angle for a detector in Zemax? and if yes, how should this be implemented in the ZOS-API?Thanks,Greg

640

11 months ago

kot_letovaStudent

asked in ZOS-API

ZOS-API with PSF in Matlab

I write next code, but it gives me incorrect PSF. Can you help me with finding of mistake? function [r] = BeginApplication(TheApplication, args)import ZOSAPI.*; % creates a new API directory apiPath = System.String.Concat(TheApplication.SamplesDir, '\API\Matlab'); if (exist(char(apiPath)) == 0) mkdir(char(apiPath)); end % Set up primary optical system TheSystem = TheApplication.PrimarySystem; sampleDir = TheApplication.SamplesDir; % Open file testFile = System.String.Concat(sampleDir, '\API\Matlab\TwoSystems.zos'); if (exist(char(testFile)) == 0) fprintf('You need to run Example 01 before running this example\n'); r = []; return; end % Create analysis % Open the Huygen's PSF. We will use the default settings for now huygensPSF = TheSystem.Analyses.New_HuygensPsf(); % Settings huygensPSF_Settings = huygensPSF.GetSettings(); huygensPSF_Settings.ImageSampleSize = ZOSAPI.Analysis.SampleSizes.S_128x128; huygensPSF_S

1371

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

11 months ago

Henrik ASingle Emitter

asked in ZOS-API

Missing description of some old macros

Hi!Working with a task where an old ZPL macro should be converted to a standalone application in C++ (using ZOS-API). I have encountered several macro commands that I cannot find any description for in manual/help.Is there anyone here that have the knowledge of what the corresponding calls with ZOS-API would be?Object_distance_orig = THIC(0)number_of_surfaces_orig = NSUR()IMA_SURF_NUM = NSUR()Lens_Configuration_orig = CONF()number_of_configurations = NCON() Thanks in advance!

1127

11 months ago

dgeorgievInfrared

asked in ZOS-API

Are "Update" and "Reset zoom" acesible via ZOS-API?

Hi,i wonder if for analysis window it would be possible to ask for “Update” or “Reset zoom” via ZOS-API.As if clicking on the buttons on the picture bellow.

554

11 months ago

Sebastián.de EchanizMonochrome

asked in DLLs

Maximum number of parameters in Surface Scatter DLL

I have defined a new Surface Scatter DLL with 8 user defined parameters, but only the first 6 are displayed in OpticStudio. Is there a limitation on the maximum number of parameters (in this case 6)?

360

11 months 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.……………………………

1511

11 months ago

Michael ChengZemax Staff

posted in Code Exchange

DLL (Diffractive): Non paraxial linear Y idealized polarizer model

This diffraction DLL models a non-paraxial idealized polarizer model that produces a linear polarized transverse electric field. It is an alternative to the Jones matrix, that model polarizers for paraxial fields under normal incidence. The diffractive DLL is only a tool used here to compute the electric field. For more information, check: https://www.researchgate.net/publication/324234609_Non-paraxial_idealized_polarizer_model This DLL works for OpticStudio subscription licenses. The source code is not shared.Author: Michael Cheng Click here to download Date Version OpticStudio Version Comment 2021/12/01 1.0 - Creation

9475

11 months ago

Robert.McLeodSingle Emitter

asked in ZOS-API

Are blackbox files incompatible with the API?

I am using a standalone Matlab API in sequential mode to load a .zmx file and do various analysis with data handed back to Matlab. This works perfectly except when I include a blackbox element. The .zmx file loads and I can modify and query it in standard ways. When I execute any analysis (e.g. a PSF calculation), the structures returned are empty. I don’t get an error message, just empty results. If I replace the blackbox lens with a stock element, everything works again. I can execute the analysis in OpticStudio by loading the .zmx file (with the blackbox) and selecting the analysis from the menu. Are blackboxes incompatible with the API or is there something special you need to do, maybe telling the blackbox file to load after the .zmx file is loaded?Thanks in advance for any pointers!

501

1 year ago

dgeorgievInfrared

asked in ZOS-API

How to set STOP surface using ZOS-API?

Hi,i am new and playing with zos-api and programmatically defining an optical system in sequential mode.However, i was not able to find how to set the STOP surface using the zos-api.Any hints? Your advice is highly appreciated.

bdocSingle Emitter

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!

763

1 year ago

SahilVisible

posted in ZOS-API

Export Analysis, Graph and Layout JPG using ZOSAPI Interactive Extension Python and Matlab using ZPLM

We can use Python or Matlab Interactive Extension to execute Macro using ZPLM. Please take these stepsWrite a ZPLM code that can export JPG or BMP from a given window. GETSYSTEMDATA 1 EXPORTJPG 1, "C:\test\JPG_file\3DLayout" EXPORTBMP 1, "C:\test\JPG_file\3DLayout" OPTRETURN 0 You can read more about ExportJPG and EXPORTBMP in our help files: The Programming Tab > About the ZPL > KEYWORDS (about the zpl) > EXPORTJPG Save the file as ZPL55 or ZPL”Any Number you like”. Use this ZPLM in Merit Function Editor. In case if you like to know more about using ZPLM as Operand in Merit Function Operand. Please check this KBA: Optimization using a ZPL Macro: the ZPLM operand. Save this Merit Function as “ExportImage.MF” in folder Zemax LLC\Documents\Zemax\MeritFunction 4.Write Python or Matlab Program to run the ZPLM through Inter

5682

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?

1701

1 year ago

Xavier.BorregaSingle Emitter

posted in ZOS-API

API Settings - Transmission vs. Wavelength

I'm trying to use the Matlab ZOS-API to define the settings (surface and minimum & maximum wave) of a coating transmission vs. wavelength analysis but I am not able to access them using GetSettings().     

3804

1 year ago

icybirdInfrared

asked in DLLs

define clear aperture of a lens array

I am using us_array.dll to model a lens array. I would like to define clear aperture of each lens in the array, for example the pitch is 500um, but clear aperture is 400um, is there a way to do this?Appreciate your advice.

Does GetAllDetectorDataSafe() smoothen the incoherent irradiance?

Hello everyone, I use Zemax 22.3 professional and have the following problem:I build a simple toy model in the NSC Editor consisting of a perfectly collimated light source (1mio rays) and Detector (150x30 pixel).I have two scenarios which should give the same resultsI get the incoherent irradiance over the Zemax API (in Python) with the function “GetAllDetectorDataSafe()” (no detector smoothing activated) I get the detector intersection points and intensities of each ray with the ZRD datareader function BatchRayTrace.ReadZRDData() and calculate the detector distribution with a two dimensional histogram (e.g. with numpy.hist2d())While the distributions definitely correlate, scenario 1 looks significantly smoothed compared to scenario 2 (I checked and there is no energy loss of the rays between the source according to the ZRD datareader and the detector as expected and also within the Zemax GUI the distribution looks smoothed).If I interpret the Zemax manual correctly this should not be

691

1 year ago

AllieZemax Staff

posted in ZOS-API

Call a parameter by its name in the ZOS-API

When dealing with non-Standard surface types, you typically have access to extra parameters that are specific to that surface. For example, the Coordinate Break surface provides inputs for Decenter X, Decenter Y, etc. Coordinate Break surface type with the extra data parameters highlightedTo access these parameters in the API, our sample code offers two options:Access a parameter based on the parameter number. A typical command for this may look like the following: decenterX = TheSystem.LDE.GetSurfaceAt(1).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par1).DoubleValue; Access a parameter based on its column number. A typical command for this may look like the following: decenterX = TheSystem.LDE.GetSurfaceAt(1).GetCellAt(12).DoubleValue;In both of these cases, you will need to have prior knowledge of the location in the LDE of the parameters you want to change. Or you will need to query the “Header” of the column you’re working with to confirm the parameter is correct. There is a th

9317

1 year ago

BeauDiddleyMonochrome

asked in ZOS-API

Zemax API - Huygens PSF Output not matching TXT file

Hi everyone, I created a Matlab script which can both output the results txt file via ‘GetTextFile’ and read the results of a Huygens PSF analysis directly. The problem is that these do not match. Excerpt from my code:newWin = TheSystem.Analyses.New_HuygensPsf();...newWin.ApplyAndWaitForCompletion();newWin_Results = newWin.GetResults();data = newWin_Results.DataGrids(1).Values.double;newWin_Results.GetTextFile(outFolder) Txt File Data Snippet:data variable above snippet:Is “DataGrids(1).Values.double;” the proper way to extract this information from GetResults? The text file also matches what standalone OpticsStudio provides me so I am taking that data to be the truth.

1215

1 year ago

Michael ChengZemax Staff

posted in Code Exchange

YZ view for POP simulation

Attached python script loads a ZBF and propagate the beam to a specific range with given sampling. And then draw the beam in YZ view.Currently POP doesn’t support YZ view, but we can first save a ZBF file and use this tool to show YZ for desired range in z direction.The settings are as below.The beam will be drawn for the range between d1 and d2. We can specify the sampling with the variable samp. The UseAngularSpectrumPropagator must be True for now. We could update it to support False, but this requires some more complicated stitching process. The wave should be correctly set up with the wavelength in the ZBF, otherwise we would get wrong result. Click here to download Date Version OpticStudio Version Comment 2023/08/14 1.0 23R2 Creation

2435

1 year ago

cyril.BourgenotSingle Emitter

asked in Code Exchange

Get Primary system file name

Hello all,I am new to the ZOS API, and would like to know how to get the file name once the connection has been done. I am using Python and I have tried : TheApplication = TheConnection.ConnectAsExtension(0)TheSystem = TheApplication.PrimarySystemprint(TheSystem.SystemName) but I can’t get the name of the zemax file. Any idea how get it?

462

1 year ago

Jeff.WildeLuminary

asked in ZOS-API

Reading analysis header lines with C++

I’m writing a user-defined merit function operand in C++ and would like to read the header lines from an analysis window (and then parse the results to extract numerical values of interest). For example, in POP, the header contains several useful numbers related to the analysis results. Using Matlab, this is fairly simple as @Allie discusses here: However, it appears that in C++ the header lines are passed using SAFEARRAY. There is one example (#23) that shows how this is done for numerical arrays (see below). Just curious if someone might know how to do something similar for the header lines? Is it possible to get the header lines in the form of a string array? If so, a simple example would be greatly appreciated! Thanks,Jeff

882

1 year ago

MeryInfrared

asked in DLLs

OpticStudio metalens example dll cant be loaded

I have the latest version of OpticStudio and trying to run an example https://optics.ansys.com/hc/en-us/articles/18254409091987When I open the.zprj file from step 6 of the manual, I get the following error (Image attached). What is wrong with it? How I can fix it?

1941

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

1293

1 year ago

Daniel P. CaleroMonochrome

asked in ZOS-API

Coordinate return in ZOS-API

Hi,I am trying to make a script in ZOS-API where I introduce some tilts and displacements. At one moment I want to make an automatic return to a given surface. Is there a way to use the coordinate return of the coordinate breaks in the ZOS-API?Thanks,Daniel

561

1 year ago

dgeorgievInfrared

asked in ZOS-API

Not able to run example 23 from “Zemax\ZOS-API Sample Code\Python”

Hello,i am using Zemax Optics Studio 23.1 and trying to run the python example files included in the “Zemax\ZOS-API Sample Code\Python” directory.While others seem to work, when trying to run “PythonStandalone_23_ray_fan_native_manual_comparison.py” i get an error.----Traceback (most recent call last): File "c:\ex\PythonStandalone_23_ray_fan_native_manual_comparison.py", line 262, in <module> ray_settings.Field.UseAllFields() ^^^^^^^^^^^^^^^^^^AttributeError: 'IAS_' object has no attribute 'Field'Exception ignored in: <function PythonStandaloneApplication.__del__ at 0x000001D4F7E9F880>Traceback (most recent call last): File "c:\ex\PythonStandalone_23_ray_fan_native_manual_comparison.py", line 72, in __del__TypeError: 'MethodObject' object is not callable----I run the original file without any changes. Could somebody please possibly advise if eventually the API did evolve and this particular example file is no more compatible?Best regardsDimiter

1593

1 year ago

Page 6 / 28

Badge winners

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
TMXhas earned the badge Allow me to introduce myself
Yang.Yongtaohas 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.).

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