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

SangyeolSingle Emitter

asked in ZOS-API

ZOS API in C# to get FftMtf returns null output

I am following the example (CSharpStandalone_04_pull_data_from_FFTMTF.cs) to get FFT MTF data like below; newWin.ApplyAndWaitForCompletion();IAR_ newWin_Results = newWin.GetResults();It works fine in my computer. But the same copy returns ‘null results’ from other’s computer.No idea where I should look into for debugging.Appreciate your kind advice.

873

1 year ago

Benjamin.NVisible

asked in ZOS-API

Access tilt/decenter tool of sequential mode via ZOSAPI

Dear community, I would like to access the tilt/decenter tool from the sequential surface editor via the ZOSAPI interface. In particular, I would like to do so with Python. I searched the documentation but I could not find anything about this tool. Other tools, such as the conversions between global and local coordinates area acessible via ZOSAPI. Did I miss something or is the tilt/decenter tool not yet integrated in ZOSAPI? If so, are there plans to do so?Best regardsBenjamin

1073

1 year ago

MichaelHLuminary

posted in ZOS-API

PythonNET 3.x is "Fixed"

Hi Everyone (+ @Allie & @Sandrine Auriol),There is nothing inherently wrong with the modern version of PythonNET but there were some changes that the PythonNET team made to inheritance. PythonNET is now more in line with C# where you have to use the proper static variable type (my best guess is this is better handle multi-threading and easier integration of Python into C# using the GIL...the opposite of what we’re trying to do with the ZOS-API).In PythonNET 3.x, when a method returns a interface with inheritance, the returned variable becomes a type of the parent interface (not the child interface). For example, if you use the GetSettings() method for an analysis window, all settings have IAS_ parent interface and a child interface with the actual settings for the analysis window. In previous versions of PythonNET, the returned variable was dynamically typed and PythonNET attempted an implicit conversion from the parent interface to the child interface. So the following lines o

15025

1 year ago

MichaelHLuminary

asked in ZOS-API

Explode CAD via ZOS-API

Maybe I’m missing something, but is there a way to take a CAD Part as an assembly and run the NCE Explode CAD Part via the ZOS-API? The only “explode” results I get when searching the Help are for the Explode? cell which is only a {get;} letting you know if the object was exploded.If this doesn’t exist yet in the API, then Zemax take note, this is another “almost there” situation. For sequential, all the RunTool_ implementations for the LDE are a single line in the ZOS-API source code so getting a NCE.RunTool_ExplodeCAD should be less than 1 day effort for the dev team. Please complete all the “tools” that live in the toolbar of each editor.

992

1 year ago

AllieZemax Staff

asked in ZOS-API

Methods for extracting detector data through the API

How can I extract detector data using the API? And how can I be sure I'm using the correct settings?

26979

1 year ago

Shih-Heng.LinMonochrome

asked in ZOS-API

How to change 3D layout properties via ZOSAPI

Hi,I am trying to change 3D layout properties via MATLAB ZOSAPI. I’ve checked help and googled and didn’t find the answer. For example, how could I change “Number Of Rays”, “Ray Pattern”, Rotation and all other settings via ZOSAPI. Also, is it possible to change line thickness via ZOSAPI??

2144

1 year ago

JuliaFully Spectral

posted in ZOS-API

Setting up a Virtual Environment in PyCharm for your project

When developing a project in Python, it is important to have a clean and isolated environment to avoid conflicts with other packages or dependencies. This is where virtual environments come in handy. In this guide, I will show you how to set up a virtual environment for a project in PyCharm.Step 1: Install Virtualenv in Command Promptpip install virtualenvStep 2: Create a new PyCharm projectCreate a new PyCharm project through File > New Project.check the right bottom interpreter is the one you created just now, in this case(zos_venv)Step 3: Configure the new virtual environmentOpen the terminal by clicking on the Terminal tab at the bottom of the screen. To activate the virtual environment, navigate to the location of the virtual environment in the terminal using the cd command. Once you are in the correct directory, you can activate the virtual environmentcd .\zos_venvcd .\Scripts.\activateStep 4: Configure the new virtual environmentThe environment name (in this case zos_venv) a

59380

1 year ago

InHuraStudent

asked in ZOS-API

Python ZOS-API: can't find '__main__' module in '/Users/xxxx/Documents/ZEMAX/ZOS-API'

I am trying to run some of the Python ZOS-API Standalone Application examples using Spyder, but running it in an external system terminal. I get the following error message, but I don’t understand what is causing this:/Users/xxxx/miniconda3/bin/python: can't find '__main__' module in '/Users/xxxx/Documents/ZEMAX/ZOS-API'I am very new to using ZOS-API, so any pointers would be greatly appreciated!

