Knowledgebase
Ansys Zemax Support FAQs
User Groups

Community
Programming OpticStudio

Programming OpticStudio

Share your solutions or ask questions about the ZOS-API, ZPL, or DLLs. Code shared in these spaces is not reviewed by Zemax except for the Code Exchange.

687 Topics

Recently active

Most replies Most views Newest first

Keiya.YoshidaSingle Emitter

asked in ZPL

Where is the detail explanation of MODIFYSETTINGS key word "Tfg"?

Hi, I’m trying to develop a ZPL macro that can get the Through Focus Geometic MTF which modifysettings key word is “Tfg”. But I’m not able to find detail explanation of “Tfg” in UserManual.PDF. In case of “Tfm”, I know the Modifysettings of “Tfm” is supported. I was able to run the ZPL code like below. MODIFYSETTINGS tfmcfg$, TFM_SAMP, calc_tfm_sampBut the ZPL code include “Tfg” like below has errored.MODIFYSETTINGS tfgcfg$, TFG_SAMP, calc_tfg_sampERROR in MODIFYSETTINGS: Incorrect version number in settings file.Please let me know whether “Tfg” code is supported or not?Keiya Yoshida

1267

1 year ago

BenjSingle Emitter

asked in ZOS-API

ZOS-Api: Legacy / Ansys

Hi, currently we have different Network Licenses for Ansys Zemax OpticStudio and Legacy Zemax OpticStudio in our company. Depending on which license is free I’m using Ansys Zemax or Legacy Zemax. However, most of the time I am working with the ZOS Api in python.The problem is when I use the ZOS Api and all Ansys Licenses are currently used, the ZOS Api throws the LicenseException, although there are free Legacy Licenses (I am able to open Legacy OpticStudio). Is there a Workaround to tell the ZOSAPI to look for legacy Licenses as well?Thanks,Benjamin

370

1 year ago

JuliaFully Spectral

asked in ZOS-API

ZOS-API: (Python) sequential batch ray trace example

An example of tracing 2 rays by using the following method.OpenBatchRayTrace

2461

1 year ago

Jaren.AshcraftInfrared

asked in ZOS-API

import BatchRayTrace in ipython

Hello!I’m attempting to use the `zosapi` package with @MichaelH ‘s RayTrace.dll for fast batch ray tracing in Python. It works just fine when I call Python scripts from some terminal, but am having some difficulty using it in Jupyter/IPython notebooks.Below shows where the kernel crashes, without giving me a stack trace to try and diagnose why the kernel is crashing. Has anyone encountered this problem before?

1195

1 year ago

JuliaFully Spectral

asked in ZOS-API

ZOS-API: How to save/load a .FLD file into a system

Is it possible to save and load .fld files in the Field Data Editor using the ZOS-API method?

691

1 year ago

Arash GhorbaniSingle Emitter

asked in Code Exchange

.ray to .dat conversion

I followed the instruction for converting ray files to dat files using Visual Studio. But I can not open the file that I would like to convert using “Shift+Alt+F5!

1053

1 year ago

Michael ChengZemax Staff

posted in Code Exchange

CMOS Sensor Workflow: Exporting CRA and MRA data

The tool provided in this post is part of a workflow to simulate the CMOS sensor response. The workflow includes 3 steps. (1) Analyze chief and marginal rays information for the target lens data system in OpticStudio.(2) Calculate the conversion efficiency from incident optical power to output electric power in Lumerical.(3) Utilize the data of conversion efficiency and the irradiance from optical simulation in Speos to get the final electric power map. In this post, the tool for first step is introduced. By running this tool with a given lens system, we calculate and export the data of chief and marginal rays’ angle for different position on the image surface. For step 2 and step 3, the information will be updated soon in following two articles:CMOS Sensor Camera - Sensor Characterization – Ansys OpticsCMOS Sensor Camera - Image Quality Analysis in a 3D Scene – Ansys Optics The process in this step is as below.Open the lens system. Perform Design Lock Down tool in the Tolerance tab in

2730

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

17112

1 year ago

Alex.TripsasVisible

asked in ZOS-API

Can API call ZPL function

