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!

340 Topics
1,043 Replies

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

340 Topics

Most replies

Most views

Newest first

Chase.CalviSingle Emitter

asked in ZOS-API

Zernike Alteration in Python API

Does anyone have an example (or is there one in the zemax documentation) for altering the number of zernike terms and the terms themselves using a python API?

3108

1 day ago

Mark.JunkerMonochrome

asked in ZOS-API

Vertex position and ray location

Hello. I am trying to get the vertex position of each optical element in terms of global coordinates. I have found I need this as I am trying to find the full X, Y, Z location for each ray when running a “CreateNormUnpol” raytrace. When I am reading the ray information, I only get values for the X & Y locations and a 0.0 value for the Z location of the ray. Is there a way to enable global position for all axes? In a similar analysis, I want to know if there is a way to run a single ray trace and get all the location and angle information at each surface as is done in the Single Ray Trace window under the Analysis tab?

6792

2 days ago

Daniel P. CaleroInfrared

asked in ZOS-API

Setting tilts and decenter solves as variable in ZOS-API

I am trying to set some coordinate breaks X-Y tilts as variable using ZOS-API in Matlab.for thickness I know that the code is:Surface1.ThicknessCell.MakeSolveVariable();I tried different approaches, but nothing worked so far.

131

4 days ago

Michael.YoungUltraviolet

asked in ZOS-API

Matlab examples failing to connect to OpticStudio

I am having an issue with the example Matlab scripts in OpticStudio. They fail to connect to OpticStudio. Here, for example is the portion of the Matlab function that connects, InitConnection FunctionIf I uncomment the success variable to define a “custom” path to OpticStudio, then the function will work; however, the line,success = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize();assigns 0 to success.I am curious as to why this is happening? I am running Zemax OpticStudio 2024 2.01. My installation folder for the program isC:\Program Files\Ansys Zemax OpticStudio 2024 R1.00\You can see the difference between the release number and the version that I’m running. I installed the program using the Ansys downloader.

221

4 days ago

YonatanSingle Emitter

asked in ZOS-API

How do I get center coordinates from Huygens PSF in the ZOS-API?

Hi,I’m trying to extract data of Huygens PSF in Matlab through the API.I want to get the center coordinates and I thought the HeaderData will include it. But looks like the HeaderData is empty. PSF_Results = PSF_Win.GetResults();string(PSF_Results.HeaderData.Lines) ans = 1×0 empty string array The MetaData and the DataGrids seems to work fine and contains the data.Am I missing something? Is there other place that I can pull the coordinates from there? Thanks!

4073

7 days ago

harry000kStudent

asked in ZOS-API

MODIFTSETTINGS type codes for geometric MTF

Type codes for modifysettings are listed in the Zemax help files under: The Programming Tab > About the ZPL > KEYWORDS (about the zpl) > MODIFYSETTINGS (keywords) However, Geometric MTF is not listed here. My question is: what are the type codes for the geometric MTF analysis window?In case these do not exist, how would I go about modifying the settings for the geometric MTF analysis window via ZOSAPI?

1735

17 days ago

Luc.van VughtInfrared

asked in ZOS-API

Incorrect datagrid.MinY for Geometric Image Analysis

We recently implemented the Geometric Image Analysis in ZOSPy 1.30. While doing so, we noticed that IAR_DataGrid.MinY does not return the lower bound of the y-axis for the output (at least when compared to the output in OpticStudio itself). It seems to be returning either the upper bound or the abolute value. E.g., when the analysis is centered at (0,0), the x- an y-axes in OpticStudio start at -25 while the API returns -25 for MinX and 25 for MinY. Could you elaborate on what MinY (and to an extend MinX) correspond to. So far, we thought the datagrids and their axes follow the normal matrix conventions, which was the case for all analyses we implemented and used. Is this not the case for Geometric Image Analysis, or is there an error in the API?

1166

24 days ago

Erkang WangInfrared

asked in ZOS-API

How to read out X half width and Y half width of a detector Rectangle using python.

