Knowledgebase
Ansys Zemax Support FAQs
User Groups

Community
Programming OpticStudio
Code Exchange

Code Exchange

Find and share ways to extend the capabilities of OpticStudio.

88 Topics
200 Replies

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

88 Topics

Most replies

Most views

Newest first

Sandrine AuriolLuminary

posted in Code Exchange

New to the Code Exchange? Read this!

The Code Exchange is a moderated community where Zemax users can find or share programming solutions to extend OpticStudio’s capabilities. It can be a macro to read the sag of a surface or a DLL to define a phase surface. Browse through our space to find out what we have or share your own!Just a few things before getting started:These solutions are mostly written by optical engineers and not developers. Use them as a starting point and feel free to improve them. Comment on the post if you make an improvement or find something interesting that could be useful to other users! Do you have a solution to share? Create a topic in the Code Exchange category using the tag Code Exchange. Be sure to include a ReadMe doc. An example template is attached. Once posted, our team will verify it and comment if needed.

5770

3 years ago

KrisMonochrome

posted in Code Exchange

Matlab script to group rays from ZRD file to separate paths

This Matlab function imports a raw Zemax ray database stored in ZRD file, groups the rays into distinct paths based on i) the exact same sequence of objects hit and ii) ray events (such as reflection, splitting etc.), and outputs this information in a form of graphs, human-readable variables and, most importantly, a summary table storing each path in descending total power, object sequence, total ray events and so on. It can be further processed either using Matlab's native capabilities, or exported and processed using Excel or a simple text editor.It DOES NOT need Zemax to be installed onto your system and does not use any API to connect to it. It is a completely standalone function.The need for this custom function came clear during one project at work as the native Zemax ray paths tool is simply not sufficient. For instance, ray grouping criteria is not clearly specified, also, the explicit sequence of objects is lost (if a ray enters the lens, is backreflected and leaves the lens t

2893

1 month ago

Michael ChengZemax Staff

published in Code Exchange

Python Reading Writing Binary Files (ZRD, ZBF, DAT, SDF)

The download contains 3 Python scripts:a script to read / parse a ZRD (Zemax Ray Database) file a script to read / parse a Binary ZBF (Zemax Beam File) file a script to read / parse a Binary DAT / SDF Source File Click here to download Date Version OpticStudio Version Comment 2022/01/01 1.0 - Creation

197116

1 month ago

cmanoopckrSingle Emitter

asked in Code Exchange

Obtaining a tight focus of laser beam after a multimode fiber

Hello guys, I have a multimode fiber of 1mm core (1000 um) of 0.22 NA. I will be using this fiber to deliver my laser beam of wavelength either 450 nm or 530 nm. The beam after the fiber will be collimated and then will be refocused. The final goal to have a spot size of 50 - 60 um at the focus. I am beginer in zemax and any help would be appreciated. If any of you had done similar project in the past it would be helpful if you could share the file and i could use it as starting point. Thanks a lot.

622

1 month ago

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

6404

1 month ago

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

5294

2 months ago

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

1054

3 months ago

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

15258

3 months ago

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

250715

3 months ago

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

670

4 months ago

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

5 months ago

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

6 months ago

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

6 months ago

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

7 months ago

Sandrine AuriolLuminary

posted in Code Exchange

API (CS User Analysis): Sequential Through Focus PSF

This Zemax User Analysis calculates a longitudinal PSF, a PSF through focus.Author: @Michael.Humphreys Click here to download Date Version OpticStudio Version Comment 2022/03/09 1.0 - Creation

3251

7 months ago

Michael ChengZemax Staff

published in Code Exchange

Python SPEOS and Zemax Source file converter

That example is a Python script to convert source file between Zemax and SPEOS. To learn more about that converter, check our article: https://support.zemax.com/hc/en-us/articles/4416068530579-SPEOS-and-Zemax-Source-file-converterDownloadFor more information about Ansys optical_automation, click here. TroubleshootingIt’s possible that we get an error message:Non binary files not supported.This happens when the file is not stored in form of ones and zeros, or in some other binary (two-state) sequence.Zemax source fileFor Zemax source file, the extension SDF is recommended, and DAT is supported only for backward compatibility. The file format may be either text or binary. This is mentioned in The Setup Tab > Editors Group (Setup Tab) > Non-sequential Component Editor > Non-sequential Sources > Source File. You can put a detector close to this source file and save the ray tracing data as new source file to convert the non-binary source to a binary one.Speos source fileAs for S

7841

8 months ago

Michael ChengZemax Staff

published in Code Exchange

DLL (Surface Scatter) Non-Sequential Lambertian Depolarizer

This Surface Scatter DLL models a Lambertian scattering and contains a depolarization fraction parameter to depolarize part of the scattered rays. That DLL is a good example to demonstrate how to control the electric field and how to implement importance sampling. The code is based on "{Zemax}\DLL\SurfaceScatter\Lambertian.DLL". Click here to download Date Version OpticStudio Version Comment 2019-01-13 1.0 - Creation

