Knowledgebase
Ansys Zemax Support FAQs
User Groups

Community
Programming OpticStudio
ZOS-API

ZOS-API

Find and share your best practices for using the ZOS-API here!

337 Topics
1,023 Replies

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

337 Topics

Recently active

Most replies Most views Newest first

Daniel P. CaleroMonochrome

asked in ZOS-API

Coordinate return in ZOS-API

Hi,I am trying to make a script in ZOS-API where I introduce some tilts and displacements. At one moment I want to make an automatic return to a given surface. Is there a way to use the coordinate return of the coordinate breaks in the ZOS-API?Thanks,Daniel

561

1 year ago

dgeorgievInfrared

asked in ZOS-API

Not able to run example 23 from “Zemax\ZOS-API Sample Code\Python”

Hello,i am using Zemax Optics Studio 23.1 and trying to run the python example files included in the “Zemax\ZOS-API Sample Code\Python” directory.While others seem to work, when trying to run “PythonStandalone_23_ray_fan_native_manual_comparison.py” i get an error.----Traceback (most recent call last): File "c:\ex\PythonStandalone_23_ray_fan_native_manual_comparison.py", line 262, in <module> ray_settings.Field.UseAllFields() ^^^^^^^^^^^^^^^^^^AttributeError: 'IAS_' object has no attribute 'Field'Exception ignored in: <function PythonStandaloneApplication.__del__ at 0x000001D4F7E9F880>Traceback (most recent call last): File "c:\ex\PythonStandalone_23_ray_fan_native_manual_comparison.py", line 72, in __del__TypeError: 'MethodObject' object is not callable----I run the original file without any changes. Could somebody please possibly advise if eventually the API did evolve and this particular example file is no more compatible?Best regardsDimiter

1593

1 year ago

AruntvMonochrome

asked in ZOS-API

Using Zemax features through python.

Hi Team, I have a python program that finds the shifts in the position of spots (consider it as focused spots). I want to connect my python program with Zemax (Through Interactive Extension script) My question is, how do I connect specific feature (Say- Geometrical I mage analysis or Spot diagram) with python? Also, is there any changes I should be making in my python code, to connect with these Zemax features? Thanks in advance. Regards,Arun

3532

1 year ago

AmitUltraviolet

asked in ZOS-API

What would be the best way to create results similar to Image simulation tool while using Python

Hello Experts, I want to run image simulations over an entire dataset of images based on the lens design but image simulations take too long. Is there a way I can do that by using the Huygens PSF and an input image using python (maybe convolution)?To give a background, I have created 2000 field points and extracted the corresponding PSF as .txt files. These files represent one quadrant of the image plane and can be mirrored to create the spread of PSFs over the entire image plane. Then divide the inpput image into a grid of 8000 blocks and convolve each block in the grid with the corresponding PSF. This could create the output image.Is there a better way to do it? I ask becuase I am not able to change the settings of the image simulation while using python API and running the simulations automatically.The goal is to create a large database of images that are output of a certain lens model.Any recommendations are welcome. Thanks,Amit

680

1 year ago

Angel MoralesEn-Lightened

posted in ZOS-API

Retrieving Surface Parameter Values in Lens Data Editor through ZOS-API

In the ZOS-API, how can I modify values for a surface definition that correlate to 'Par 0, Par 1', etc., such as higher order terms for the Even Asphere?

8312

1 year ago

SanderSingle Emitter

asked in ZOS-API

Batch Ray Trace: adapt "toSurface" in loop

Hi all,I am using BatchRayTrace with the ZOSapi in OpticStudio 230724 and python 3.9.Following example 22, I am able to raytrace and extract the results into x_ary and y_ary. Subsequently I calculate the geometric radius using x_ary and y_ary. So far so goodAfterwards I want to use BatchRayTrace with a different surface and calculate the geometric radius again at the updated surface.Problem: I cannot update the “toSurface”. The first call of raytrace.CreateNormUnpol(max_rays, ZOSAPI.Tools.RayTrace.RaysType.Real, surf_i) seems to define the “toSurface”. It cannot be changed even, if I close the tool and open a new one with the new surface: It always calculates the exact same output as before. Does anyone tried to update “toSurface” of the BatchRayTrace -Tool in a loop before?Is there anything else to do to update the “toSurface” in addition to closing the Tool? Here is my code snipped: # Define batch ray trace constants hx = 0.0 hy = 0.0 num_fields = TheSystem.SystemData.Field

592

1 year ago

chrisInfrared