570

1 year ago

Stephen.ToddSingle Emitter

asked in ZOS-API

Reading surface comments in OpticStudio 23.1

I am trying to update and use a set of Python scripts. The code used to retrieve surface comments from the Zemax model no longer seems to work in OpticStudio 23.1. This code was all written several years ago, so uses the older win32com library rather than the newer preferred .NET approach, but it does still work on another computer running OpticStudio 22.1, so has something changed in the API definitions over the past year?surface_name = system.LDE.GetSurfaceAt(k).Commentdoesn’t return a string, but <COMObject Comment>, and I can’t work out how to actually get the string out of this.The script works if I replace this line with surface_name = str(system.LDE.GetSurfaceAt(k).GetSurfaceCell(1))While this fixes the problem, it’s obviously less readable, and I’m not sure why this change is needed. Any suggestions on why the original code isn’t working any more?

1851

1 year ago

Leon0228zzStudent

asked in ZOS-API

如何用zos-api，將IncidentAnglevsImageHeight的分析數據結果輸出為CSV並繪製成圖表

想問在ZOS-API中，如何設定IncidentAnglevsImageHeight的FieldDensity的值與Wavelength?是如下編寫嗎TheAnalyses = TheSystem.AnalysesIAIH=TheAnalyses.New_Analysis(constants.AnalysisIDM_IncidentAnglevsImageHeight)IAIH_Set = IAIH.GetSettings()IAIH_SetCast = CastTo(IAIH_Set,'IAS_')IAIH_SetCast.FieldDensity=15IAIH_SetCast.Wavelength=3另外，參考過example04.pull_data_from_FFTMTF的方式，該如何像範例04，取DataSeries值並匯出?感謝

912

1 year ago

SahilVisible

posted in ZOS-API

Only Pythonnet 2.5.2 is compatible with python 3.8.3 to python 3.8.5.

Hello,Just like Python Version, we also have Pythonnet which is bridge between Python and .NET. I have experienced many customer queries of having compatibility issue with Python 3.8. As 3.8 is recommended Python version for connecting with ZOS API Python but still the bridge (Pythonnet) needs to be compatible with Python version. Then only we can connect and run ZOS API properly. Now a days Python editors like PyCharm, Spyder, Jupyter etc. recommending Pythonnet 3.0.1 for Python 3.8.3 to Python 3.8.5. Pythonnet 3.0.1 is not fully compatible with Python Version 3.8.3 to Python 3.8.5. If you have installed this version uninstall Pythonnet 3.0.1 and reinstall pythonnet2.5.2 Version using the command in your console.pip install pythonnet==2.5.2If not, you will receive the error message “Failed to initialize pythonnet”.ThanksSahil

9684

1 year ago

alexander_dumontInfrared

asked in ZOS-API

When running batch ray trace inside a loop in C#, ReadNextResultFull fails after first iteration

Hello fellow Zemax ZOS-API users! I’m getting my hands dirty with the ZOS-API, and I’m currently running a C# code to allow me to use batch ray trace. This reproduces my input object onto my output image plane very nicely. However, I then tried to put this into a for loop over the range of thicknesses I want to conisder for one eleemnt in my system. I’m using directpol, and the addrays and readnextresults and ReadNextResultFull, and the method runs perfectly fine on the first lop iteration, but then fails for the concurrent lops. I tried to run the program by putting the loop inside the C# code and by calling it from an external program (MATLAB using system command) but in both cases, the success line fails after the first iteration, even though in MATLAB I am asking for a brand new instance of the C# code. to run. So I am stuck running it one parameter at a time, which is not what I want to do. Anyone else facing this problem? Here is a copy of the relevant part of my C# file:var z_o

1997

1 year ago

adam2877Single Emitter

asked in ZOS-API

Change wavelength in Geometric Image Analysis

Hi All,I’m trying to automate some Geometric Image Analysis tasks but am struggling to change the wavelength in geometric image analysis.python 3.10.9Optics Studio 23.1 I’ve set up the image analysis I want in the project (Cross X, Field size, image size, pixels etc). I’m trying now to loop over wavelengths and save the results. My problem is I can’t figure out how to change the wavelength number within ZOS-API. As far as I can tell the IMA keywords don’t have Wavelength. Thanks for any help!from the help of ModifySettings keywords Geometric Image Analysis IMA_FIELD: The field size. IMA_IMAGESIZE: The image size. IMA_IMANAME: The image file name. IMA_KRAYS: The number of rays x 1000. IMA_NA: The numerical aperture. IMA_OUTNAME: The output file name. IMA_SURFACE: The surface number. IMA_PIXELS: The number of pixels. example code:geo = TheSystem.Analyses.New_GeometricImageAnalysis()geo_set = geo.GetSettings()cfgfile = os.path.join(pth,'geo_an_sett.cfg')geo_s

