Knowledgebase
User Groups

Community
Programming OpticStudio
ZOS-API

ZOS-API

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

153 Topics
442 Replies

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

153 Topics

Recently active

Most replies Most views Newest first

Chris.SvecMonochrome

asked in ZOS-API

Simulink with ZOS-API

I have constructed successful interfaces with the ZOS-API using MATLAB, but there’s a larger system model that I’m now integrating into Simulink and I’m running into import errors because Simulink doesn’t seem to like the data structure. Has anyone tackled Simulink interfacing?

6 days ago

Mark.JunkerSingle Emitter

asked in ZOS-API

Mo.Student

asked in ZOS-API

How to retrieve specific data from Physical Optics Propagation with API?

Hey,i want to retrieve data from POP with the API (in python). As far as i got i understand that the pop_analysis.GetResult() is delivering a matrix, like the one you get from the text tab in POP. So far so good. But I don’t know how to get the index for peak irradiance or any other certain value. So, can anybody help me to retrieve the peak irradiance value from that matrix? I’d really appreciate any help that would lead me to a solution. There seem to be some options like “IndexOf”, “FindIndex”, but I don’t know how to use them. My code for that section so far:pop_analysis = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.PhysicalOpticsPropagation)pop_analysis.ApplyAndWaitForCompletion()pop_results = pop_analysis.GetResults()matrixData = pop_results.GetDataGrid(0).ValuesThanks,Mo

19 days ago

Jozef.PulkoInfrared

asked in ZOS-API

Wolfram Mathematica NSCShadedModel

Dear comunity. What is the syntax to open a shaded model from Wolfram Mathematica? analysis = TheSystem@Analyses@NewUAnalysis["ZOSAPI.Analysis.AnalysisIDM.NSCShadedModel"] returns NET::methodargs: Improper arguments supplied for method named NewUAnalysis. Thanx and BR,Jozef

21 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!

22 days ago

Yasemin.DemirhanSingle Emitter

asked in ZOS-API

Zemax Interferogram Data

How to read Zemax interferogram data in matlab ?

28 days ago

islandopticsMonochrome

asked in ZOS-API

How to extract universal plot 1D analyses data using MATLAB API