I need to read out the X half width and Y half width of a Detector Rectangle. The above code used to work but now it says no AttributeError: 'IObject' object has no attribute 'XHalfWidth'. Could you tell me a way to circumvent this problem.

743

1 month ago

RizwanSingle Emitter

asked in ZOS-API

Why aren't C# ZOS-API updating their dlls to be compatible with all target frameworks?

Recently I am developing an internal software by using c# ZOS-API dll. I have chosen .Net 8.0 for my application. After adding the refrences of ZOS-API, it gives me error due to incompatibility of frameworks. ZOS-API has been developed by using .Net framework v4.6.2. If I build my assembly with net framework 4.8, it works fine, but not supports in net 8.0. Why aren't they developing dlls with Microsoft .Net (support cross platform) instead of .Net framework? I have also seen that the headless remoting connection is taking long time. Why aren't they using modern remote procedure framework like gRPC?

734

1 month ago

RahulSingle Emitter

asked in ZOS-API

Uploading multiple merit function via loop in MATLABStandaloneApplication code

Hello, I am working on designing lenses (Intraocular lens) of a power range and each power has unique merit function. I could manage to load merit function using the command below - TheMFE = TheSystem.MFE;mf3_filename = System.String.Concat(sampleDir,'\API\Matlab\MeritFunc\10.0D MF.MF');TheMFE.LoadMeritFunction(mf3_filename); In the same location I have merit functions for different power lenses. Can anyone suggest me a way how can I successfully load power specific merit function?Thanks in advance! Regards,Rahul

611

1 month ago

mluninMonochrome

asked in ZOS-API

Is there a way to extract information about ray path through a GRIN optic (sequential mode) via ZOS-API?

Title. I can easily get the entry/exit points into a GRIN lens via tracing rays to a surface using SingleRayNormUnpol() and BatchRayTrace.However, this only gives me the entry/exit points into a surface. Is there a way to get information out about the beam path within a GRIN optic via ZOS-API?As an additional note, the GRIN optic is modelled via a custom *.dll extension I developed (not a ZEMAX Gradient 1-12 surface).My alternative is to write my own GRIN raytracer for the intermediate steps.

574

1 month ago

Paula Sola.de la SernaMonochrome

asked in ZOS-API

Extracting Combined Huygens PSF of a Multiconfiguration System in ZPL/ZOS-API

Hello everyone,I'm trying to extract the combined Huygens Point Spread Function (PSF) of a multiconfiguration system using either ZPL or the ZOS-API. In OpticStudio, I can achieve this directly by selecting "All" in the configuration button under the Huygens PSF settings, which provides the result I need. However, I'm having trouble replicating this setting in ZPL or ZOS-API, as I haven't been able to find an equivalent command or setting to retrieve the combined PSF programmatically.Has anyone here managed to access this setting through ZPL or ZOS-API, or is there an alternative approach to obtaining the combined Huygens PSF across configurations?Thanks in advance for any guidance or examples you might be able to provide!Cheers!

1213

2 months ago

Luc.van VughtInfrared

asked in ZOS-API

PlotScale missing in ZOS-API for Geometric Image Analysis

We recently implemented the Geometric Image Analysis in ZOSPy 1.30. While doing so, we noticed that the setting PlotScale seems not to exposed in the ZOS-API for this analysis. Is that correct?

782

2 months ago

gsun86Monochrome

asked in ZOS-API

ZOS-API C++ sample code can't compile in Visual Studio - no ZOSAPI.tlb was generated

Need help to run through the ZOS-API C++ sample. In zosapi.h:#import "C:\\Users\\gangs\\OneDrive - kochind.com\\Documents\\Zemax\\ZOS-API\\Libraries\\ZOSAPII.tlb"#import "C:\\Users\\gangs\\OneDrive - kochind.com\\Documents\\Zemax\\ZOS-API\\Libraries\\ZOSAPI.tlb"// Note - .tlh files will be generated from the .tlb files (above) once the project is compiled.// Visual Studio will incorrectly continue to report IntelliSense error messages however until it is restarted.But the *.tlb files were not generated after build and restart the Visual Studio, and can’t proceed.Thanks,