I’m writing a script to do a lot of automation and has a lot of inputs for different configurations. I’m trying to combine multiple .ZBF, each with a different field position. This means I need to use ZBFRESAMPLE to shift the images to match their offsets compared to the on-axis field. This is quite handy since I can use physical units to shift the image rather than try and figure out how many pixels I need to shift by.The only other option I can think of is to have the API run a macro, however, I think I would need to have the ability to have the API input variables into a macro which I don’t think is possible.Does anyone know if it’s possible to call just one ZPL function in API or do I need to figure out how to mix API and ZPL?

1365

1 year ago

Timo.EppigSingle Emitter

asked in ZOS-API

How to open and modify settings of a user analysis in ZOS API?

I created a user analysis in ZOS API that works well when opened manually in the GUI. But i wonder if there is an option how I can programmatically open this analysis in ZOS API.

643

1 year ago

John.HygelundFully Spectral

asked in DLLs

input limited for Diff2DSample.dll

Hello,It seems that the number of inputs for order efficiency is limited when using Diff2DSample.dll. The image below shows inputs missing orders above 2,-2. Is there any workaround for this? I’m on Zemax OpticStudio 23.1, PremiumThank you,John

740

1 year ago

alexander_dumontInfrared

asked in ZPL

Why does the merit function have different values than when I run ray trace?

So I’m trying to optimize a design in Zemax non-sequential. However I’m noticing that there is a discrepancy between what the MF editor reports, and what I see from running ray trace and running detector viewer. My MF looks like the following: And I see that the total flux (line 7) is 0.619 out of .75. This is a very good number. So then I cancel the optimization, and perform a ray trace, and when I take a look at the detector viewer, I get the following:How can the MF editor be displaying 0.619, yet the total power, which I think is the same metric on the detector viewer is indicating 0.422?

1451

1 year ago

MalkielSingle Emitter

asked in DLLs

Increasing max diffraction order beyond 10 for RCWA analysis dll

According to Zemax’s online help https://support.zemax.com/hc/en-us/articles/1500005578722-Simulating-diffraction-efficiency-of-surface-relief-grating-using-the-RCWA-method, for the particular diffraction grating that we are trying to model, we need to increase the Max Order parameter.In the help on “simulating diffraction efficiency of a surface relief grating using the RCWA method” authored by Michael Cheng and updated on April 28, 2023 under the subsection Max Order it is stated“This is currently limited to 10 (totally 21 harmonics). When the number is larger than 10, it’s modified to 10 in the DLL. Contact support team to increase the limitation.”What is the procedure to increase the limitation?

843

1 year ago

devin.vega_01Monochrome

asked in ZOS-API

Batch Ray Tracing Vignetting Inconsistency

While analyzing the results of batch ray traces, I noticed that some rays seemed to be transmitted through the system that I did not believe should have made it. To test this, I set up a series of ray traces, all with the same set of input ray positions and direction cosines (no difference whatever). The only parameter I let vary between the traces was the final surface of the ray trace. In other words, my setup contained this line:RayTraceData = raytrace.CreateDirectPol(total_rays_in_both_axes, ZOSAPI.Tools.RayTrace.RaysType.Real, 0,0,0,0,startSurface,endSurface);where only endSurface was allowed to vary. I stepped endSurface through every surface and recorded the vignetteCode value of every ray. Plotting the results, I have found a few instances where a subset of the rays that vignette at the nth surface are not listed as vignetting at the n+1st surface. For example (see attached), the plot for surface 18 shows rays that were listed as vignetting at surfaces 7, 8, and 9, which are no

20110

1 year ago

LuciaSingle Emitter

asked in ZPL

ZPL to save geometric image analysis images in a loop

Hi, I’m trying to use ZPL to run a couple of loops and save geometric image analysis. This loops aim to change the field and wavelength in the settings of the image, but I cannot make it work. If I go for the text-only saving option, it doesn’t change either. To guide you into the code, first I define the x and y of the fields:DECLARE setxfields, DOUBLE, 1, 9DECLARE setyfields, DOUBLE, 1, 9setxfields(1) = 0.0setxfields(2)=9.68938 …setyfields(1)=-0.0 setyfields(2)=-0.034… Then define the folders and filenames and then start the loopFOR wave2, 1, 9, 1 FOR field, 1, 9, 1 field_x = setxfields(field) field_y = setyfields(field) SETSYSTEMPROPERTY 101, 9 SYSP 102, 1, FLDX(field) SYSP 103, 1, FLDY(field) SYSP 202,1,WAVL(wave2) window=WINL() OPENANALYSISWINDOW "IMA" UPDATE ALL filename$ = arm$+"_"+mode$+"_"+"test_wave_"+$str(WAVL(wave2))+"_field_"+$str(field)+".bim" filename2$ = arm$+"_"+mode$+"_"+"test_wave_"+$str(WAVL(wave2))+"_field_"+$str(field)