Hello, I saw a coupling topics on this but don’t see a real solution.Using the MATLAB API I can load a file and create a universal 1 D plot and change config settings. When I open the zmx file after I can see that the settings were applied correctly and the plot looks good. But, I cannot figure out how the access the plot data from the MATLAB API. I’m using: UnivPlot = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.UniversalPlot1D);UnivPlot_Settings = UnivPlot.GetSettings();fprintf('Universal Plot has analysis specific settings? %i\n', UnivPlot.HasAnalysisSpecificSettings)% Above is False; Universal Plot Settings must be changed via ModifySettings (changing a config (.cfg) file)cfg = System.String.Concat(TheApplication.ZemaxDataDir, '\Configs\UNI.CFG');UnivPlot_Settings.Save(); % Create new .cfg file, named "UNI.CFG" in \Configs\ folder% Change universal plot settingsUnivPlot_Settings.ModifySettings(cfg, 'UN1_CATEGORY', num2str(0));UnivPlot_Settings.ModifySettings(cfg, 'U

1 month ago

Mariangela.BaggioMonochrome

posted in ZOS-API

NS 3d Layout in ZOS-API

Hi, I would like to open the non-sequential 3d layout in MATLAB. Basically, I would like to customize the 3d viewer so to visualize rays belonging to different paths in different colors. Is there a way to open it via a MATLAB figure? Best, Mariangela    

1 month ago

Alaeddine.YacoubStudent

asked in ZOS-API

Connect Python API in Windows Virtual Machine

Hi everyone, Since I have Ubuntu as a primary OS, I installed OpticStudio in a Windows Guest Virtual Machine. Is there any possibility to connect ZOS-API to my runnig Python scripts on Ubuntu ? Thank you very much Greetings, Alaeddine Yacoub

1 month ago

AminRMonochrome

asked in ZOS-API

Getting the row's Value column in MFE using ZOS-API

HiI am learning how to build the MFE with ZOS-API and for that I am creating a simple MFE. I know that Target and Weight are accessible through Operand.WeightOperand.Target But calling the Value column using Operand.Value returns 0. Any idea what I am doing wrong? Thanks

1 month ago

Benoit.BorguetMonochrome

asked in ZOS-API

GetSag no longer working

Hi,I’ve been building over the years a series of python based-tools that use ZOSAPI framework in order to automatize repetitive jobs. However, the reccurent changes in the API causes regular failures in these scripts. Lately I’ve been trying to use a simple piece of code that gets the sag from the surfaces and find the following failure (where ZemaxLDE is an instance of the TheSystem.LDE, and xi, yj are points where I want my sag to be returned): tmp = ZemaxLDE.GetSag(index, xi, yj) File "C:\Python27\lib\site-packages\win32com\gen_py\EA433010-2BAC-43C4-857C-7AEAC4A8CCE0x0x1x0\ILensDataEditor.py", line 103, in GetSag , X, Y, sag, alternateSag) File "C:\Python27\lib\site-packages\win32com\client\__init__.py", line 467, in _ApplyTypes_ self._oleobj_.InvokeTypes(dispid, 0, wFlags, retType, argTypes, *args),pywintypes.com_error: (-2147352562, 'Nombre de param\xe8tres non valide.', None, None) Could you please tell me what could have changed (I’m still working with Zemax 21.x beca

1 month ago

sunny.howardStudent

posted in ZOS-API

ZOS-API Local optimization crashing

Hi!I am experiencing a bug when running local optimisations via the ZOS-API in python. I am using interactive extension. Example of the code is:LocalOpt = TheSystem.Tools.OpenLocalOptimization()LocalOpt.Algorithm = ZOSAPI.Tools.Optimization.OptimizationAlgorithm.DampedLeastSquaresLocalOpt.Cycles = ZOSAPI.Tools.Optimization.OptimizationCycles.Fixed_50_CyclesLocalOpt.NumberOfCores = 8LocalOpt.RunAndWaitForCompletion()LocalOpt.Close()Upon running this, it sometimes completes correctly, but sometimes the optics studio window crashes and closes. Then when i open it back up, it asks if i want to restore the file. I have also tried this on multiple machines with different installations of ZEMAX, and the same thing occurs: sometimes it completes the optimisation and sometimes it crashes. Has anyone else experienced this issue, or know a fix? Thanks very much in advance!!

1 month ago

SatheeshaPoojaryMonochrome

posted in ZOS-API

Physical optics propagation

When I run POP analysis for different grid phases, the display sometimes shows the beam small and sometimes it shows an enlarged beam. I want the beam size to be comparable (all beams to be of similar scale) in the POP display window. How to do that via ZOS-API?

1 month ago

Stephen.ChapmanSingle Emitter

asked in ZOS-API

How to export/view Zernike Data using the ZOSAPI?

I am trying to view/export the zernike data of my system using Matlab and the API. Currently my code reads: And I don't know what to do from here. The data comes to Matlab in an IAR file type, and I don't know how to extract it.    Thanks, Stephen Chapman

1 month 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

Nicholas.NorthSingle Emitter

asked in ZOS-API

ZOS-API Wavefront map populated by zeros

Hi Zemax community,I am a student who is learning to use the ZOS API in Matlab and I’m having issues with getting results from New_WavefrontMap. How do I correctly pull data from a wavefront map? As the results I plot are always zero.I am running a wavefront analysis and POP analysis in the same program, which uses the ‘Double Gauss 5 degree field.zmx’ file from samples. I apply the analysis then pull the results using the following code to get the data:WF_Map_Data = New_WF_map_results.DataGrids(1).Values.double;matrixData = POP_Results.DataGrids(1).Values.double;and try to plot it in Matlab the matrix will be populated by zeros.Wavefront map populated by 0’sBoth wavefront map and POP are set up in a similar fashion, but when plotting the results of the POP it will not be populated by zeros.POP resultThanks for readingNick

2 months ago

Yao.TIanMonochrome

asked in ZOS-API

Close ToleranceDataViewer window pop out after tolerancing analysis finished

I am running tolerancing analysis (TA) using Matlab. I noticed that one tolerance data viewer window will show up after the TA is finished. I would like to close the viewer window using Matlab script however I was not able to find the right way to do it in ZOS-API manual. Do you know how to close the viewer window using Matlab script? Thank you very much.

2 months ago

Erik.HebestreitInfrared

posted in ZOS-API

ZOSAPI_NetHelper cannot be added

Hi. I am using the ZOS-API for Python and try to switch to the new recommended method of using PythonNET instead of the COM interface. To do so, I created a new Python template using 'Programming>Python>Interactive Extension' (same problem occurs with 'Standalone Application'). Running this template fails when trying to add the NetHelper DLL: import clr, os, winreg from itertools import islice # determine the Zemax working directory aKey = winreg.OpenKey(winreg.ConnectRegistry(None, winreg.HKEY_CURRENT_USER), r'Software\Zemax', 0, winreg.KEY_READ) zemaxData = winreg.QueryValueEx(aKey, 'ZemaxRoot') NetHelper = os.path.join(os.sep, zemaxData[0], r'ZOS-API\Libraries\ZOSAPI_NetHelper.dll') winreg.CloseKey(aKey) # add the NetHelper DLL for locating the OpticStudio install folder clr.AddReference(NetHelper) import ZOSAPI_NetHelper --------------------------------------------------------------------------- FileNotFoundException Traceback (most recent call

2 months ago

joshdfreemanVisible

asked in ZOS-API

NSC RayTrace "ClearDetectors" error in Interactive mode with Matlab

Could anyone help troubleshoot an error when running the NSC RayTrace in Interactive Extension mode from Matlab - ‘Unrecognized field name "ClearDetectors".’?The code always runs the first time through, and then the second time through the below routine, either in the same program execution or after stopping and starting again, it hangs up on NSCRayTrace.ClearDetectors(0); % Ray Trace % Create ray trace NSCRayTrace = TheSystem.Tools.OpenNSCRayTrace(); NSCRayTrace.SplitNSCRays = false; NSCRayTrace.ScatterNSCRays = false; NSCRayTrace.UsePolarization = true; NSCRayTrace.IgnoreErrors = true; NSCRayTrace.SaveRays = false; NSCRayTrace.SavePaths = true; NSCRayTrace.SavePathsFile = 'Simulation_temp.PAF'; NSCRayTrace.ClearDetectors(

2 months ago

SahilVisible

posted in ZOS-API

How to load BSDF File in scatter model of object properties in ZOS API Matlab and Python

In OpticStudio, We can load any BSDF file from our \Zemax\ScatterData Folder .Here is the available code for Matlab and Python. You can use this code in Standalone or Interactive Extension.-Copy the code in your file .-Change the path of testfileMatlab Code: TheNCE = TheSystem.NCE; Object_2 = TheNCE.GetObjectAt(2); % changes scatter profile on face Scatter_Data=Object_2.CoatScatterData.GetFaceData(0);o3_Scatter = Scatter_Data.CreateScatterModelSettings(ZOSAPI.Editors.NCE.ObjectScatteringTypes.BSDF); o3_Scatter.S_BSDF_.ReflectFile = 'BrownVinyl.bsdf'; o3_Scatter.S_BSDF_.TransmitFile = 'BrownVinyl_HighRes.bsdf'; o3_Scatter.S_BSDF_.ScatterFraction = 0.775; o3_Scatter.S_BSDF_.Angle = 30; Object_2.CoatScatterData.GetFaceData(0).ChangeScatterModelSettings(o3_Scatter); Object_2.CoatScatterData.GetFaceData(0).NumberOfRays = 2; Python code :testFile = r"C:\test\Digital_projector_flys_eye_homogenizer.zos"TheSystem.LoadFile(testFile, False)print(TheSystem.SystemFile)TheNCE = TheSystem.

2 months ago

SahilVisible

posted in ZOS-API

How to load Spectrum File in Color/Spectrum of object properties in ZOS API Matlab and Python

In OpticStudio, We can load any spectrum file from our \Objects\Sources\Spectrum Files Folder .Here is the available code for Matlab and Python. You can use this code in Standalone or Interactive Extension.-Copy the code in your file .-Change the path of testfileMatlab Code: import ZOSAPI.*;TheSystem = TheApplication.PrimarySystem;sampleDir = TheApplication.SamplesDir;testFile = System.String.Concat("C:\test\ZPO\Diode sample.ZMX"); NSCE = TheSystem.NCE;Obj1 = NSCE.GetObjectAt(1); Source_Color=Obj1.SourcesData.SourceColor;Source_Color=ZOSAPI.Editors.NCE.SourceColorMode.SpectrumFile;filesAvailable = Obj1.SourcesData.SourceColorSettings.GetAvailableSpectrumFiles();FileToSelect=filesAvailable(6);Obj1.SourcesData.SourceColorSettings.SpectrumFile=FileToSelect; Matlab Interactive Extension Python Code:testFile = r"C:\test\ZPO\Diode sample.ZMX"TheSystem.LoadFile(testFile, False)print(TheSystem.SystemFile)NSCE = TheSystem.NCEObj1 = NSCE.GetObjectAt(1) Source_Color=Obj1.SourcesData.Sourc

2 months ago

Julian.IrwinSingle Emitter

asked in ZOS-API

Access the ZOS-API Enum "constants" dictionary referenced in knowledge base

Hello, I am trying to use the ZOS-API through Python. I have found the knowledgebase articles to be very scattered and confusing. I would like to access the dictionary of enumeration constants referenced multiple times in the linked article. However, the article does not show how to find the constants dict within ZOS-API. And, the source script for the code snippets is not linked in the article attachments! Does anyone know how I can access the constants dict through python? Thanks in advance.https://support.zemax.com/hc/en-us/articles/1500005576662-ZOS-API-using-Python

2 months ago

SahilVisible

posted in ZOS-API

Loading User Defined Surface dll with ZOS API python and Matlab

In opticStudio ,we can set User defined surface through Python and Matlab program using standalone and Interactive Extension.-Set the user defined surface -Select the User defined surface from directory-Get the User defined surfaceMatlab Code:You can directly copy the code in Standalone or Interactive Extension: import ZOSAPI.*; % Set up primary optical system TheSystem = TheApplication.PrimarySystem; sampleDir = TheApplication.SamplesDir; testFile = System.String.Concat('C:\test\ABCD\ABCD Simple_lens.zmx'); TheSystem.LoadFile(testFile, false); TheLDE = TheSystem.LDE; surf2 = TheLDE.GetSurfaceAt(2); typeSettings = surf2.GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.SurfaceType.UserDefined); filesAvailable = typeSettings.GetFileNames(); typeSettings.Filename = filesAvailable(5); surf2.ChangeType(typeSettings); d=typeSettings.Filename; disp(d) Interactive Extension Matlab Python Code:You can directly copy the code in Standalone or Interactive Extensi

2 months ago

Page 1 / 7

Badge winners

Paolo.Chioettohas earned the badge OpticsAcademy Certified: OSD
Stavros.Misopouloshas earned the badge OpticsAcademy Certified: ISL
cynthiapadthas earned the badge OpticsAcademy Certified: OSD
Florence.de la Barri�rehas earned the badge OpticsAcademy Certified: Aspheres & Freeforms
Florent.Basinhas earned the badge OpticsAcademy Certified: Aspheres & Freeforms