Knowledgebase
User Groups

Community
Programming OpticStudio
Code Exchange

Code Exchange

Find and share ways to extend the capabilities of OpticStudio.

37 Topics
20 Replies

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

37 Topics

Recently active

Most replies Most views Newest first

Sandrine AuriolZemax Staff

posted in Code Exchange

New to the Code Exchange? Read this!

The Code Exchange is a moderated community where supported 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 work with you to have it officially posted in the downloads center.

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

David.NguyenEn-Lightened

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

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

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

David.NguyenEn-Lightened

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

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

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

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

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

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

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

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

Sandrine AuriolZemax Staff

posted in Code Exchange

Python Reading Writing Binary Files

The download contains 4 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 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.Authors: @Michael Cheng and @Sandrine Auriol Download

Sandrine AuriolZemax Staff

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

Sandrine AuriolZemax Staff

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 HumphreyDownload

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

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 Download

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

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 linkDownload

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 link:Download

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

Sandrine AuriolZemax Staff

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

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

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

1
2

Page 1 / 2

Badge winners

Paolo.Chioettohas earned the badge OpticsAcademy Certified: OSD
Stavros.Misopouloshas earned the badge OpticsAcademy Certified: ISL
cynthiapadthas earned the badge OpticsAcademy Certified: OSD
Florence.de la Barri�rehas earned the badge OpticsAcademy Certified: Aspheres & Freeforms
Florent.Basinhas earned the badge OpticsAcademy Certified: Aspheres & Freeforms

Show all badges

Powered by inSided

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

Redirecting to the Zemax Community...

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.

OK

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.

OK

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

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