2674

1 year ago

sh0815kangSingle Emitter

asked in ZOS-API

Wavefront map to point spread function using Matlab

I'm currently working with wavefront and psf.I'm trying to convert a wavefront map extracted from opticstudio to a psf using a rather complicated but accurate numerical method, not a linear approximation method, but I'm not getting the right results. I am attaching the matlab code I am currently using.Please let me know if there are any fixes.Thanks. CODE:function psf_out=wavefront2psf(wvf, center_wvf, data_space_wvf, lambda, film_Dist, rect, data_space_psf) % wvf: wavefront map of n x n size from opticsutdio% center_wvf: center coordinate of the wavefront map% data_space_wvf: data space of the wavefront map% lambda: the wavelength% film_Dist: distance between film and the last lens% rect : point spread are estimated within the rectangle% data_space_psf: data space of the point spread function dr=1; min_dA=2; cx=center_wvf(1); cy=center_wvf(2); rr=[]; th=[]; RR=0; TH=0; AA=pi; [h_wf, ~]=size(wvf); for p=1:dr:((h_wf/2)-3) r=p;

1690

1 year ago

Andy.KruseSingle Emitter

asked in ZOS-API

Issues with ZOS-API

I’m using a grin 5 surface using a material from an edited SGRIN.dat file and getting errors upon loading it in a Python standalone.If I open the file in a regular OpticStudio window, there is no error message and it works perfectly. However, if I try to load it in Python, the grin 5 surface is causing some issues. In Python, I will get the status "Can't find glass *CAF2* in catalog!" (CAF2 is the first glass after the GRIN 5 surface). If I save the file in Python and open it in OpticStudio, then it will throw the error “Can’t find GRIN 5 glass *customglassname* in SGRIN.DAT!”. This can be resolved if I change the GRIN 5 material to air, which then triggers a glass not found error for every glass in the rest of the system. This is because in the material catalogues, all of the catalogues I had been using have somehow been removed from “Catalogues to use”. After fixing that up, if I change the GRIN 5 material back to what it was originally, there is no error and it works as it did befor

820

1 year ago

Michael.PriceSingle Emitter

posted in ZOS-API

Tolerance Analysis and Matlab

I'm running tolerance analysis using ZOS-API-Matlab. How do I pull the tolerance data such as histogram, yield, etc? And how can I run my own tolerance script using Matlab?

5052

1 year ago

Raphael.ProuxMonochrome

asked in ZOS-API

ZOS-API FftMtf analysis Wavelength bug on 23.1

Hello, Since I updated to 23.1, I have an issue with FftMtf analysis settings, which has no “Wavelength” attribute. You can see the error on the screenshot. The test script I am showing is a modified MTF ZOS-API example (PythonStandalone_04_pull_data_from_FFTMTF.py). This sample works ok by itself but fails if I try to add line 189 in the screenshot.Error message when trying to access FftMtf analysis settings.WavelengthI tried to revert to 22.3 but it did not help. I am not 100% sure it is linked to the update.Any ideas?

874

1 year ago

ISHFMMonochrome

asked in ZOS-API

MODIFYSETTINGS for Interferograms

When getting a text file with Zemax-generated data (e.g. a wavefront map) using a ZPL macro, one could specify certain settings such as sampling resolution. While OpticStudio User Manual gives these settings for wavefront map, surface sag, Huygens PSF, etc. in the MODIFYSETTINGS section, it does not have anything given for Interferograms. If I have a multi-configuration file, how am I supposed to specify to obtain interferogram between, say, configuration 2 and 3? How should I specify the sampling resolution? Is there a way to specify these settings at all?

1331

1 year ago

Mark.KeeversSingle Emitter

asked in ZOS-API

Modifying Flux vs Wavelength settings with ZOS-API

Hi,I’m trying to obtain data from the ‘Flux vs Wavelength’ analysis tool while interacting through the ZOS-API (MATLAB). Setting a desired detector and wavelength bins then saving text output of flux by wavelength bin on that detector is my goal. There doesn't seem to be any direct way to modify these settings through the ZOS API, I have checked with the ‘HasAnalysisSpecificSettingsTool’. So I am trying to use the ‘ModifySettings’ route to change the configuration file (string code FVW). However, I cannot find the type codes for Flux vs Wavelength in the OpticStudio Manual or on any other help or discussion areas! I can do everything I required through the GUI, but not through ZOS API, which I am using to automate analysis. This is proving to be a large roadblock for our work.Could someone please let me know if what I am wanting to perform is possible and what the type codes for the Flux vs Wavelength analysis are?Or even better if there is a direct method to modify the settings throu

