Knowledgebase
User Groups

Community
Programming OpticStudio
ZOS-API

ZOS-API

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

209 Topics
606 Replies

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

209 Topics

Recently active

Most replies Most views Newest first

Ramya

asked in ZOS-API

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

9 minutes 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.

4 hours ago

joshdfreemanUltraviolet

asked in ZOS-API

Access coating properties in ZOS-API?

Is there a way to access the properties of a coating in the ZOS-API? The article below shows how to access the name of the coating, but does not show how to get the properties of the coating.I’m not finding any handles that give the actual coating information. Thanks!

1 day ago

AllieZemax Staff

posted in ZOS-API

Call a parameter by its name in the ZOS-API

When dealing with non-Standard surface types, you typically have access to extra parameters that are specific to that surface. For example, the Coordinate Break surface provides inputs for Decenter X, Decenter Y, etc. Coordinate Break surface type with the extra data parameters highlightedTo access these parameters in the API, our sample code offers two options:Access a parameter based on the parameter number. A typical command for this may look like the following: decenterX = TheSystem.LDE.GetSurfaceAt(1).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par1).DoubleValue; Access a parameter based on its column number. A typical command for this may look like the following: decenterX = TheSystem.LDE.GetSurfaceAt(1).GetCellAt(12).DoubleValue;In both of these cases, you will need to have prior knowledge of the location in the LDE of the parameters you want to change. Or you will need to query the “Header” of the column you’re working with to confirm the parameter is correct. There is a th

3 days ago

Charlotte.BondSingle Emitter

asked in ZOS-API

How to acces airy disc in ZOS-API

Hi,I’m using ZOS-API in python to analyse PSFs using the Huygens and FFT methods. Is there a way to extract the airy radius and return it to Python?

9 days ago

Eric.AwSingle Emitter

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

11 days ago

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?

13 days ago

cloMonochrome

asked in ZOS-API

How to ignore Object in API ?

Hello to all,I read the topic about : “how to ignore Surface in API”. I tried to do something similar for non-sequential object but it is not working. surf4 = TheSystem.NCE.GetObjectAt(4) surf4.TypeData.IgnoreObjects = 1First TypeData.IgnoreObjects want a string but I don’t know what to write. Thank you very much in advance fir your answer. Clotilde

17 days ago

John.HygelundUltraviolet

asked in ZOS-API

how to Ignore Surface in API

I’m still new to the API and having trouble getting and setting the “Ignore this surface” via the API.I’m working in Matlab and trying:TheLDE.GetSurfaceAt(4).GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.ILDETypeData.IgnoreSurface)but get the error:The property 'IgnoreSurface' in class 'ZOSAPI.Editors.LDE.ILDETypeData' must be accessed from a class instance because it is not a Constant property. Can someone point me in the right direction?Thank you,John

17 days ago

SahilZemax Staff

posted in ZOS-API

Get and Set Folders in Project Preferences of OpticStudio from ZOS API

We can get and set the folders in Project Preferences in OpticStudio using ZOS API.Save the Project Preferences Configuration(.CFG) file in Zemax LLC\Documents\Zemax\Configs or you can use default Project Prefrences configuration file OpticStudio Save Project Prefrences Configuration file Add the following code for connecting saved configuration file Python Code print('\n===PreferencesFile===\n') cfgFile = r"ZemaxLLC\Documents\Zemax\Configs\Project_Prefferences_test.CFG" print(os.path.exists(cfgFile)) if (cfgFile): self.TheConnection.PreferencesFile = cfgFile else: print('Default OpticStudio.CFG preferences used\n') MATLAB Code: fprintf('\n===PreferencesFile===\n') cfgFile = 'C:\Users\Documents\Zemax\Configs\Project_Pre

17 days ago

Sandrine AuriolZemax Staff

posted in ZOS-API

NSC Surface Sag using ZOS-API

The NSC Surface Sag (available in Ansys Zemax OpticStudio 2023 R1 and OpticStudio 23.1) is fully implemented in ZOS-API. It means that you can open that analysis, define the settings and get the results. It makes it easy to convert an object face into a Grid Sag Surface.Here is an example of a Matlab code:TheSystem=TheApplication.PrimarySystem;MyNSCSag = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.NSCSurfaceSag)MyNSCSag.HasAnalysisSpecificSettingsreturns TrueThe settings are:MyNSCSag.ApplyAndWaitForCompletionMyNSCSag_results = MyNSCSag.GetResultsreturns a DataGrid containing the sag pointsSag = MyNSCSag_results.GetDataGrid(0).Values.double;

21 days ago

OranMonochrome

asked in ZOS-API

AllieZemax Staff

posted in ZOS-API

Single Ray Trace in the ZOS-API

In the last few weeks, I have received questions regarding how we can use the ZOS-API to pull single ray trace information. For convenience, I will post my answers here in a single post. I pulled together three different methods for extracting single ray trace data. Below I will list the methods with sample code in Python and Mathematica. I’m happy to provide samples in other languages if needed! If you have other methods you use for this kind of analysis, feel free to add them as a reply! Method 1 - Use the Single Ray Trace analysisThis method can be used to pull the results of the Single Ray Trace analysis window. The benefit of this method is that the results are pulled for all surfaces at once. The drawback of this method is that the data is provided in text form. The output is a TXT file which must be parsed back into the program you are using. This is discussed in a bit more detail here: How to set RayInfo.Vignetted in ZOS-API_Python Python########### Define the constants across

