Knowledgebase
User Groups

Create topic
Login

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.

224 Topics

Recently active

Most replies Most views Newest first

Full Vectorial Fields from POP

Hi,I would like to calculate the coupling efficincy into different few mode fibers. For this I would need the complete E and H vectorial fields from POP. Is obtainng the [Ex(X,Y), Ey(X,Y), Ez(X,Y)] and [Hx(X,Y), Hy(X,Y), Hz(X,Y)] of a field possible in zemax? If so what is the best aproach? Thank yo...

ZOS-API

Conversion between integer type and ZOSAPI Enum in MATLAB

I’d like to programmatically adjust the value of a Parameter cell in the Non-Sequential Editor, something like:TheSystem.NCE.GetObjectAt(obj_num).GetObjectCell(cell_num).DoubleValue = value;However, GetObjectCell only takes a ObjectColumn enum as an argument, and the ObjectColumn enum does not seem...

ZOS-API

How to combine ray scattering and ray splitting in IRayTraceNSCData in the IBatchRayTrace interface?

I am simulating light propagation through an optical stack and analyzing the path of individual rays.Using the IBatchRayTrace interface is the only way I found to achieve reasonable performance, however when using IRayTraceNSCData, the NSCRayTraceOptions (e.g. in the AddRay function) are limited to...

ZOS-API

Perform Image Simulation in ZOS-API

Please do me a favor. Zemax has the function "Image Simulation". I can do this interactively. Now, I want to use "Image Simulation" to simulate 2000 frame images. Therefore, I want to use SampZOS-API Matlab programming to automatically do it. I have learned the code ZOS-API\Sample Code\MATLAB\MATLA...

ZOS-API

ZOS-API non-sequential object not behaving the way I want it to

Hi guys I have a very simple POB object which is just a wedge, and I’m trying to see how the angle between the internal and external reflective surfaces change with tilt angle rotation around x. I can do this fine in OpticsStudio, by altering the TiltAroundX in the non-sequential component editor. S...

ZOS-API

Converting sequential surfaces to non-sequential objects: ZPL command

All,What is the ZPL command to execute the ‘Convert to NSC Group’ function available via the GUI? I want to convert and save many (Monte Carlo) files in a loop.

ZPL

Run python code from macro and get output variables to OS macro

Hi, I would like to run a python script from a macro (could be a python executable), then get some of the outputed values in the macro. Then I would like to write this values in a merit function from the macro. Is there a simple way to do it or some starting code? Thanks, Jose

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

ZOS-API

Saving detector series data / img with ZPL

Hi all,I want to save data and images of detectors automatically with ZPL. So I made the ZPL code as below. For n = 2, 6, 1 ####### get Detector viewer in img. winnum = n+1 OpenAnalysisWindow "Dvr", cfgpath$ ExportJPG winnum, imgfile$ ####### get Detector viewer in dat. #Modif...

ZPL

EFNO gives different result to that calclated in relative illumination analysis

Hello,I have a system with a non-circular aperture and therefore try to calculate its effective f number using the operand EFNO(effective f number). However, I get different results when using the operand EFNO, in comparison to the result given in the relative illumination analysis, despite the same...

ZPL

retrieving pop beam via ZOS_API Python

Hi, I try to retrieve the output POP field distrubution via python. I looked in the help at IAS_PhysicalOpticsPropagation and couldn't find direct way to do it. I know I can manually save ZBF files and then load, but I need a script as I change parameters and want to retrieve the output bea...

ZOS-API

Saving POP text file in ZOS-API while tolerancing

Hi, What is the correct way to save the whole .txt file in the POP Analysis?I am using and UDOC running a Csharp UserOperandApplication containing the following code:...POPDef.ApplyAndWaitForCompletion(); POPDef.ToFile("C:/Users/file.txt");…some calculations... It w...

ZOS-API

Diffractive macro DOESAG.zpl is not available

Hi,I am unable to find DOESAG.zpl macro for getting the sag values for the diffractive aspheric surface. Earlier it was available in the knowledge base but now that is also not there. Can I get this macro as it is very useful to view the steps of diffractive surface and surface sag dataRegardsJ Hima...