5332

8 months ago

David.NguyenLuminary

posted in Code Exchange

User-defined Operand: Modulo operator

Hi all, I’m not going to create a repository for this, but if you quickly need a modulo operator in your Merit Function, there you have it. Hx and Hy are the operand numbers (integer) that will be used as the numerator and denominator respectively.The relevant part of the code is self-explanatory (hopefully):int numerator = (int)TheApplication.OperandArgument1;int denominator = (int)TheApplication.OperandArgument2;...double numerator_value = TheSystem.MFE.GetOperandAt(numerator).Value;double denominator_value = TheSystem.MFE.GetOperandAt(denominator).Value;operandResults[0] = numerator_value % denominator_value;To install, download the ZIP file, extract it, and move UDOC12.exe to yourDocuments/Zemax/ZOS-API/Operandsfolder. Then, in the MFE you can do:The rest of the division of 5.00 by 2.00 is 1.00.In case you are wondering why I made this. I needed to have a linear polarization without caring about the orientation. I noticed that using CODA with data=110 (phase difference), some linea

1284

9 months ago

AschoSingle Emitter

asked in Code Exchange

LDE - using Tilt/Decenter Pickup this surface

Hi everyone,I would like to change the surface properties with Python ZOS-API.How can I change the follow parameter from “Explicit” to “ Reverse Thhis Surface”?Thanks for help.

1172

10 months ago

sgimenezaSingle Emitter

asked in Code Exchange

Zernike Coefficients for Zemax and Shack-Hartmann Relationship

Hello everyone,I'm a new user of Zemax OpticStudio, and my current focus is on simulating Zernike coefficients to characterize mirrors, specifically focusing on the spherical aberration coefficient Z11. Currently, I'm in the calibration phase, working to establish the correlation between the Zernikes measured with my Shack-Hartmann (SH) sensor and those obtained through simulations in Zemax.In our lab, we are using a Shack-Hartmann Wavefront sensor with 127 microlenses arranged in a hexagonal shape. The mirror under test is a known spherical mirror with a 2-inch diameter and a focal length of 1000 mm. The SH sensor specifications include a pixel size (Deltax=Deltay) of 9.9 um, lenslet focal length of 18 mm, lenslet diameter (pitch) of 300 um, clear aperture of 3.9 mm, and a CCD camera with dimensions 640x480 px, operating at 633 nm.Initially, I simulated a basic setup in Zemax with a collimated laser, circular aperture of 50 mm @ 633 nm, reflecting off the mirror and returning to the S

4111

11 months ago

Daniel P. CaleroMonochrome

asked in Code Exchange

Optimization ranges using CPAR and COMP

Hi,I am working on a tolerance script that uses different surface optimizations (thickness as well as tilts) on its components.I am using the CPAR and COMP commands, but there is a constraint in the maximal optimization range. Is there a way to set this range in the script? I can try to use the merit function to set the limits, but seems too convoluted.

1352

11 months ago

Alex.TripsasVisible

posted in Code Exchange

Python Class to open .ZBF file

Hi all,A while back I was on these forums looking for a way to open a .ZBF file using Python and there seemed to be some interest in that from others. I’ve attached my file that handles opening a .ZBF file either by inputting a file name (with path) or leaving it blank to call a GUI with an explorer to select a file. From there it will read the binary file and output all relevant information including the E field values, both real and imaginary for x and y (if polarized). This started off using Michael Chen’s post Python Reading Writing Binary Files (ZRD, ZBF, DAT, SDF) and then using a chunk of code from the old PyZDDE module to see how to read the E-Field values. I optimized reading the files down to a 2048x2048 image takes about 1.5 seconds to open. Sadly I think the rest is a limitation of python. Within the class there are functions to get irradiance, power, total power, and peak irradiance. I’ve also added a x,y decenter value to handle decentering the image (in lens units,

2430

11 months ago

ianpondAnsys Staff

posted in Code Exchange

Python: Data Exchange from Thermal Desktop to OpticStudio

Author: Ian Pond (Ansys Thermal Desktop Application Engineer)Attached you will find a short pptx describing the workflow for exporting temperature data from a Thermal Desktop thermal model of optic components for use in OpticStudio. OpticStudio requires tab delimited data for temperature import data, which includes X,Y,Z, and Temp data. The built-in Thermal Desktop tool exports a small amount of extra information, which isn’t needed by OS. The included python script can be run from the command line to convert the default output files to the proper format for OpticStudio (please open the file with a text editor first and see the comments for usage).Please feel free to reach out here or to our Thermal Desktop Support email (crtech.support@ansys.com). Date Version Optic Studio Version Comment 12/22/2023 1.0 - Creation

1980

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

9675

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

2445

1 year ago

Page 1 / 4

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

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