Knowledgebase
User Groups

Community
Programming OpticStudio
Code Exchange

Code Exchange

Find and share ways to extend the capabilities of OpticStudio.

46 Topics
60 Replies

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

46 Topics

Recently active

Most replies Most views Newest first

Sandrine AuriolZemax Staff

posted in Code Exchange

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

811

13 days ago

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

300

15 days ago

Jeff.WildeEn-Lightened

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

17 days 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 FileDownload

1919

1 month ago

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: CppDownload

1 month ago

Sandrine AuriolZemax 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 ChengDownload

1 month ago

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”

1 month ago

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

2 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".Download

1030

3 months ago

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

2402

3 months ago

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

4 months ago

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

4 months ago

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

4 months ago

yuan.chenZemax Staff

posted in Code Exchange

ZPL Macro：Fit CAD surface as a sequential surface

This ZPL fits a CAD surface to a sequential surface by extracting the coordinates and generating a merit function that contains the coordinates as target. This macro is compatible witha tilted surface.Download

5 months ago

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

5 months ago

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

5 months ago

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

6 months ago

yuan.chenZemax Staff

posted in Code Exchange

DLL: Paraxial Lens DLL for Non-Sequential Mode

This diffractive DLL make the face behave like a Paraxial Lens which can correctly consider phase.Note the Paraxial Lens correctly gives phase information only when the object/image distances are correctly given. Therefore, the parameter “Image Position” should be explicitly given. If the image is formed at infinity, the parameter “Image Position” is set to 0. For the other conjugations, the image position is the distance between the image plane and the diffractive object along the local axis.There are a few limitations when using this diffractive DLL.(1) The ray must be from -z side and propagate to +z side.(2) Only the transmit rays are considered, the reflect related parameters can be set the same way as the included sample files.(3) Only order 0 are considered.(4) Refractive index at two sides must be AIR (n=1.0).To obtain the same layout, please check the ‘Split NSC Rays’ option in NSC 3D Layout.Please pay attention to the detector size and the PSF Mode Wavenumber when you change

6 months ago

Sandrine AuriolZemax Staff

posted in Code Exchange

API (CS User Analysis): Non-Sequential Segment By Segment Path Analysis

This Zemax user analysis performs a path-analysis on an input ZRD file. The specified ZRD file will be read, and the ray paths sorted by total power in each path. This ray path analysis includes the hit-face data, meaning a ray which ghosts within a single object will be differentiated with the ray path which doesn’t ghost. This makes the analysis more robust than the native Path Analysis feature, but produces a more complex data output. As it is also slower than the native Path Analysis feature, it is recommended for use only when this level of detail is required in path analysis data. Some options are included to limit the depth of analysis to improve speed.Author: @Zach Derocher Download

6 months ago

Sandrine AuriolZemax Staff

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 Download

6 months ago

Sandrine AuriolZemax Staff

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 Download

6 months ago

Sandrine AuriolZemax Staff

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

6 months ago

Page 1 / 2

Badge winners

lenorehas earned the badge Allow me to introduce myself
Michael Chenghas earned the badge Visibly Un-Polarized
achatte01has earned the badge Allow me to introduce myself
Ryosuke.Niitsuhas earned the badge Allow me to introduce myself
jp7745has earned the badge Allow me to introduce myself

Show all badges

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

Redirecting to the Zemax Community...

Enter your username or e-mail address. We'll send you an e-mail with instructions to reset your password.

Username or e-mail

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.

Company

About Zemax
Team
Events
Careers
Contact Us

Products

OpticStudio
OpticsBuilder
OpticsViewer

Zemax Community

Manage email notification
Private Message Inbox
My Subscriptions
Posting guidelines

Need more help?

Knowledgebase
OpticsAcademy
Software Downloads
Consultants
Open a Case