1 month ago

Leonid.PascarMonochrome

asked in ZOS-API

retrieving pop beam via ZOS_API Python

Hi, I try to retrieve the output POP field distrubution via python. I looked in the help at IAS_PhysicalOpticsPropagation and couldn't find direct way to do it. I know I can manually save ZBF files and then load, but I need a script as I change parameters and want to retrieve the output beam. How would you advise to do so?   Thanks, Leonid

1 month ago

Hans MartinssonMonochrome

asked in ZOS-API

ZOS-API supporting Python 3.10 and python.Net 3.0?

Hi,The other day python.Net version 3.0.0, supporting Python 3.10, was released. Hence, I’m curious to hear when we can expect ZOS-API to support this very much appreciated combo.Best regards,Hans

1 month ago

BarakaMonochrome

asked in ZOS-API

Specifying a UDA file to a Surface Aperture as an Aperture file using Python

Hello Everyone,I am trying to change the Aperture file of a surface aperture using python. All I could do is to change the Aperture type to User Aperture but the Aperture file is not specifyed.This is the code I am usingfilename= ‘HP.uda’User_Aper =TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.UserAperture)User_Aper.ApertureFile = filenameSurface_3.ApertureData.ChangeApertureTypeSettings(User_Aper) Using Matlab, it is working perfectly using the same code and also, it works that I can change the Aperture file manually in zemax so this means the aperture uda file is at the correct location with the correct content.I also tried to change the filename string to the full directory of the uda file and it is not working too. [Mod note: moved to more appropriate forum for ZOS-API related discussions.]

1 month ago

DavidEn-Lightened

posted in ZOS-API

Accessing filtered detector data with ZOSAPI

I would like to access, through ZOSAPI, detector data which has been fitered by a filter string. I know how to access detector data through ZOSPI. And it is of course possible to view filtered data in OpticStudio by saving a trace to a ZRD file and specifiying that as the database for a detector viewer. The filter string can be applied as the ZRD is saved, or applied in the settings of the detector viewer. But I would ike to access the filtered data as it is viewed in the detector viewer, rather than the unfiltered data. Is this possible? I am actually using ZOSAPI from Mathematica, but an answer related to Python or C++ would be useful.  Kind regards, David,

1 month ago

AmitInfrared

asked in ZOS-API

Performing DOE with tilt and decenter while extracting image simulation results

Hello Everyone, I want to run a DOE with ZEMAX where the idea is to generate synthetic data by running image simulations while changing position of lenses (adding decenter and tilt to individual lens elements in a lens stack).I want have a bunch of tilt and decenter scenarios and would like to automate the process via API.Is there a sample code that I could use for this application? Is there a sample code to automate image simulations and save resulting images in general that I could modify to suit my needs?All suggestions are appreciated :) Best regards,Amit

2 months ago

taehyun.kimSingle Emitter

asked in ZOS-API

How to modify Settings of Geometric Bitmap Image Analysis?

I’m using ZOS-API by matlab.I’ve tried to run Geometric Bitmap Image Analysis and succeed Running Analysis by using Interactive Extension.GeoBitIA = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.GeometricBitmapImageAnalysis);I want to control some setting by using matlab. However I do not find right method to modify Settings.Do me a favor to do that things.Thank you.

2 months ago

Hans-Jürgen FeigeMonochrome

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

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

2 months ago

EK88Single Emitter

asked in ZOS-API

set intensity threshold on split NSC rays using Matlab

Hi, I am using Matlab to run zemax simulation. could you tell me how to set up the intensity threshold when I am using the “RayTrace.SplitNSCRays = true”. Thanks a lot.

2 months ago

joshdfreemanUltraviolet

asked in ZOS-API

Path Analysis Loss of Power and Atmospheric (Air) Losses

Hi,I’m using the Path Analysis feature (run from Matlab) to analyze how the light is going through a system. Path Analysis is a great feature!What I’m noticing is that if I add up the number of rays in the path analysis rows, they equal to the number of rays in the ray trace / and in the layout. However, if I add up the powers in the rows, there is a total loss of about 1.8%. I currently do not have any coatings set on the various components (struggling to get that to work for some unknown reason or the other). Just mirror/reflector and absorbers.Is there an atmospheric loss built into Zemax due to the air the light passes through? I tried setting the air pressure to zero in the System Explorer/Environment to try and simulate a vacuum, and it didn’t change anything. And, if there are air losses, I’d like to control them or set them to zero and calculate the losses numerically. Thanks!

2 months ago

Page 1 / 9

Badge winners

Mike.Joneshas earned the badge Visibly Un-Polarized
Alessandra Crocehas earned the badge Allow me to introduce myself
Florent.Basinhas earned the badge OpticsAcademy Certified: Tolerancing
Bianca.Jugureanuhas earned the badge OpticsAcademy Certified: Tolerancing
Vaidas.Nagreckishas earned the badge OpticsAcademy Certified: Tolerancing

Show all badges

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

Redirecting to the Zemax Community...

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

Username or e-mail

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.

Company

About Zemax
Team
Events
Careers
Contact Us

Products

OpticStudio
OpticsBuilder
OpticsViewer

Zemax Community

Manage email notification
Private Message Inbox
My Subscriptions
Posting guidelines

Need more help?

Knowledgebase
OpticsAcademy
Software Downloads
Consultants
Open a Case