posted in ZOS-API

Please throw errors instead of failing silently

It is a good practice to fail extremely loudly - if there is some issue, don't leave it up to the caller to detect the problem. Halt execution, and please throw an error. We've been using CAD files, and the server we have been using the ZOS API didn't have Solidworks installed. Because of that, the ZOS API just silently ignores those CAD files - no logging, nothing. As a result, we have months of simulations that have produced bad results. The answer I've gotten before is 'We rely on the user to handle errors'. This is terrible UX. How am I supposed to find problems? I make an exhaustive checklist that is 300 items long that validates each ZAR file the API ingests? How do I make that checklist in the first place? I don't see how I could have noticed this CAD issue. At the very least, please print out potential issues to the console. The best option for UX would be to throw errors.

42715

1 year ago

Brian.CatanzaroFully Spectral

asked in ZOS-API

ZOS-API / Polarized Ray Trace / Parameters are not documented

Here’s a snapshot of the API documentationWhen tracing rays, the following parameters are not documented: double exr, double exi, double eyr, double eyi, double ezr, double eziThey are defined here:and here in the DDE documentation and here in the C codeand here by Julia (link)So… what’s missing?Well, Julia provides us with code that works. I am inferring the Ex and Ey set the amplitude of the electric field. That along with phaX and phaY set the polarization state. Exr, Exi, Eyr, Eyi, Ezr, Ezi have been used to specify the electric field of a ray in DDE and custom surface DLL code. They are often outputs, not inputs. If they are inputs then they seem redundant.So…Do we always set them to ‘0’? If we give them a value, will it override Ex, Ey, phaX and phaY? Generally Ez is reserved for rays approach off axis, which means if you specify this parameter, you should not also specify Hx, Hy, Px, and Py.This is all quite complex. What is the best guidance?

720

1 year ago

Hans-Jürgen FeigeInfrared

asked in ZOS-API

ZOS-API "GETZERNIKE"