1262

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

1444

1 year ago

Paul.ManhartMonochrome

asked in ZOS-API

writing ZRD2MAT files

Hey everyone. I have a NSC model that contains two sets of CPC’s and a Mersenne relay. My source is an array of conical wavefronts to mimic Cerenkov radiation. I need to trace a lot of rays through the system to the detector to look at the temporal dispersion of rays vs. time (or more correctly, Power vs. Time). So I’m writing my ray trace to a ZDR file. But when I convert it to text, I can’t get all the rays because the file is too large.So I want to try using the ZRD2MAT function that writes the ZRD data to a Matlab.m file.I have no idea how to do this. Currently, I’ve been creating a lot of text files with the ZRD info in them and reading and summing all the Optical Path data to get the total OP from source to detector. then, catching the last Intensity value for that ray and storing the info in a 2D array in Mathematica. It’s a PITA! I’d rather do it in Matlab.What path do I use if Matlab is in one folder and the lens is in another folder?anyone who can help me will get 100 Atta-Bo

1752

1 year ago

Dekang ChenSingle Emitter

asked in ZOS-API

How do I reload all surfaces by using Matlab API?

I notice these are “Reload Surface” and “Reload All Surfaces” tools on the top of the LDE window. Does anyone know how do we access this tool in Matlab API? I did not find such a function in ZOS-API. One similar function is “Reload Object” but it doesn’t work for “Reload Surface”.The reason why I need this function is I am simulating gradient index lenses whose property is read from an external file named “GRADIENT_9.DAT”. After I change the material property in this external “.DAT” file, I need to Reload All Surfaces to update the material.If anyone has suggestions on how to do this, I would appreciate it a lot.

1084

1 year ago

Jaren.AshcraftInfrared

asked in ZOS-API

import zosapi crashes jupyter kernel, how can I fix it?

Hello!I’m attempting to use the ZOS-API in Python (3.8.13). I’ve been running my code from the terminal window and have successfully executed a batch ray trace. I’m working on something that could benefit from using an interactive environment, so I am trying to use a Jupyter notebook or interactive cells in VS code.When I try to run <import zosapi> the kernel dies immediately. One of the errors thrown is“Unhandled Exeption: System.IO.FileNotFoundException: Could not load file or assembly ‘ZOSAPI_Interfaces, Version=1.0.0.0, Culture=Neutral, PublicKeyToken=null’ or one of its dependencies. The system cannot find the file specified”Am I missing a ZOSAPI_Interfaces file? Has anyone encountered this error before?Thanks,Jaren

1253

1 year ago

Eric.AwMonochrome

asked in ZOS-API

Unable to connect Python (Spyder) to Zemax

Hi , I am currently trying to use python (Spyder) to connect with Zemax. But I am getting the errors below (shown in the picture below) . I can’t find any solution. I tried to use another python version - 3.7.0 , but still same error. Both standalone application and interactive extension result in same error messages. Appreciate if anyone could give me some guidance. Thank you

Ray trace settings using ZOS API in python

Hi all,I have been using ZOS-API Pythonnet to perform a ray trace and save the ray trace data as text files. The following program snippet worked perfectly fine up until a few months ago. Now, when I run the same code, it does the ray trace and saves the text file without changing any of the settings.import ZOSAPI;TheSystem = TheApplication.PrimarySystem;teleFile=('T_file.zmx')TheSystem.LoadFile(teleFile,False);Systemdata=TheSystem.SystemDataTheAnalyses=TheSystem.Analyses;X, Y = np.round(np.mgrid[(-1):(1):100j, (-1):(1):100j],3)positions = np.vstack([X.ravel(), Y.ravel()])pos=np.transpose(positions)px=pos[:,0]py=pos[:,1]max_rays=len(px)newWin=TheAnalyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.RayTrace);newWin_Settings=newWin.GetSettings();Field_1 = Systemdata.Fields.GetField(1)Field_1.X=0Field_1.Y=0path='\RT_trial'for i in range(max_rays): newWin_Settings.Px=px[i]; newWin_Settings.Py=py[i]; #newWin_Settings.Wavelength.SetWavelengthNumber(1); #newWin_Settings.Field.SetFiel

2752

1 year ago

Page 6 / 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.).

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