Code Exchange

Find and share ways to extend the capabilities of OpticStudio.

  • 57 Topics
  • 102 Replies

57 Topics

Sandrine Auriol
Zemax Staff
Sandrine AuriolZemax Staff
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 - for review. Be sure to include a ReadMe doc or the submission will not be accepted. An example template is attached. Once posted, our team will verify it and will update the tag. 

0
Sandrine Auriol
Zemax Staff
1 year ago
J
James.GoodSingle Emitter
posted in Code Exchange

Diffraction grating Littrow angle solve

 Just a very simple ZPL solve to set the incident angle of a transmissive diffraction grating to the Littrow angle for order m = -1. #Define pipi = 2*ACOS(0)x = SOSO(0) #get preceeding coord break surface numberL = WAVL(PWAV()) #get primary wavelengthG = PARM(1,x+1) #return Lines/um from grating (pg 319)Litt = asin(L*G/2)*180/pi #Calculate Littrow anglesolvereturn Litt Just thought I’d share it to potentially save others a little time.It could be expanded for additional orders.

1
Sandrine Auriol
Zemax Staff
2 days ago
Sandrine Auriol
Zemax Staff
Sandrine AuriolZemax Staff
posted in Code Exchange

Python Zemax to SPEOS coating converter: version in progress

This example is a Python script to convert Zemax coatings to Speos coatings. The script is available here. It is not yet in the main branch as we are still running some tests but do feel free to use it and leave a comment.https://github.com/ansys/optical-automation/blob/Converter_Coating_Zemax_to_Speos/ansys_optical_automation/application/example_convert_coating_zemax_to_speos.pyThe user inputs are: For each coating + substrate, the software will create a Speos coating. The script is using the Transmission vs Angle analysis from OpticStudio. For more information about Ansys optical_automation, click here.

0
Sandrine Auriol
Zemax Staff
13 days ago
Sandrine Auriol
Zemax Staff
Sandrine AuriolZemax Staff
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

13
Sandrine Auriol
Zemax Staff
14 days ago
Allie
Zemax Staff
AllieZemax Staff
posted in Code Exchange

ZPL Operand: Optimize without vignetting TMA systems

Some time ago, one of our engineers used the ZPL to create a ZPLM for analyzing TMA systems. A ReadMe doc and example file are attached below. Here is a summary of how the ZPLM works:The ZPL actually checks that a surface does not vignette a ray in sequential mode. In sequential mode, a ray only knows about the next (n+1) surface that it's travelling to...the ray doesn't know about previous surfaces or surfaces beyond the next surface. Therefore, you can have surfaces other than n+1 which can clip the ray in real life but SEQ won't detect that.  The macro traces a specific marginal ray (±x or ±y) and targets the Mechanical Semi-Diameter of a specific surface. The ZPLM then forces a minimum clearance distance between between the edge of the mirror and the specified marginal ray.   Note: The ZPLM has been written with circular apertures in mind. For systems with other aperture types, the code will need to be updated. Additional note: This macro has not been rigorously tested, which is wh

0
Allie
Zemax Staff
17 days ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange

DLL (User-Defined Surface): Sequential Hexagonal and Staggered Lens Array

These two User-defined surfaces DLL creates an array of hexagonal arranged lenses and an array of staggered lenses. The code is based on us_array.c.us_array_hex.dll has 4 parameters: the number of lenses in X and Y direction and the width and height of each lens.us_array_staggered.dll has 3 parameters: the number of lenses in X and Y direction and the width of the lens.Language: Cpp   Click here to download Date Version OpticStudio Version Comment 2018/01/06 1.0 - Creation

9
Cybernet
29 days ago
yuan.chen
Zemax Staff
yuan.chenZemax Staff
published in Code Exchange

Ansys open project on GitHub

We have created a public repository called https://github.com/ansys/optical-automation. We are hoping to gradually move our solutions to this Ansys open project on GitHub.How to use Ansys optical-automationAnsys optical-automation comes with a documentation: https://ansys.github.io/optical-automation/This section shows how to clone the GitHub repository and run the code in Visual Studio. Note the Visual Studio is not absolutely required. Users can use their preferred tool to sync the GIT repository and preferred IDE tool to run the Python project. Here we simply use Visual Studio as an example. Visual Studio installationUsers can download and install the latest Visual Studio in the following link: https://visualstudio.microsoft.com/vs/community/During the installation, the Python development must be selected as below.GitHub repository configurationAfter the installation, we can launch the Visual Studio and click Clone a repository.Copy and paste the link below to the Repository locatio

1941
yuan.chen
Zemax Staff
1 month ago
David.Nguyen
Luminary
David.NguyenLuminary
posted in Code Exchange

