Skip to main content

Code Exchange

Find and share ways to extend the capabilities of OpticStudio.

  • 90 Topics
  • 200 Replies
90 Topics
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

2460
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
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
ZPL Operand: Sequential RMS Spot Radius X Y

 This macro reads the RMS spot X and RMS spot Y as computed in the Standard Spot Diagram and returns it.The argument Hx can be used to give the number of fields.To be able to use it as a ZPLM, change the name to ZPL13.ZPL

4120
S
Luminary
3 years ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange
API (CS User Analysis): Non-Sequential Radiance Camera

 This tool calculate radiance or luminance (brightness) of objects seen by human eyes.Language: CS    Click here to download Date Version OpticStudio Version Comment 2021/05/27 1.0 21.2 Creation 2021/06/03 1.1 21.2 Add function to export text files 2021/06/11 1.2 21.2 Bug fix 2022/04/16 1.3 22.1 Bug fix when showing luminance data 2022/04/19 1.4 22.1 Bug fix. Now the extension file name is no restricted to lower case.

3450
Michael Cheng
Zemax Staff
3 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
API (CS User Extension): Sequential Solid Gaussian Beam Envelope

This Zemax User-Extension displays the envelope of a Gaussian Beam. The Gaussian Beam characteristics are calculated by the Paraxial Gaussian Beam calculator. The extension adds a Non-Sequential Component at the bottom of the sequential editor. A Freeform Z object is added to the Non-Sequential Component Editor. It is formed with the different sizes of the beam calculated by the Paraxial Gaussian BeamLanguage: CS   Click here to download Date Version OpticStudio Version Comment 2020/03/24 1.0 20.1.1 Creation

1660
S
Luminary
3 years ago
Yihua Hsiao
Zemax Staff
Yihua HsiaoZemax Staff
posted in Code Exchange
ZPL Operand: Get the minimum distance between two surfaces with coordinate break

In the optimization process, we usually have to set a suitable space between two lenses to avoid overlapping lenses. However, the current merit function operands don’t support the lenses with coordinate break. A possible solution is to use ZPLM to get the minimum distance between two surfaces with coordinate break.How to use it:The parameter Hx: the surface number of surface  ①.The parameter Hy: the surface number of surface ②.Data=0: Get the minimum distance between two surfaces along the surface ① local z axis.Data=1: Get the maximum distance between two surfaces along the surface ① local z axis. Limitation of this ZPLM:The minimum distance between two surfaces means the distance is along the surface ① local z axis. In the code, the reference of global coordinate surface is temporary set as the surface ①, and then restore to the original setting after calculation. Only the yellow overlapping area in the figure below will be considered, beyond the range will not be considered. In the

6920
Yihua Hsiao
Zemax Staff
3 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
ZPL Operand: Edge Thickness Doublet

This ZPL operand (ZPL30) computes the top and bottom edge thickness of a Doublet at the Semi-Diameter. It also computes the difference. By default, OpticStudio measures the edge thickness at the lens semi-diameter or mechanical semi-diameter.Language: ZPL  Click here to download Date Version OpticStudio Version Comment 2019/01/01 1.0 - Creation  

2590
S
Luminary
3 years ago
Sahil
SahilVisible
posted in Code Exchange
API (Matlab Standalone): Exporting optical components from Layout and shaded model in Matlab Figure

This Matlab code shows the possibility to export optical components by using ZOS-API. In this example Matlab code exporting optical components from Layout of sample file Double Gauss 28 degree field.zmx. The final results exported as 3D figure in Matlab .Limitations: Unable to fetch the rays from the Layout and shaded Model.You will need modify the Line 32 Path : TheSystem.LoadFile('FilePath\OpticStudioFile', false);Language : Matlab   Click here to download Date Version OpticStudio Version Comment 2021/09/03 1.0 - Creation  

2740
Sahil
3 years 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

2570
Allie
Zemax Staff
3 years ago
Julia
Fully Spectral
JuliaFully Spectral
posted in Code Exchange
API (Matlab and Python Standalone): Non-Sequential Pulsed Laser analysis

This Matlab code shows the possibility of simulating a pulsed laser by using ZOS-API. In this example, amplitude of the pulsed laser varied over time, and the irradiance in the detector being recorded. The final results being exported as a video.  Language: Matlab  Click here to download Date Version OpticStudio Version Comment 2021/07/23 1.0 - Creation 2021/08/13     Added a Python script