370

2 months ago

Aleksandr.MakarovUltraviolet

asked in ZOS-API

single IMAE operand

can I calculate and get operand IMAE without adding it to MF with python api?IMAE work as geometric image analysis? what if I need “geometric bitmap image analysis”?they have different settings and from it different efficiency values.

571

3 months ago

joachimMonochrome

asked in ZOS-API

Python ZOS-API, example not working out of the box since Ansys

The example script for the interactive mode in Ansys Zemax OpticStudio 2024 R1.03 does not work out of the box. It manages to find the path of the ZOSAPI_NetHelper.dll from the windows registry (path is to C:/Users/username….) but it says:Exception: Cannot find OpticStudioI don't know why this automatic path is not found, if I put manually the path inside the script (line 24):pathToInstall = r'C:\Program Files\Ansys Zemax OpticStudio 2024 R1.03'It works! Not sure if it is related that I used Zemax before it was acquired by Ansys and it is looking in the wrong location.Just for those who'd like to use the zospy library, you can also pass the path directly:import zospy as zpopticstudio_directory = r'C:\Program Files\Ansys Zemax OpticStudio 2024 R1.03'zos = zp.ZOS(opticstudio_directory=opticstudio_directory)oss = zos.connect("extension")Perhaps it helps others to save some time.

3114

4 months ago

Mikayel.MusheghyanMonochrome

posted in ZOS-API

ZOS-API Python IntelliSense

