Knowledgebase
User Groups

Community
Programming OpticStudio
Code Exchange

Code Exchange

Find and share ways to extend the capabilities of OpticStudio.

69 Topics
129 Replies

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

69 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 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. Be sure to include a ReadMe doc. An example template is attached. Once posted, our team will verify it and comment if needed.

1 year ago

nikitasatcikMonochrome

posted in Code Exchange

Converting CAD data of the TIR lens into the parametric surface for optimization in NSQ mode

It is common for illumination design to have complex shapes which are difficult to describe by a mathematical formula. For example, custom collimators, waveguides, reflectors, and so on could be represented by freeform curves. When such optical components are designed in a CAD program, we can't optimize their shape in Zemax after importing CAD files.To overcome this issue, I provide an example of how to convert CAD data of a TIR lens into a parametric surface and optimize it for light collimation.In this example I’m using TIR lens. It consists of TIR surface and refractive surface, as shown below.Reference: Pencil of RaysFirst, we will fit TIR surface.Zemax has a Freeform Z object, which is formed by drawing a cubic spline curve through a series of points in the YZ plane:Our target is to retrieve these YZ pairs from a solid model cross-section via cubic spline interpolation. Spline interpolation can be done in python using scipy.interpolate.CubicSpline(Z,Y):Cubic Spline InterpolationAf

4 days ago

SahilZemax Staff

posted in Code Exchange

API (Python and MATLAB Interactive Extension) Calculate the Ray Transfer (ABCD) Matrix for thick Lens

To compute the ABCD matrix, OpticStudio traces rays over a very small region centered upon the reference field position. Usually, this is the center of the field of view. OpticStudio allows selection of which field position to use for reference.By default, OpticStudio sets the corner of the field grid in object space to be at the maximum radial field distance. Because object height is linear with the tangent of the field angle, the full width of the field when angles are used to define the field is given byWhere θr is the maximum radial field angle at the corner of the field.The ray coordinates in image space for the very small field of view are used to determine the ABCD matrix components. The use of an ABCD matrix allows for coordinate rotations. If the image surface is rotated, such that a y object coordinate images to both an x and a y image coordinate, the ABCD matrix will automatically account for the rotation. The grid distortion plot shows the linear grid, and then marks the ac

15 days ago

MichaelHLuminary

posted in Code Exchange

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. Click here to download Date Version OpticStudio Version Comment 2022-04-20 1.0 22.1 Creation

2 months ago

Michael ChengZemax Staff

posted in Code Exchange

API (CS User Extension): Diffractive DLL Setup Assistant

This is a small tool to help users setting up DLL parameters in a more convenient way. This is mainly useful when we need to set up multiple objects and parameters.Here is a quick user guide about the tool.The cell "From Obj" should be a single integer for object number we want to load DLL parameter settings. The par# is a string only including integer, comma, dash, and spaces. Integers are separated by comma. Dash is used to represent a range of integers. By cliking the button Load Par#, all the parameter numbers from the object defined by "From Obj" will be written in Par# cell. Par Val is a string only including numbers, comma, and spaces. Numbers don't need to be integer and are separaterd by comma. By clicking the button Load Values, the value of parameter number defined by cell Par# in object defined by cell "From Obj" will be collected and written in cell Par Val. The To Objs is a string works similar to Par#. We can define one or multiple objects that the 3 buttons "Set MCE", "

2 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

2 months ago

Michael ChengZemax Staff

posted in Code Exchange

DLL (Diffractive): Jones Matrix NSC

This DLL provides several different mode to handle the polarization with Jones matrix. When the ray is normally incident on to the surface, it returns same data as the built in object “Jones Matrix”. When the ray is obliquely incident on the surface, this DLL can handle the polarization in a way more like expected result. The DLL has a “mode” parameter that can switch how it calculates the polarization for output rays, but the mode 0 will probably be the most useful option. A document is attached with the DLL to explain the calculation details in each mode. Click here to download Date Version OpticStudio Version Comment 2023/03/18 1.0 - Creation

2 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 Click here to download Date Version OpticStudio Version Comment 2020/01/01 1.0 19.4 Creation

3 months ago

Sandrine AuriolZemax Staff

posted in Code Exchange

Python Zemax to SPEOS BSDF converter: version in progress

This example is a Python script to convert Zemax BSDF to Speos BSDF. 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/BSDF-converter/ansys_optical_automation/application/BSDF_converter_example.pyThe user inputs are:BSDF_inputFilepath: the Zemax BSDF. A window will appear to select the BSDF. precisionTheta: the precision between theta values for the Speos BSDF. The default value is 1 degree. precisionPhi: the precision between phi values for the Speos BSDF. The default value is 1 degree.The script will create a Speos BSDF file in the same folder as the Zemax BSDF file. For more information about Ansys optical_automation, click here.

3 months ago

Michael ChengZemax Staff

posted in Code Exchange

ZPL Macro: Sequential Jones matrix at each surface

This macro traces a single ray through the system. The Jones matrix is calculated at each surface. The Jones matrix is based on a plan normal to the traced ray. The electric field value after each surface can be calculated by multiplying the electric field before the surface by the Jones matrix. In the macro, the result from Polarization Ray Trace (POLTRACE) is also shown for comparison.Language: ZPL Click here to download Date Version OpticStudio Version Comment 2019/10/18 1.0 19.4SP2 Creation

3 months ago

James.GoodSingle Emitter

posted in Code Exchange

ZPL Solve: 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.

4 months ago

Sandrine AuriolZemax Staff

posted in Code Exchange

Python Zemax to SPEOS coating converter

This example is a Python script to convert Zemax coatings to Speos coatings. The script is available here.https://github.com/ansys/optical-automation/blob/main/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. Then the script will combine the two Speos coatings into a .bsdf180 file. The script is using the Transmission vs Angle analysis from OpticStudio. For more information about Ansys optical_automation, click here.

4 months ago

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

4 months ago

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

5 months 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: 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

5 months ago

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-internal.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 Repositor

4821

5 months ago

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

5 months ago

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

5 months ago

Page 1 / 3

Badge winners

doris.Chas earned the badge Allow me to introduce myself
Guopei.Lihas earned the badge Allow me to introduce myself
Richard.Migliacciohas earned the badge Allow me to introduce myself
Berta.Bernadhas earned the badge Allow me to introduce myself
cynthiapadthas earned the badge Visibly Un-Polarized

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