3021
Sahil
3 years ago
Michael Cheng
Zemax Staff
Michael ChengZemax Staff
posted in Code Exchange
DLL (User-Defined Object): Non-Sequential Polygon grating

 This is a User Defined Object DLL, which allows users defining a polygon plate with 8 x and y points data and thickness. The polygon is linked in order of the points defined in parameters. If a point is set with (0,0), it’s ignored. To consider a point at (0,0), users need to use a smaller but non-zero number, like 1e-8 to replace the 0. All the value of x, y will be multiplied by the parameter “Scale”. If “Scale” is zero, then it’s converted to 1.0 internally. If the parameter “Z Center mode” is 0, then the local origin (0,0,0) is located on Face 1. If “Z Center mode” = 1, the local origin is shifted in z direction by -Thickness/2 so it’s centered between Face 1 and Face 2. If “Z Center mode” = 2, the shift is -Thickness so the local coordinate origin is at face 2. If “Diffract back Face” is non-zero, the grating is on Face 2 instead of Face 1.Language: Cpp   Click here to download Date Version OpticStudio Version Comment 2020/12/04 1.0 20.3.2 Creation 2021/01/13

3430
Michael Cheng
Zemax Staff
3 years ago
S
Luminary
Sandrine AuriolLuminary
posted in Code Exchange
API (CS User Analysis): Sequential Ghost Analysis Summary

This User Analysis runs the Ghost Focus Generator in Double Bounce and sorts the combination of surfaces that contribute to the worst Pupil and Image Ghosts.Language: CS    Click here to download Date Version OpticStudio Version Comment 2019/11/27 1.0 19.8 Creation 2022/03/30 2.0 22.1.2 Change the iteration of surfaces as some combinations where missed. All combinations are now checked and if pupil ghost or image ghost = 0 the data is removed.

4030
S
Luminary
3 years ago
Michael.Humphreys
Zemax Staff
Michael.HumphreysZemax Staff
posted in Code Exchange
ZPL Macro: RayList Gaussian Beam Visualizer

 This ZPL macro generates a file under "\Zemax\Miscellaneous\RAYLIST.TXT" to represent the envelope of a Gaussian beam. There are 3 user inputs: the Waist Size w0, Surf 1 to Waist and the M2 Factor. The macro generates a list of 16 rays based on Paul Colbourne's skew rays: Using skew rays to model Gaussian beams. These rays can be displayed in the 3D layout or Shaded Model by selecting under the settings Pattern...List.Language: ZPL    Click here to download Date Version OpticStudio Version Comment 2021/07/23 2.0 - Added the definable variables as input 2021/04/01 1.0 - Creation

1870
Michael.Humphreys
Zemax Staff
3 years ago
Allie
Zemax Staff
AllieZemax Staff
posted in Code Exchange
ZPL Macro: Sequential Manually add step wise compensation to MC files

This macro applies incremental changes to a compensator in Monte Carlo files, then reports the updated criterion. It will cycle through Monte Carlo files and apply a discretely-valued compensator to a particular surface. Then, the criterion will be analyzed and reported. (Note, the report could use some formatting updates). This code may be used to represent step-wise compensation tools. For example, a mirror's tilt may be applied as a compensator to a change in the system. However, it may be the case that the mirror's housing makes it so that the mirror is only allowed to tilt in increments of 2 degrees. This macro will cycle through the MC files, apply the incremented compensation up to a particular boundary, and will report the result. The changes to each file are NOT saved.Language: ZPL  Click here to download Date Version OpticStudio Version Comment 2020/02/07 1.0 20.1 Creation

2700
Allie
Zemax Staff
3 years ago
David.Nguyen
Luminary
David.NguyenLuminary
posted in Code Exchange
Python: Writing binary source files

Dear OpticStudio users, I have created a GitHub repository with a template Python script to write binary source files: https://github.com/Omnistic/BinarySource_OpticStudio I'm hoping this will make it easier for you to write binary sources for OpticStudio in the future. As a reminder from the help file, binary files are 30% as large as equivalent text files, read about 20x faster, and can be left on disk consuming only little RAM. The repository also includes an example script to generate stigmatic Gaussian beams as described by P. Colbourne in his webinar. By generating a binary source file, one can visualize the propagation of a non-sequential stigmatic Gaussian beam given its waist parameters. Note that the beam needs to intercept the surfaces sequentially, this is a dummy example for visualizaiton only. An OpticStudio archive file is also included for demonstration. This archive contains the Gaussian beam shown in the layout below (x_waist = 1 um, and y_waist = 2 um).

3343
S
Luminary
4 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