Hello,We are urgently looking for an alternative to ZPL-GETZERNIKE using ZOS-API.The point is that we cannot tell “TheSystem.MFE.GetOperandValue(MeritOperandType_ZERN, “ the maximum term of Zernike.“TheSystem.MFE.GetOperandValue(MeritOperandType_ZERN, “ always develops only up to the given coefficient :-(MAny ThanksHans-Jürgen

68614

1 year ago

cameron.voStudent

asked in ZOS-API

Custom Operands with Python

Hello. I have been learning how to use ZOS-API in Standalone mode with Python for a while now, but it seems that custom operands for optimization are only available using C# or C++. I have started working with C# (despite not knowing the language) and I have managed to get custom operands to work using this. Currently, I am working on connecting C# to Python so I can run my previously written scripts and then optimize the system based on some values calculated in Python. My current pipeline looks something likeUDOC operand runs Python script Python script runs an instance of Zemax in Standalone mode and calculates some value Value is sent back to UDOC operand Zemax retrieves valueThis setup somehow manages to work with just getting the value from Python into Zemax in the Merit Function Editor, but actually using the UDOC operand for optimization doesn’t seem to work and is also incredibly slow. A single cycle in the optimization loop can take over two minutes while retrieving the UDOC

3153

1 year ago

Alex.TripsasVisible

asked in ZOS-API

Python Multithreading with POP

I’m working on running multiple POP simulations and they each take about 30 minutes. I’m debating trying out the python package “threading” to try and run multiple runs at the same time in order to save some computing time. Are there going to be any limitations on the Zemax side of this equation?

1471

1 year ago

Georg.AchaziInfrared

asked in ZOS-API

Tryind to get Started with ZOSPy

Hi is have a few Beginner Questions about ZOSPy.Sofar the few times I needed to do combine Zemax with Python I used PyZDDE.PyZDDE doesn’t seem to work any more with the Ansys Version of Zemax, so that I now have to switch.I just started to look into ZOS-API and try to wrap my head around how it works.For the start I have a few simple questions about ZOSPy:How do I control to which Zemax File ZOSPy connects? Does is it just connect to what ever Zemax File is open? What happens if several Zemax files are open? Do need to put the Phython Skipt/Jupyter Notebook in the same directory as the Zemax File? Do I need to switch Zemax into Interactive Extension mode before Running the Python script?

50210

1 year ago

Michael BausSingle Emitter

asked in ZOS-API

ZOS-API Mimic Auto Update for Optimization Tools

I want to start and optimization over the ZOS-API and output some status values (more than the merrit function itself) during the run. It seams that the variable variables are not updated during the optimization but only when the optimizsation ends or is canceled. It seams there is no API interface like in the GUI (“Auto Update”) for the optimizers and even in the GUI this button seams to be more gui related than belonging to a file (at least it is not saved within the file).Amnybody has an Idea how to solve this ? Any chances for a feature update in Zemax ?

jwbeenakkerVisible

We recently released ZOSPy 1.0.0, our open source library for easy communication between Python and OpticStudio. It uses the ZOS-API, but takes care of most of the programming, such as establishing the communication with OpticStudio and running and parsing analyses.The main new features included in this version are:Support for Python.NET 3.0 A uniform and pythonic interface to analyses:from zp.analyses.mtf import fft_through_focus_mtf mtf = fft_through_focus_mtf(oss, sampling='64x64', deltafocus=0.1) Autocomplete for the complete ZOS-APIAnd much more, see the release notes Check out the new version on GitHub.

ArmandPMonochrome

Hello,I am having some difficulty finding answers on this elsewhere online and have not found any helpful forum posts on this either so here I am. I am trying to communicate with the POP with the python ZOSAPI with the program in interactive mode. Currently I have tried this little code snippit to set the surface desired to 2 and pull the irradiance with not much luck. Python more or less yells at me with an error saying “IAS_ object has no attribute ‘EndSurface’ I am not having the best of luck finding a solution to this problem in the help document. Please Help! :)FYI: See code snippit below # initialize analysis toolsTheAnalyses = TheSystem.AnalysesPOP = TheAnalyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.PhysicalOpticsPropagation)POP_set = POP.GetSettings()POP_set.DataType = ZOSAPI.Analysis.PhysicalOptics.POPDataTypes.IrradiancePOP_set.EndSurface.SetSurfaceNumber(2)POP.ApplyAndWaitForCompletion()POP_result = POP.GetResults()Irr = float(POP_result.DataGrids(1).Values) Cheers,Armand

2276

1 year ago

KBLSingle Emitter

asked in ZOS-API

ZOS-API, Python Image simulation. No output

Hey, I’m very naïve to Zemax and ZOS-API. I just tried to find the setting and run the code, but I couldn’t see the results from the image simulation.I used the standalone application and here is my code. # load local variables ZOSAPI = zos.ZOSAPI TheApplication = zos.TheApplication TheSystem = zos.TheSystem # Insert Code Here file = "C:/2021/Zemax_Image_Simulation/test.zmx" cfg = "C:/2021/Zemax_Image_Simulation/test.CFG" TheSystem.LoadFile(file, False) TheImageSimulation = TheSystem.Analyses.New_ImageSimulation() analysisSettings = TheImageSimulation.GetSettings() analysisSettings.ModifySettings(cfg, 'ISM_INPUTFILE', "Text_100p_3x3_2_g1196x1279_dist.png") analysisSettings.ModifySettings(cfg, 'ISM_FIELDHEIGHT', '15') analysisSettings.ModifySettings(cfg, 'ISM_FLIPIMAGE', '3') analysisSettings.ModifySettings(cfg, 'ISM_OUTPUTFILE', 'Test1.png') analysisSettings.LoadFrom(cfg) a = TheImageSimulation.ApplyAndWaitForCompletion()

850

1 year ago

ChrisPSingle Emitter

asked in ZOS-API

Very Slow Parameter Setting in ZOS-API

I am writing a program where I need to make several changes to values in the Lens Data Editor (e.g. parameters of a coordinate break surface) and evaluate merit function operands after each set of changes. The problem is this is extremely slow, to the point that setting the parameters dominates runtime far beyond the time spent raytracing. For example, this function averages about 1 second per call:def set_offset(oss, surface_number, x, y, about_x, about_y): oss.LDE.GetSurfaceAt(surface_number).SurfaceData.Decenter_X = x oss.LDE.GetSurfaceAt(surface_number).SurfaceData.Decenter_Y = y oss.LDE.GetSurfaceAt(surface_number).SurfaceData.TiltAbout_X = about_x oss.LDE.GetSurfaceAt(surface_number).SurfaceData.TiltAbout_Y = about_y I’m sure there are some minor optimizations I can make, but at its core, setting a single variable in memory shouldn’t take anywhere near 0.25 seconds.Am I doing something wildly wrong, or is there a far more efficient way to modify LDE entries? Is ther

1362

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

2451

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?

671

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

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

20010

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

941

1 year ago

Page 4 / 14

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

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