Skip to main content

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.

673 Topics

Recently active

Most replies Most views Newest first

Michael ChengZemax Staff

published in Code Exchange

DLL (User-Defined Surface): Sequential Vortex Phase Plate

This DLL models a Vortex Phase Plate. It is useful in laser applications to convert a Gaussian laser beam into a donut-shaped energy ring. For more information, check the following links:https://www.holoor.co.il/wp-content/uploads/2017/11/vortex_zemax_tutorial.pdfhttps://www.holoor.co.il/application/optical-vortex-phase-plate-application-notes/https://www.holoor.co.il/optical-calculator/vortex-lenses/ The Vortex phase plate is a phase surface: Click here to download Date Version OpticStudio Version Comment 2021/03/20 1.0 - Creation

bgdi10262Single Emitter

How to use ZBFTILT?

Hi Everyone,I would like to ask how to use zbftilt? The help document reads a bit confusing: This keyword requires the name of the ZBF file and four numbers. The phase of the beam is modified by a phase angle given by θ = ( x – cx )tx + ( y – cy )ty . The cx and cy values are the center of the phase tilt, and tx and ty are the slopes of the tilt in units of radians per lens unit length. The coordinates x and y refer to positions within the beam file, with the center coordinate (x = 0, y = 0) being at the point (nx/2 + 1, ny/2 + 1) where nx and ny are the number of points in the x and y directions. The length units in the ZBF file are converted automatically to the current lens units. The resulting data is written back to the same file name. If I want to rotate an elliptical beam mode by 90°, how should I write it?Thanks!Di

joachimMonochrome

Update values from custom object DLL

I have created a custom object based on the sample of the HalfCylinder.DLL object. So far, this works. I would like to return a value directly to the non-sequential component editor. E.g. for the half cylinder, add a field volume and return the current volume. This way during optimization, I can control the volume of the cylinder without using extra scripts to use the volume. I tried to use an extra field, and then attribute a value inside the code:in the given half cylinder, in line 64 (just before the switch(code)):data[104] = volume;but the volume field in zemax’ non-sequential component editor is not updated.I hope to get along the idea of I want to do. For the volume, I could use a script in zemax, but imagine it is value that I calculate in cpp anyway, it would be more efficient to reuse this. Is this possible?

Michael ChengZemax Staff

Simulate 2D diffraction grating using customized diffractive DLL

In OpticStudio, currently we only support one dimensional grating. However, it's not difficult to simulate 2D grating. Here we will show an example using diffractive DLL.You may compile it with the instructions or use the DLL file attached to this article. Before we start, here are some articles for required background knowledge that we will not repeat in this forum post. How diffractive surfaces are modeled in OpticStudio (KBA) How diffraction ray-tracing is calculated | Zemax Community(forum post) Custom DLLs in OpticStudio: An overview of user-defined surfaces, objects, and other DLL types (KBA) How to compile a User-Defined DLL (KBA) Let's simply open the attached cpp file and observe how it works in non-sequential mode.This example is mainly modified from the built-in sample \Documents\Zemax\DLL\Diffractive\diff_samp_1.c To compile the program as C++ code. We package the functions with extern 'C'. In this example, we only want to return diffraction ray direction and its rel

MichaelHLuminary

published in Code Exchange

ZPL Macro: Create automatically annotations on a 3D layout to display distances between optics