1982

1 year ago

LmmartinSingle Emitter

asked in ZOS-API

Extract accurate MTF from simulated scenes without resorting to FFT PSF

HiI am using Zemax to simulate images of scenes through customized imaging setups. However, I am unable to simulate images of scene with sufficient resolution.My current imaging setup convolves a complex PSF with the observed scene. Extracting actual scene information requires deconvolution of the image to obtain a meaningful image. This means that I cannot resort to the classical MTF procedure using the FFT of the simulated PSF, as it would only give me the MTF of the convoluted image.I have therefore tried to proceed by scene analysis to extract MTF, i.e. simulate with Zemax the image of classic checkerboard patterns seen through my custom design and then in a second stage extract the MTF using image processing software. The core issue is that the resolution of images obtained after deconvolution are insufficient for image analysis and MTF extraction by slanted edge method.Is there any way to get more accurate scene imaging through simulation with my setup? Or is there another metho

951

1 year ago

Amy EntinInfrared

asked in ZOS-API

Is there a ZOS-API equivalent to the ZPL OBJC(A$)?

In particular, I’m using the Python API. I would like to be able to look for objects by name to make the scripts more reusable.

994

1 year ago

linSingle Emitter

asked in ZOS-API

ZOS-API Python how to access HuygensPsfCrossSection settings

Hello,I’m trying to convert the following C# code snippet:var hpsf =TheSystem.Analyses.New_Analysis(AnalysisIDM.HuygensPsfCrossSection);var hpsf_settings = hpsf.GetSettings() as IAS_HuygensPsfCrossSection;hpsf_settings.PupilSampleSize = (SampleSizes)(_pupilSampling + 1);hpsf_settings.ImageSampleSize = (SampleSizes)(_imageSampling + 1);hpsf_settings.ImageDelta = 0;into Python:hpsf= TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.HuygensPsfCrossSection)hpsf_setting=hpsf.GetSettings()hpsf_settings.ImageDelta = 0but I got error messageAttributeError: 'IAS_' object has no attribute 'ImageDeltHow can I cast hpsf_setting returned by GetSettings() into a HuygensPsfCrossSection specific object?Thank you very much! lin

742

1 year ago

Benjamin.NVisible

asked in ZOS-API

access cotents of Ray Database Viewer via ZOS-API

Hi all,is there a way to access the contents of the Ray Database Viewer via the ZOS-API? I did not find any example. I am not even sure whether it is possible since there does not seem to exist an interface for this analysis type in ZOS-API. I found a knowledge base article which explains how to read the contents of .ZRD files (Batch Processing of Ray Trace Data using ZOS-API in MATLAB or Python – Knowledgebase (zemax.com)). However, I have no idea how much effort is required to recreate the content of the Ray Database Viewer from the .ZRD file.Best regardsBenjamin

1502

1 year ago

JonaszVisible

asked in ZOS-API

Collimation of beam with ZOS-API

In a simple exercise where a paraxial lens is used to collimate a beam from a diode source, I use a rectangle detector to monitor the output of the lens.Using the function GetAllDetectorDataSafe(det_id, x) or other, is it possible to retrieve the detector data in the angular space? I would like to extract the angular RMS to conduct an optimization of the lens position that results in a collimated beam. Kind regards

1454

1 year ago

JiYMonochrome

asked in ZPL

How can I import Grid Sag in macro using buffer

Hi all, I am writing a ZPL macro which calculates phase patterns and imports the phase into Grid Phase Surface automatically. (There is a typo in title. I’m using a Grid Phase Surface) I found a way to import the grid phase using IMPORTEXTRADATA keywords in a below questionMacro import of .dat file onto a Grid Phase surface | Zemax CommunityBut it requires “reading” .dat files; so, I should firstly generate .dat file for the calculated phase profiles, and after that I could read again the phase from those .dat files to import. It seems to be very inefficient method and takes too long time to write and read my phase profile. Is there any way to import phase data directly from another data types in ZPL (like array or vec) instead of writing and reading .dat files? With best regards,Jiwoon.

714

1 year ago

cameron.voStudent

asked in ZPL

