Skip to main content

ZOS-API

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

  • 338 Topics
  • 1,036 Replies
338 Topics
L
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?

1066
L
3 days ago
Erkang Wang
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. 

473
David.Nguyen
Luminary
10 days ago
Rizwan
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?

634
Mark.Nicholson
Luminary
23 days ago
Rahul
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

541
L
1 month ago
mlunin
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.

544
mlunin
1 month ago
P
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!

1153
L
1 month ago
L
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?

742
L
1 month ago
gsun86
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,

310
gsun86
1 month ago
A
Ultraviolet
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. 

551
A
Ultraviolet
3 months ago
joachim
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.

2894
joachim
3 months ago
M
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

5912
David.Nguyen
Luminary
3 months ago
D
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? 

650
D
4 months ago
c​hris
c​hrisInfrared
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.

4995
Sean Turner
Ultraviolet
4 months ago
s.ng
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?

180
s.ng
5 months ago
Hans-Jürgen Feige
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

1889
David.Nguyen
Luminary
5 months ago
Borui
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.

301
Benjamin.N
5 months ago
Borui
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
Borui
5 months ago
I
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

1102
I
5 months ago
Travis3
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!

603
Travis3
5 months ago
Xianglei
XiangleiMonochrome
posted in ZOS-API
API_Layout_plot_Python

API support for the Cross-Section, 3D Layout, and Shaded Models is added to the OpticStudio API.  The support allow users to change the settings via the API and retrieve a static image.  Layouts in both sequential and non-sequential mode are supported. Some toolbar buttons, such as automatically setting camera viewpoints, will also be accessible via the API. Please download the following Python Standalone codes, including:PythonStandaloneApplication_SEQ_layout.py       (sequential mode and export 2D cross-section) TheSystem.Tools.OpenCrossSectionExport()   # the core command  PythonStandaloneApplication_SEQ_3DViewer.py (sequential mode and export 3D viewer) TheSystem.Tools.Open3DViewerExport() PythonStandaloneApplication_SEQ_ShadedModel.py (sequential mode and export shaded model) TheSystem.Tools.OpenShadedModelExport() PythonStandaloneApplication_NSC_3D.py              (non-sequential mode and export 3D layout) TheSystem.Tools.OpenNSC3DLayoutExport() PythonStandaloneApplication_NS

59320
Brian
5 months ago
Yang.Yongtao
Fully Spectral
Yang.YongtaoFully Spectral
asked in ZOS-API
Python _PythonStandaloneApplication object has no attribute 'TheApplication'

Hi Zemaxers I am trying the python sample code of ZOS-API (as attached below). But it does not work at the first step.https://support.zemax.com/hc/en-us/articles/4403605141267-Generate-the-executable-in-Python-for-ZOS-API-User-Extensions The error shows as belowAttributeError: 'PythonStandaloneApplication' object has no attribute 'TheApplication'(after checking the zemax install root , I guess it has something with 'TheApplication'  attribute) Environmentpython 3.10PyCharm Community Edition 2022.1Ansys Zemax OpticStudio 2024 R1.03pythonnet version 3.0.3Attached code  What I have done:checked the address below, it is correct Could you give me some advice on this issue? Thank you YANG 

1784
Yang.Yongtao
Fully Spectral
5 months ago
Julia
Fully Spectral
JuliaFully Spectral
posted in ZOS-API
ZOS-API- How to use sequential ray tracing tools?

to_surf = TheSystem.LDE.NumberOfSurfaces-1; Ex=0;Ey=1;phaX=0;phaY=90;waveNumber=2;Hx=0;Hy=0;Px=0;Py=1; raytrace = TheSystem.Tools.OpenBatchRayTrace(); [success,errCode,exro,exio,eyro,eyio,ezro,ezio,intensity]=raytrace.SingleRayNormPol(ZOSAPI.Tools.RayTrace.RaysType.Real,Ex,Ey,phaX,phaY, to_surf, waveNumber,Hx,Hy,Px,Py,0,0,0,0,0,0); Open the batch ray trace tool Create polarized real raytracing in which a single ray with normalized pupil coordinates will be added waveNumber=2;Hx=0;Hy=0.5;Px=0;Py=0.5; raytrace = TheSystem.Tools.OpenBatchRayTrace(); [success,X,Y,Z,L,M,N]=raytrace.GetDirectFieldCoordinates(2,ZOSAPI.Tools.RayTrace.RaysType.Real,Hx,Hy,Px,Py) Open the batch ray trace tool Get direct field coordinates with input normalized field and pupil coordinates raytrace = TheSystem.Tools.OpenBatchRayTrace(); max_rays = 4; pwav = 0; for a = 1:TheSystem.SystemData.Wavelengths.NumberOfWavelengths if TheSystem.SystemData.Wavelengths.GetWavelength(a).IsPrimary == 1; p

4961
Hans-Jürgen Feige
5 months ago
Allie
Zemax Staff
AllieZemax Staff
asked in ZOS-API
How can I pull Peak Irradiance or Total Hits from the Detector Viewer analysis in the API?

Within the API, we are able to quickly pull Peak Irradiance, Total Power, and Total Hits by using the property GetDetectorData as described in the forum post 'Methods for extracting detector data through the API.' However, this property will not take into account an applied ZRD file. We can apply a ZRD file to a Detector Viewer window, so is there a way to extract the same information from there?

140713
A
Ultraviolet
5 months ago
Y
Yoshikazu.KawamataInfrared
asked in ZOS-API
How to save detector viewer graphical plot into image file by ZOS-API ?

Hello, I would like to save graphical plot in detector viewer into a picture file by ZOS-API.I looked at some similar questions in community but most of those tell that “get numerical data and draw a plot using the numerical data” or “that feature is in request” 1 year go.So, I am wondering if that feature is implemented already or not.To me, GUI already has that feature and hence it seems that if there is a function in ZOS-API  to call that feature in GUI, it gets the job done.  Does anybody know that? RegardsKazu 

11788
Amy Entin
5 months ago
A
Ultraviolet
Aleksandr.MakarovUltraviolet
asked in ZOS-API
How use DoNotDrawObject?

How use DoNotDrawObject?I trued like below but seems it wrongObject = TheNCE.GetObjectAt(obj)Object.TypeData.RaysIgnoreObject = ZOSAPI.Editors.NCE.RaysIgnoreObjectType.NeverObject.TypeData.DoNotDrawObject = True 

281
David.Nguyen
Luminary
6 months ago

Badge winners

Show all badges
Community Posting GuidelinesCookie settings


Zemax Community

Need more help?

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


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



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