ZPL

More than 12 wavelengths in TraceNSCData

I am gaining a lot of functionality from using direct NSC raytraces via the ZOSAPI from python. However, this method appears to be limited to only the 12 available system wavelengths.The limiting interface seems to be ZOSAPI.Tools.RayTrace.IRayTraceNSCData, which takes a wavelength index (referring...

ZOS-API

Export from Zemax as a STP file

Does anyone share the Zos-api code for export Zemax file to STEP file?

ZOS-API

Sample code to modify certain parameters in the settings of an analysis window through ZPL

We can use the below code to close the current analysis result and analyze the new filed. The setting file must be created by clicking the Save button.Stngs$="C:\Users\yuan.chen\Documents\Zemax\Configs\TFM.CFG"CLOSEWINDOW WINL()MODIFYSETTINGS Stngs$,TFM_FIELD,3,"TFM"Openanalysiswindow "tfm",Stngs$

ZPL

How to read field data using ZPL Macro

For data that require only one parameter, we can use SYPR(). To extract field data, the solution is to use the numeric functions and a loop to extract data. Here are related numeric functions.To read the number of fields or the maximum value, you can use the below funcions to read them:

ZPL

Accessing Geometric Image Analysis Results Using Python

The results of a Geometric Image Analysis may be accessed using: gia = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.GeometricImageAnalysis) gia_setting = gia.GetSettings() gia.ApplyAndWaitForCompletion() gia_results = gia.GetResults() gia.ApplyAndWaitForCompletion() gia_data = zos.Do...

ZOS-API

How to run macro via ZOSAPI

There is no direct way to run a macro via ZOSAPI. A workaround of this is to create a ZPLM macro and call this from the merit function. You can find more about ZPLM in this article:Optimization using a ZPL Macro: the ZPLM operand https://support.zemax.com/hc/en-us/articles/1500005490881-Optimization...

ZOS-API

Run a Macro from ZOSAPI

Hi! Is there a way to run a macro from ZOS-API? I have a macro that does some calculation on the currently opened Zemax model and outputs some data. In a Python script I want to make some modifications to the Zemax model using the ZOS-API and then run my macro. Is that possible? Best, Erik

ZOS-API

How to pass more parameters to a User-Defined Surface DLL?

A user-defined surface DLL will retrieve information from OpticStudio via the FIXED_DATA5 structure defined in the header file. An example of the header file can be found under '\Zemax\DLL\Surfaces\usersurf.h'. To access the surface parameters, the DLL reads the variable param...

DLLs

gaussian beam in non sequential mode

I need to simulate a gaussian beam in non sequential mode, which has 850 nm wavelength, 15 degree diveregence angle (half angle) and the beam raduis of 2.563 mm at 10 mm which has the cross section of the beam profile shape as attached below, but when putting this values using the Gau...

DLLs

Some RCWA DLLs cannot be found in OpticStudio 21.2.1

Hi, I was reading Michael Cheng's article 'OpticStudio grating tools beta function update history' and have some questions. This article mentioned 'download link' many times, but I did not see these corresponding links. And I did not see some DLLs mentioned in this article in OpticStudio 21.2.1, for...

DLLs

Quick access to peak to valley value in analysis-interferogram

Hi, I am trying to calculate peak to valley value showing on 'analysis-interferogram' window by ZPL, and use it in the merit function editor with ZPLM operand. But I have no idea how to directly get the peak to valley value using any kinds of pre-defind functions or else, so currently...

ZPL

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

ZOS-API

Page 1 / 9

Sign up

Already have an account? Login

Redirecting to the Zemax Community...

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

Username or e-mail

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.

Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

Accept cookies Cookie settings

Cookie settings

We use 3 different kinds of cookies. You can choose which cookies you want to accept. We need basic cookies to make this site work, therefore these are the minimum you can select. Learn more about our cookies.

Basic
Functional

Normal
Functional + analytics

Complete
Functional + analytics + social media + embedded videos

Accept cookies