User-operand for refarctive index in non-sequential mode

Hello everyone, EDIT: I was wrong, NPRO’s last parameter is actually the wave number as pointed out by @MichaelH below. Therefore, there’s no need to use a user-defined operandEDIT: new version available in my last reply below! I have made a user operand equivalent to INDX for non-sequential systems.In non-sequential systems, INDX doesn’t work, and one workaround is to use a ZPL operand with the numeric function NPRO using the code 200 (index of refraction of an object). For some time, I used the following code in a ZPLM (I hope the code is self-explanatory but let me know otherwise):object = PVHX()OPTRETURN 0, NPRO(1, object, 200, 0)However, if one has multiple wavelengths defined, it always seem to default to the first one (wave number: 1), and there’s no direct possibility to specify a wavelength in NPRO, whereas this is possible with INDX.A work around is to use the Multi-Configuration Editor with the operand WAVE and a single wavelength defined in the System Explorer. That way, on

6
David.Nguyen
Luminary
1 month ago
Jeff.Wilde
Luminary
Jeff.WildeLuminary
posted in Code Exchange

Ideal Lens DLL (user-defined sequential surface satisfying the Abbe sine law)

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 code is not provided for now, but any and all feedback regarding the DLL functionality would be appreciated.  Changes can be made accordingly.Here is a related link: Regards,Jeff

8
Marie
1 month ago
Allie
Zemax Staff
AllieZemax Staff
posted in Code Exchange

ZPL Operand: Extract FWHM from non-sequential detector

Description: This macro will calculate the approximate FWHM of a near-Normal distribution of data. This macro assumes symmetry about the maximum value and assumes a minimal amount of noise between 0 and the maximum. The macro will update the Detector Viewer settings to a cross-section view. Then, the data will be extracted and evaluated. When using the ZPL10 version of the macro, the approximate FWHM will be reported when Data = 0 for the X-direction, and Data = 1 for the Y-Direction. Use the Hx entry to specify the detector of interest.  Language:ZPLUpdates:10/22/2021 - Stability and calculation updates. The calculation is now more robust. The code for finding the CFG file has been updated. See the ReadMe for more information. Download: Click here to download Date Version OpticStudio Version Comment 2019/10/15 1.0 19.4SP2 Creation 2020/10/14 2.0 20.3 Updated macro with the following - CFG file is programmatically calculated - FWHM index location calcul

12
Lenror Li
1 month ago
Allen.Cheng
Zemax Staff
Allen.ChengZemax Staff
posted in Code Exchange

STAR: Load FEA data with your command line

I put all the scripts and detailed documents in the zip file, “star_load_fea_cli.zip”. The script “main_cli.py” is a command line tool that I use to import the FEA data to the system via the STAR module. The feature is almost the same as the “Load FEA Data” tool in the STAR module. The difference is that this tool cannot help you check whether the FEA data is in the right place. However, it might be able to help you finish some routine work. If the script is not convenient enough to let you finish your work easier and you want to build your own tool, I think you can reference the functions “load_fea_deformation_with_transform” and “load_fea_temperature_with_transform”. I believe that they will give you some help.

0
Allen.Cheng
Zemax Staff
2 months ago
Sandrine Auriol
Zemax Staff
Sandrine AuriolZemax Staff
posted in Code Exchange

Python Converting an image into a ZBF file

This Python converter reads an image file and converts it into a ZBF file. The image is used for the amplitude of the electric fields. The phase of the electric fields is set to zero. Note that the conversion may not work properly for color images depending on the color scheme. Convert your image to a grey scale before the conversion  Click here to download Date Version OpticStudio Version Comment 2022/11/02 1.0 - Creation  

0
Sandrine Auriol
Zemax Staff
2 months ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange

Python fit object face (ex. for CAD)

Attached file shows alternative method to the following code.ZPL Macro：Fit CAD surface as a sequential surface It uses ZOS-API with Python. The benefit is we will generate the fitting system automatically. A document is provided to show a simple example about how to use it.

1
yuan.chen
Zemax Staff
3 months ago
Michael Cheng
Zemax Staff
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

1830
Michael Cheng
Zemax Staff
3 months ago
Csilla Timar-Fulep
En-Lightened
Csilla Timar-FulepEn-Lightened
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  

7
Csilla Timar-Fulep
En-Lightened
3 months ago
MichaelH
En-Lightened
MichaelHEn-Lightened
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

1721
A
4 months ago
E
Zemax Staff
Erin.ElliottZemax Staff
published in Code Exchange

Mathematica Read Write ZBF Files For POP