ZPL Macros: Efficient ways of getting data points from the MTF

Hello,I am trying to develop a ZPL macro that will be used in my merit function so that different wavelengths and different fields will all share the same MTF. I am currently getting very good results with my code, but it is a little bit slow at roughly 8 seconds per cycle which is worrisome as I am currently only doing 1 field with 3 wavelengths. I was wondering how GETMTF actually works since it seems like it is calculating the entire MTF and only extracts the value for a single specified frequency when GETMTF is ran. For my purpose, it would be more efficient to calculate the entire MTF once for each wavelength/field, and then I could just grab the values directly from the MTF rather than having to run a loop combined with GETMTF to get the values I need to calculate MSE. Please let me know if you have any suggestions on making my code more efficient or any alternative methods to solve this problem.

2281

1 year ago

DavidLuminary

posted in Code Exchange

DLL (Source): Non-sequential fan and ring sources

For both radiometric analysis (for example determining the power incident on a detector) and optimization, the best choice for a source is almost always a pseudo-random source such as a Source Ellipse, with enough analysis rays to provide for smooth statistics. Frequently, this means tens of thousands to millions of rays. For visualization, OpticStudio provides the capability to designate a lesser number of Layout Rays to appear in layout plots. These layout rays are still randomly distributed. If only a few rays are used, they generally do not well represent the design. If enough rays are used to visualize the extent of the volume occupied by rays, then the plot can become crowded.As a solution to this problem, the accompanying DLL files provide the ability to generate, in non-sequential mode, uniform fans and rings of rays similar to those which can be displayed in sequential mode layouts. They are compiled for a Windows 64-bit platform.YFAN.DLL is a source dll which, when installed

5291

1 year ago

William OakInfrared

asked in ZPL

How to stop NSTR from resetting number of cores?

Hello,So I’ve been trying to alter the number of cores through a macro by using “SYSP 901, []”. However, each time I run the ray trace (NSTR 1, 0, 0, 0, 0, 0, 0), the number of cores resets to its maximum value.To attempt to identify why, I re-used the code proposed HERE, adding a “print SYPR(901)”, and I get the following.The elapsed time varies somewhat, but stays close enough to one another to conclude that the NSTR is somehow resetting the # of core before running the ray trace.-The duration is coherent with 20 cores (~7.8s) if I run it using the Ray Trace Control window; the time at 1 core is ~40s, 16 cores 7.4 s-I’ve tried using the advanced options in the system explorer to Turn Off Threading, without it having any apparent effect.-Apparently NSTR does an update to everything before running, but I’ve not been able to reproduce the bug with “UPDATE” so I don't think that's the cause.-I’ve tried other files and seen the same issue (namely Projector Modeled Using an IES Data File.Z

1011

1 year ago

alexander_dumontInfrared

asked in ZOS-API

Batch Ray Trace and CreateDirectUnpol returning intensities always equal to 1 in system with black boxes

Hi everyone! Long time lurker, first time posting. I have been using Zemax for the past couple of months, and have been getting familiar with the backend, C# ZOS-API. As I’ve been getting more familiar with the ZOS-API, I’ve tried to more and more exciting things, which eventually lead me to use the batch ray tracing function. I can do this successfully and actually get quite a good representation of my input picture at the output image side, using CreateDirectUnpol and AddRays. However, I am trying to get a feel for intensity on the imaging plane, and the only output I get when using ReadNextResult is intensity = 1, even though my system has various elements with different non-100% coatings on them. However, I am using black-box lenses from Thorlabs, and I’m wondering if this causes Zemax not to give out the intensity values? If not, what could I be doing wrong?Attached is the relevant code I use which gives me 1 for intensity output: // Set up Batch Ray Trace

1092

1 year ago

Page 8 / 28

Badge winners

guangjun.gao@nasa.govhas earned the badge Allow me to introduce myself
Michael.Younghas earned the badge Visibly Un-Polarized
nadav.amitaihas earned the badge Visibly Un-Polarized
TMXhas earned the badge Allow me to introduce myself
Yang.Yongtaohas earned the badge Visibly Un-Polarized

Show all badges

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

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

Enter your e-mail address

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.

Zemax Community

Manage email notification
Private Message Inbox
My Subscriptions
Posting guidelines

Need more help?

Ansys Zemax OpticStudio
Knowledgebase
Software Downloads
Consultants
Open a Case

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

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