Hello Everyone! During the discussions with the Zemax staff, we came across something that might be useful for everyone. This has to do with working in Python with the ZOS-API. As it is generally known, Python does not have IntelliSense in the same sense as Matlab does. The standard workaround (https://my.zemax.com/en-US/Knowledge-Base/kb-article/?ka=KA-01620 ) has been inserting break points and debugging your code to see the functions and the properties. Below is a different way that can enhance the working speed in Python. However, I should note the following. At the moment of writing this, the method works only with Python 3.8 (Tested on Python 3.8.1). The precise reason for why it doesn’t work in, say 3.7, is not clear to me, but maybe Zemax staff can provide some feedback on this? Anyway, in order to get the method to work, I required the following. As an IDE - the Visual Studio Code from Microsoft: https://code.visualstudio.com/ . Tutorial on getting started with Python

6092

4 months ago

devin.vega_01Monochrome

asked in ZOS-API

ZOS-API Performance Hit On Software Update

I have a couple scripts I began writing a few software versions ago on Zemax 21.2 and MATLAB 2020b. These were Zemax Zos-API MATLAB scripts that performed a large number of direct unpolarized ray traces. I have noticed that since updating my software to Ansys Zemax Opticstudio 2024 R1.03 and MATLAB R2022b there seems to be a fairly substantial performance hit. Has anyone else noticed this? Have there been changes to the way the ZOS-API functions that I need to implement in my scripts post update?

670

5 months ago

chrisInfrared

asked in ZOS-API

Problem with rotation matrix article

https://support.zemax.com/hc/en-us/articles/1500005576822-Rotation-Matrix-and-Tilt-About-X-Y-Z-in-OpticStudio is misleading.OpticStudio uses degrees for Tilt About X/Y/Z, and this graphic suggests using theta_x = tilt about x. Tilt about X is in degrees, but theta_x should be in radians. If you do as the graphic suggests and plug in degrees, you'll get the wrong rotation matrix.Please let me know if I'm wrong here.

5035

5 months ago

s.ngMonochrome

asked in ZOS-API

definition of pathLength in ReadNextSegment

In the API command ReadNextSegment, is pathLength = optical path length or physical path length?ReadNextSegment (out int segmentLevel, out int segmentParent, out int hitObj,out int InsideOf, out double X, out double Y, out double Z, out double L, outdouble M, out double N, out double exr, out double exi, out double eyr, outdouble eyi, out double ezr, out double ezi, out double intensity, out doublepathLength) Where is the documentation on this?Is there a way to select optical or physical with this command?

190

5 months ago

Hans-Jürgen FeigeInfrared

asked in ZOS-API

What is the ZOS-API-solution of ZPL-RAYTRACE

So far I haven't found a way to calculate many rays through to the image surface and read out the ray data on each surface.In ZPL, the "RAYTRACE hx, hy, px, py, wavelength" provides ray data on all surfaces (RAY*(surface)).Have I overlooked a solution using ZOS API?Many Thanks!Hans

1999

5 months ago

BoruiMonochrome

asked in ZOS-API

Confusion about correponding command of 'Insert Object After' function and 'Show As' type.

I have known that using command ‘ZOSAPI.TheSystem.NCE.InsertNewObjectAt(i)’can realize the function ‘Insert Object’, then I tried some commands but still cant find corresponding one for ‘Insert Object After’.The other similar question is similar. I have known that using command ‘Det_Set1.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.GreyScale’can realize the function‘ can realize the function of setting ‘Show As’as ‘Grey Scale’, then ‘InverseGreyScale’and ‘CrossSectionRow’ dont work for corresponding functions.

311

5 months ago

BoruiMonochrome

asked in ZOS-API

How to use 'SetRayData' in ImportanceSampling Interface?

I have set the ‘Scatter To Method’with the commond ‘...ScatterToData.ScatterToMethod = 1’, then I wanna set the Ray data as shown in Fig. 1, but I failed to call the function ‘SetRayData’.According to the Ansys Developer Guideline as shown in Fig. 2/3, it doesnt give more details, I have tried to infer corresponding code but cant work.Fig. 1Fig. 2Fig. 3

332

5 months ago

Indy.MagnusMonochrome

asked in ZOS-API

Image simulation using ZOS-API overwriting existing images when used in a loop

Hi all,I am facing an issue when using the Image Simulation tool via the ZOS-API. The goal is to vary a certain variable in a loop (in this case the object distance), perform each time an image simulation, and save the image with a specific name to a file. However, I notice that the previous images are always overwritten when a new image is saved.This is the simple MATLAB code that I am using in the main body:sampleDir = 'D:\Zemax OpticStudio\';testFile = System.String.Concat(sampleDir, '\Test_ImageTelecentric_Issue.zos');TheSystem.LoadFile(testFile,false);TheSystem = TheApplication.PrimarySystem;TheLDE = TheSystem.LDE;zline = 0;surface = TheLDE.GetSurfaceAt(zline);zvec = [1100,1500]; %variable object distancefor z = zvecsurface.Thickness = z;index = 3; %existing Image Analysis window with correct settingsim_analysis = TheSystem.Analyses.Get_AnalysisAtIndex(index);im_settings = im_analysis.GetSettings;im_settings.OutputFile = ['z',num2str(z),'.png']; %change file name according to vari

1192

5 months ago

Travis3Monochrome

asked in ZOS-API

RunAndWait vs ApplyAndWait Traces

Hello, Currently I have a program in MATLAB ZOS-API that involves a light source that is shining on an array of detector rectangles. The purpose of the for loop is to tilt the X and Y component of the light source then read out the total power from each detector. The problem I am having is how to extract the data efficiently without opening a new detectorviewer each iteration. Currently I am having the for loop run a new ray trace as well as a newanalysis command which I believe is responsible for opening a new detectorviewer each iteration. Ideally the code would just update one detectorviewer or not open one at all to save me computing time. I will attach a snip of my current for loop where I believe the problem resides. I have tried to follow along to this link: Methods for extracting detector data through the API | Zemax Community… But not much success is being had. Any and all help would be greatly appreciated!

633

5 months ago

Page 1 / 14

Badge winners

Bharadwajhas earned the badge Allow me to introduce myself
John.Hygelundhas earned the badge Visibly Un-Polarized
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

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

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