This Mathematica code reads and writes binary .ZBF files, for use in Physical Optics Propagation (POP).  We generate data for a Gaussian beam, write the data to a .ZBF file, and read the .ZBF file back in.  Users can use this code to create their own beams to launch in POP.  Users may also modify this code if they have beam data that they've measured in the lab, and want to launch the measured beam in POP.  For more details, see the ReadWriteZBFs_12.PDF file included in the .ZIP file at the link below.Functions contained in the .nb file include:  beaminfotable - Displays a table of important values for defining a Guassian beam. generategaussiandata - Creates beam data for a Guassian beam. WriteZBF - Writes a binary ZBF file. ReadZBF - Reads a binary ZBF file. findamplitueandphase - Converts the real and imaginary arrays in the ZBF file into amplitude and phase.  Click here to download Date Version OpticStudio Version Comment 2019/11/13 1.0 - Creation

740
E
Zemax Staff
4 months ago
Michael Cheng
Zemax Staff
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

4429
Jimmy Zheng
5 months ago
Michael Cheng
Zemax Staff
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   

2
Michael Cheng
Zemax Staff
5 months ago
David
En-Lightened
DavidEn-Lightened
posted in Code Exchange

An introduction to interfacing to OpticStudio from Mathematica 1_1

Attached please find several files in a zip folder. The primary file is a Mathematica notebook initially intended as a knowledge base article.  It could also be a post in the Code Exchange forum. I have included a draft readme file in case you feel that is the best use. If you think it’s worth sharing, please use it as you think best.Please feel free to request edits.The files in the folder are:   The notebook: “An introduction to interfacing to OpticStudio from Mathematica 1_1.nb”   A PDF of the same: ” An introduction to interfacing to OpticStudio from Mathematica 1_1.pdf”   The readme draft: “ReadMe.docx”

3
David
En-Lightened
5 months ago
Sven.Stöttinger
Sven.StöttingerInfrared
posted in Code Exchange

API (Python): Removing Pickups and Variables globally for Non-Sequential Files

Hello everyone,I was trying to find a simple way to remove pickups and variables for when I want to integrate a non-sequential system into another file. In the ZOS-API documentation I’ve found only a global removal for variables so far:TheLDE = TheSystem.LDEtools = TheSystem.Toolstools.RemoveAllVariables()Unfortunately, I was not able to find something similar for pickup-solves.So, I’ve written a very small python-file based on the boilerplate code that removes pickups and variables from a nonsequential Zemax-File which I’d like to share to the community. The code only changes the solve types: variables and pickups to fixed solve types to preserve other solve types (for example the solve type “model” for materials). Best regards,Sven  

1
Sandrine Auriol
Zemax Staff
6 months ago
Michael Cheng
Zemax Staff
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  

1460
Michael Cheng
Zemax Staff
7 months ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
published in Code Exchange

ZPL Macro: Plotting real entrance pupil in 3D layout.

For wide angle system, it can be interesting to visualize the position and the size of a real entrance pupil in different field angles. This macro will compute with real ray tracing real entrance pupil information for different field angles. It then adds the entrance pupil as a dummy surface and each “field” entrance pupil is defined into a configuration. The macro assumes axial-symmetric, only y field and the field angle in object is positive. Ray-Aiming should be turned on to correctly run this macro. It may only work with field type Angle and Object Height.How to use:  Just run the macro, and open 3D Layout with showing central field and all configs.  Click here to download Date Version OpticStudio Version Comment 2018-02-26 2.0 - Fixed some issues by calculate the pupil points before adding any config or surface (Michael Cheng) 2018-02-03 1.0 - Creation

2992
J
7 months ago
Sandrine Auriol
Zemax Staff
Sandrine AuriolZemax Staff
posted in Code Exchange

Python Converting an image into a Binary BIM Image file

The download contains a Python script a script to write an image (JPG) into a Binary BIM Image file. The PNG, GIF, TIFF, and BMP should also be supported but haven't been tested.  Click here to download Date Version OpticStudio Version Comment 2022/01/01 1.0 - Creation  

4
Sandrine Auriol
Zemax Staff
8 months ago
Sandrine Auriol
Zemax Staff
Sandrine AuriolZemax Staff
posted in Code Exchange

API (CS User Extension): Fiber Laser Calculator

This Zemax User-Extension helps set-up or check a system with fibers or lasers in OpticStudio. There are two tabs: one to set-up correctly the System Explorer given the fiber values and a second tab to check that a system has been set-up correctly. Values are also given for POP.  Click here to download Date Version OpticStudio Version Comment 2020-05-13 1.0 - Creation  

0
Sandrine Auriol
Zemax Staff
8 months ago

Badge winners

Show all badges
Community Posting GuidelinesCookie settings


Company

Products

Zemax Community

Need more help?



Privacy policy   License Agreements    Terms of service    Cookie Policy   Zemax Account Licensing Policies