Skip to main content

Code Exchange

Find and share ways to extend the capabilities of OpticStudio.

  • 88 Topics
  • 200 Replies
88 Topics
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: CppLocation: \Documents\Zemax\DLL\Surfaces\ [MOD: added the folder location for the DLL]   Click here to download Date Version OpticStudio Version Comment 2018/01/06 1.0 - Creation

15969
Cybernet
1 year 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

2176
David.Nguyen
Luminary
2 years 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

103812
Lenror Li
2 years ago
Allen.Cheng
Allen.ChengSingle Emitter
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.

1310
Allen.Cheng
2 years ago
S
Luminary
Sandrine AuriolLuminary
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  

2750
S
Luminary
2 years 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

2110
E
Zemax Staff
2 years ago
David
Luminary
DavidLuminary
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”

1353
David
Luminary
2 years ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange
DLL (Diffractive): How to simulate for Grid Wire Polarizer

In this post, it’s introduced how to simulate realistic grid wire polarizer with RCWA function that comes with OpticStudio 20.2.(Source: https://www.thorlabs.com/newgrouppage9.cfm?objectgroup_id=5510) Note there are many different types of polarizerFor polarizer based on birefringent crystal, check the following article: How to design birefringent polarizers For polarizer based on coating, there is no an article specific to introduction, but users can refer to the following article to know how to set up a coating and assign to object for beam splitting: How to model a dichroic beam splitter Then it’s also worth to note the existence of a build-in ideal coating “PASS_P”. This coating allows P polarization to pass and reflect light with S polarization. Note the coating method can only work for obliquely incident beam. Usually this kind of polarizer is made as a cube or a plate oblique placed in the system. More information can be found in this forum post: 'Pass_P' coating fail for the mo

12801
Michael Cheng
Zemax Staff
2 years 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  

2641
S
Luminary
2 years 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

9092
J
2 years ago
David.Nguyen
Luminary
David.NguyenLuminary
posted in Code Exchange
DLL (User-Defined Surface): Sequential Immersion objective lens model

Dear OpticStudio users, In the context of my research at the MRC - Laboratory of Molecular Biology, I am tolerencing a custom light-sheet microscope, which uses commercial immersion objective lenses. When tolerancing an optical system, which uses non-immersion objective lenses, I would often assume that this element can be replaced with a paraxial lens in a first approximation. However, when it comes to immersion objective lenses, this assumption breaks Abbe's sine condition [1]. Consequently, it is usually not possible to satisfy the specifications, namely focal length, back-aperture diameter, and numerical aperture, of an immersion objective lens with a single paraxial lens. A direct solution to this problem involves patent search, and cumbersome reverse engineering to try and get your hands on the actual design of the commercial immersion objective lens. However, this is time-consuming, and requires a different kind of expertise. To address this issue, Hwang and L

7586
S
Luminary
2 years ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange
ZPL Macro: Create a GGD (Grid Gradient) file

This macro will generate a GGD file based on user-defined formula. Before running this macro, define the ranges in xyz directions that you want to generate index data. And also define the number of points in each directions. The more the points are defined, the more accurate the interpolation can be, but the slow the simulation is. The index formula is defined in the sub routine "cal_index.". By default, this macro generates an index distribution that is Gaussian in XY-plane and linear changed in Z direction.   Click here to download Date Version OpticStudio Version Comment 2018-03-05 1.0 - Creation

3350
Michael Cheng
Zemax Staff
2 years ago
David.Nguyen
Luminary
David.NguyenLuminary
posted in Code Exchange
API (CS User Analysis): Sequential Sort Merit Function operands by descending order of contribution

Hi everyone, Inspired by this discussion with @Devorse, I made a User Analysis which sorts the Merit Function operands by descending order of contribution. The source code and executable are attached to this post.In the Double Gauss 28 degree field sample file, with a default Merit Function: Sequential merit function: RMS spot x+y centroid X Wgt = 1.0000 Y Wgt = 1.0000 GQ 4 rings 6 arms The Merit Function Editor looks as below:  And the analysis returns:  InstallationTo install this user analysis, download the attached archive (MeritFunctionContribution.zip) and extract it on your computer. Copy the file MeritFunctionContribution.exe to your {Documents}\Zemax\ZOS-API\User Analysis folder.To run the user analysis, after the step above has been completed, simply press Programming..User Analyses..MeritFunctionContribution.If you need to recompile the source code, please follow the steps outlined in this knowledgebase article.Note 1: there’s little error traping in the code, I’m not sure h

1813
S
Luminary
2 years ago
Allie
Zemax Staff
AllieZemax Staff
posted in Code Exchange
The Code Exchange user group is now closed and merged here

If you were part of the Code Exchange User Group, you may notice that it is no longer available. With our recent updates to the Code Exchange, we determined the group was no longer necessary and closed it. It has been merged with the broader forum category.Now, if you’re looking users’ submissions to the Code Exchange, you can find them all in the Code Exchange forum, regardless of login status. This forum will house a summary of each of the solutions. All users have access to this space. All of the Code Exchange download files have been moved to the Code Exchange Download Center. The download center and the files therein are restricted to supported users only. If you want to submit an item to the Code Exchange, you can do so directly in the forum. Create a topic in the Code Exchange forum using the tag Code Exchange - for review. Be sure to include a ReadMe doc or the submission will not be accepted. Once posted, our team will verify it and work with you to have it officially posted i

820
Allie
Zemax Staff
2 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
API (CS User Analysis): ZBF Viewer

This Zemax User Analysis generates small images of irradiance and phase for each ZBF selected. Then it displays side by side images of irradiance and phase for a quick checkAuthor: @Michael.Humphreys   Click here to download Date Version OpticStudio Version Comment 2022/03/09 1.0 - Creation

1290
S
Luminary
2 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
ZPL Macro: Sequential - Image Simulation Cross Section

This macro reads the text output of the image simulation.  The text output contains the RGB values of the image for each pixel. It then creates a cross section of the image simulation in X or Y for a defined X or Y pixel.In the Image Simulation window, click on Save first before running it.  Click here to download Date Version OpticStudio Version Comment 2021-12-09 1.0 - Creation

2030
S
Luminary
2 years ago
John.Hygelund
Fully Spectral
John.HygelundFully Spectral
asked in Code Exchange
Search all glass across catalogs?

Is there a way to search for a glass across all the catalogs?More broadly, I’d like a Glasscat “database” view where I can view, filter, and combine glasses from all catalogs in an efficient way. Any tips or tricks would be appreciated.Thank you,John

9367
David.Nguyen
Luminary
2 years ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange
Python: Source File - fixing error with zero flux

This Python script will read the binary source file and will try to fix any errors related to zero-flux rays.  Click here to download Date Version OpticStudio Version Comment 2022/01/01 1.0 - Creation

1120
Michael Cheng
Zemax Staff
2 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
DLL (User-Defined Surface): Sequential Gradient2 Tilted

This user-defined surface can be used to model a tilted gradient 2 surface like a cleaved multi-mode fiber. Compared to the gradient 2 surface, this surface contains 2 additional parameters for the tilt.   Click here to download Date Version OpticStudio Version Comment 2021/12/09 1.0 - Creation

1320
S
Luminary
2 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
API (CS User Analysis): Sequential Transmission Plot

This Zemax User Analysis plots the transmission vs wavelength of different configurations and field points of an optical system. The transmission is calculated by sampling a grid of pupil points and then averaging their transmission. The settings may be saved in a configuration file by using the 'Save' button. This analysis comes with the software. The source code can be found under Download.Author: Alastair Humphrey    Click here to download Date Version OpticStudio Version Comment 2020/01/01 1.0 - Creation  

3750
S
Luminary
3 years ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange
DLL (User-Defined Surface): Sequential Binary 1+2

This DLL provides a user defined surface that has planar substrate and a phase profile integrating both radial polynomial and extended polynomial. It can be considered as a combination of surface Binary 1 and Binary 2, but with only planar substrate. This is useful for metalens design.    Click here to download Date Version OpticStudio Version Comment 2020/08/07 1.0 20.2 Creation 2021/01/01 1.1 20.3.2 Fix bug by dividing phase by approaching refractive index

8160
Michael Cheng
Zemax Staff
3 years ago
Allie
Zemax Staff
AllieZemax Staff
posted in Code Exchange
ZPL Macro: Read optimization operand across pupil

DescriptionOutput of the macro with some additional post-processing in ExcelThis macro may be used as a basis for gathering field-by-field ray data in equal steps across the pupil. In this macro, the angle of incidence on a surface is reported but the operand may be changed to any that uses normalized ray coordinates.  LanguageZPLDownload    Click here to download the ZPL version Click here to download the Excel API version Date Version OpticStudio Version Comment 2019/12/10 1.0 19.8 Creation 2020/09/20 1.1 20.2 Updates for OpticsTalk+Envision. Cleaning up the output. Additionally, a reformatted version has been made available which splits the calculation into child/parents macros.  

9451
Julia
Fully Spectral
3 years ago
Allie
Zemax Staff
AllieZemax Staff
posted in Code Exchange
ZPL Macro: Apply Make Thermal tool to Monte Carlo files

DescriptionThis macro allows users to apply the "Make Thermal" tool to already-generated Monte Carlo files. The amount of MC files is hard coded into the code. This will apply five Multi-Configuration operands per surface: CRVT, THIC, SDIA, CHZN, MCSD. MC operands for extra data parameters are not included for all surface types.LanguageZPLDownload    Click here to download Date Version OpticStudio Version Comment 2019/10/15 1.0 19.4SP2 Creation 2020/08/18 2.0 20.2 - Updates to formatting - Addition of option to choose not to clear the MCE before applying the Make Thermal tool - Addition of a loop which will check for the Even Asphere type. This will add parameters to the MCE which correspond to the asphere’s extra data parameters

1930
Allie
Zemax Staff
3 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
API (Matlab Standalone): Sequential Interferogram analysis plot

This MATLAB standalone code imports data from the Interogram analysis feature, plots the Interferogram data as a MATLAB figure and saves it as a png file. This code was written by Michael Humphreys.Language: Matlab  Click here to download Date Version OpticStudio Version Comment 2020/01/14 1.0 19.8 Creation

2450
S
Luminary
3 years ago
S
Steve.BoegeInfrared
posted in Code Exchange
API (Python Interactive Extension): Automatically save TIF images of flux/area for all Detector Rectangles

An Interactive Extension was created that will automatically save flux/area data of all Detector Rectangles to TIF images having double data type. This follows a post from David Nguyen and support feedback from Sandrine Auriol and Alexandra Culler,Script was tested with Samples\Short course\Illumination & Stray Light\Double Gauss for Sun Shield.zos. The images "Double Gauss for Sun Shield, Field 1, D11.tif" and "Double Gauss for Sun Shield, Field 1, D12.tif" were created, then opened using ImageJ.  The images will be uninteresting unless rays are traced before the extension is run.LoopOverAndSaveDDRs(TheSystem) is in a separate file from the Interactive Extension boilerplate so that it could also be used from a Standalone Application, though this has not yet been tested.Language: Python   Click here to download Date Version OpticStudio Version Comment 2021/11/01 1.0 - Creation

1253
S
Luminary
3 years ago

Badge winners

Show all badges
Community Posting GuidelinesCookie settings


Zemax Community

Need more help?

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


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



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