The attached ZPL will calculate the air space gaps between all elements and then will place the annotation text on the Windows clipboard. After you run the script, simply open the Edit Annotation window, paste the text and click the Use Annotations checkbox: For the Double Gauss 28 degree field.zmx, the 3D Layout will look like:and for the Cooke 40 degree field.zmx: Limitations:You have to use the 3D Layout and not the 2d Layout. The 3D Layout uses global coordinates for annotations while the Layout uses “window” units, meaning the values for LINE and TEXT would change based on the current zoom position. For complete control, you should use LINE3D and TEXT3D (this would allow you to place things like Comment, Radius, or Material on the plot as well. For this simple example of air spaces, we will use MEASURE3D which is slightly easier to implement. Since we're only looking at air spaces, you need to consider when you “enter” a cemented element (doublet, triplet, etc) and when you “ex

nadav.amitaiFully Spectral

float to integer

Hi, Is there a way to change variable from float to integer?I want to use it to write list of polygons in loop:for i:n:polygon_name 1.pobpolygon_name 2.pobpolygon_name 3.pob….In other words, i dont want something like that: Thanks,Nadav…..

Aleksandr.MakarovUltraviolet

asked in ZOS-API

single IMAE operand

can I calculate and get operand IMAE without adding it to MF with python api?IMAE work as geometric image analysis? what if I need “geometric bitmap image analysis”?they have different settings and from it different efficiency values.

joachimMonochrome

asked in ZOS-API

Python ZOS-API, example not working out of the box since Ansys

The example script for the interactive mode in Ansys Zemax OpticStudio 2024 R1.03 does not work out of the box. It manages to find the path of the ZOSAPI_NetHelper.dll from the windows registry (path is to C:/Users/username….) but it says:Exception: Cannot find OpticStudioI don't know why this automatic path is not found, if I put manually the path inside the script (line 24):pathToInstall = r'C:\Program Files\Ansys Zemax OpticStudio 2024 R1.03'It works! Not sure if it is related that I used Zemax before it was acquired by Ansys and it is looking in the wrong location.Just for those who'd like to use the zospy library, you can also pass the path directly:import zospy as zpopticstudio_directory = r'C:\Program Files\Ansys Zemax OpticStudio 2024 R1.03'zos = zp.ZOS(opticstudio_directory=opticstudio_directory)oss = zos.connect("extension")Perhaps it helps others to save some time.

KarthickSingle Emitter

asked in Code Exchange

FFT Through Focus MTF

Hi I am working on to create a multifocal IOL. I don’t know how much add power is in the FFT through focus MTF. It shows the focus shift. how to convert t the focus shift into diopters or is there any option in the zemax for conversion. Regards,C.Karthick

MunseokMonochrome

Can't load DLL in ZEMAX OpticStudio 2024 V1

I have used User-defined DLL (Source DLL) by myself with compiling CPP to DLL. It is working well in 2023 R2 but it can’t be loaded in 2024 R1. Is there some difference in loading DLL? Please let me know if there is someone who has experience. Thank you. Best Regards,Munseok

ellenlee619Single Emitter

Best way to share parameters between two user-defined surfaces?

I’m working on a pair of DLL files. The sag of the second DLL depends on the parameters of the first DLL, plus a few other parameters. What’s the best way to share information between these two user-defined surfaces? Do I need to add pickups for every parameter (manually or via script)? Or is there some way to pass the entire 1st surface as a parameter/argument to the 2nd surface?

Masato.AketagawaSingle Emitter

ZPL Improvements

The program in the following file assigns random values to the specified Zernike terms. This ZPL works in non-sequential mode but not in sequential mode.Where do I need to modify it to make it work in sequential mode?Lens data is attached in another file.

Michael.YoungVisible

STDD() Typo in the help (references SRPO() instead of SPRO())

There is minor typo in the current help file for Zemax OpticStudio. I caught it in the PDF for 2024 R1; however, it is present in the online help file from Ansys as well discussing Numeric Functions.In the description of the obselete STDD() tag for ZPL programming, it references SRPO which does not exist. It meant to reference SPRO.Confirmation that SPRO is correct can be found in @Katsumoto Ikeda’s post here.

Csilla Timar-FulepZemax Staff

posted in Code Exchange

DLL (User-Defined Surface): Relief-Type Diffractive Surface

This User-Defined Surface DLL provides a realistic model of relief-type diffractive lenses based on zone-decomposition. Using zone-decomposition, diffraction into multiple orders can be accurately considered at once, and this method inherently accounts for wavelength dispersion and diffraction efficiency by modelling the actual shape of the diffractive element.Application examples include the creation of advanced intraocular lens models, where the different orders are designed to provide sharp vision for multiple viewing distances, thereby substituting accommodation of the natural crystalline lens.This application is discussed in detail in the following knowledgebase article:Realistic modeling of relief-type diffractive intraocular lenses using User-Defined Surface DLLs – Knowledgebase (zemax.com) Click here to download Date Version OpticStudio Version Comment 2022/07/15 1.0 - Creation

Sandrine AuriolLuminary

posted in Code Exchange

DLL (Source): Non-sequential Astigmatic Gaussian

This Source DLL models an Astigmatic Gaussian Source. It is based on rays but the statistical distribution of rays gives a picture of a diffracting Gaussian beam. It is valid for small angles (paraxial approximation) and when propagating in free space. So clipping at apertures and aberrations will give incorrect results.w0x, w0y are the real beam waist radii (defined at the 1/e2 intensity point) in the XZ and YZ planes. They includes M^2. z0x, z0y are the positions of the beam waist in the XZ and YZ planes. z0<0: in propagation direction if the waist is located before source. M^2x, M^2y are the quality factors in the XZ and YZ planes.For more information, see "Representation of a Gaussian beam by rays" by P. P. Crooker, W. B. Colson, and J. Blau - Physics Department, Naval Postgraduate School, Monterey, California 93943Authors:Steffen Erhard and @Dirk Broemme Click here to download Date Version OpticStudio Version Comment 2020/05/06 1.0 21.1.2 Creation 2023/0

Mikayel.MusheghyanMonochrome

posted in ZOS-API

ZOS-API Python IntelliSense

Hello Everyone! During the discussions with the Zemax staff, we came across something that might be useful for everyone. This has to do with working in Python with the ZOS-API. As it is generally known, Python does not have IntelliSense in the same sense as Matlab does. The standard workaround (https://my.zemax.com/en-US/Knowledge-Base/kb-article/?ka=KA-01620 ) has been inserting break points and debugging your code to see the functions and the properties. Below is a different way that can enhance the working speed in Python. However, I should note the following. At the moment of writing this, the method works only with Python 3.8 (Tested on Python 3.8.1). The precise reason for why it doesn’t work in, say 3.7, is not clear to me, but maybe Zemax staff can provide some feedback on this? Anyway, in order to get the method to work, I required the following. As an IDE - the Visual Studio Code from Microsoft: https://code.visualstudio.com/ . Tutorial on getting started with Python

Michael.YoungVisible

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.

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

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?

chrisInfrared

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.

Yuqiang.DingSingle Emitter

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

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?

Hans-Jürgen FeigeInfrared

asked in ZOS-API

What is the ZOS-API-solution of ZPL-RAYTRACE

So far I haven't found a way to calculate many rays through to the image surface and read out the ray data on each surface.In ZPL, the "RAYTRACE hx, hy, px, py, wavelength" provides ray data on all surfaces (RAY*(surface)).Have I overlooked a solution using ZOS API?Many Thanks!Hans

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.

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

1
2
3
4
...
27

Page 1 / 27

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

Powered by Gainsight

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

Login to the Zemax Community.

Login to the Zemax Community.

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.

OK

This file cannot be downloaded

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

OK