Hello,I have a question about NSC by Python program optimization.The program must iteratively run the local optimization defined by Zemax.However, after running some local optimizations, the optimization becomes very slow.How to speed up the optimization of Zemax NSC through Python programs?

Hello, I am very new to ZOSAPI - python programming. I am simply following the article - https://support.zemax.com/hc/en-us/articles/1500005489681-Connect-to-OpticStudio-from-Python-with-the-ZOS-API-Interactive-ExtensionI am using pycharm IDE and running pythonZOSconnection6.py from it (as suggested, in running this in python console). Upto this point, everything seems to be working fine. I see the prompt in optics studio (given below) with the status : connected. OpticsStudio Connection made  All the variable are also loaded : Variables Defined  However, I don’t see this feature “It means that there is an “Intellisense” when working with the Interactive Extension” .Missing Intellisense That is, none of the methods of ZOSAPI are loaded. And if I try running the example code (as suggested in the article), I am getting an error, “ModuleNotFoundError: No module named 'ZOSAPI'” . ModuleNotFound ErrorI have already installed Pythonnet package, which helped to make the first connection with

Hi, I have a Zemax OpticStudio version 16.I'd like run Python in this version. Could anyone know how to start it?Best Regards

Hi, I run a Python program in Zemax OpticStudio version 16. But it show as following error. How do I fix it?    aKey = winreg.OpenKey(winreg.ConnectRegistry(None, winreg.HKEY_CURRENT_USER), r"Software\Zemax", 0, winreg.KEY_READ) 

Hi, Is there any one know that how to change the target file in the NSC Bitmap Wizard of merit function editor by using Python?

Hello,A comment on ZOSPy. I did already spent countless hours on my own python wrapper and I am very happy to see a team of skilled programmers working on that. Just getting rid of tons of boilerplate code is worth the effort!Getting connected to Zemax from my jupyter-lab to zemax as “Interactive Extension” works with ZOSPy or with the pasting several lines of boilerplate and directly acessing ZOS-API via pythonnet 3.x.Via ZOSPy I can add lenses, changes become visible in zemax. So I assume there is no general problem with library loading, connecting, etc..However, I cannot figure how to run a FFT MTF using ZOSPy.  With the bare pythonnet this looks like this (Boilerplat-part from example 04 skipped)# Create analysisTheAnalyses = TheSystem.AnalysesnewWin = TheAnalyses.New_FftMtf()# SettingsnewWin_Settings = newWin.GetSettings()newWin_Settings.MaximumFrequency = 50newWin_Settings.SampleSize = ZOSAPI.Analysis.SampleSizes.S_256x256FFT MFT Window appears.And afterwards# Run AnalysisnewWin.

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

Hello! I am trying to extract the data for a non-sequential volume detector for intensity at each X and Y coordinate along a Z slice for each Z slice. The intention is to eventually make an interactive python plot with a cross section, but I am struggling on actually extracting the detector data using the python API? Anyone have any tips? Thanks :)

Hi community, I am using Python API to perform local optimisation and wanted to display the number of cycles taken for optimising a design. I tried the following code and print the value for LocalOpt.Cycles, but the output was zero:Code:# Local optimisation till completion    print('... Running Local Optimization ...')    LocalOpt = TheSystem.Tools.OpenLocalOptimization()    LocalOpt.Algorithm = ZOSAPI.Tools.Optimization.OptimizationAlgorithm.DampedLeastSquares    LocalOpt.Cycles = ZOSAPI.Tools.Optimization.OptimizationCycles.Automatic    LocalOpt.NumberOfCores = 8    print('Initial Merit Function:', LocalOpt.InitialMeritFunction)    t = time.time()    LocalOpt.RunAndWaitForCompletion()    print('Final Merit Function:', LocalOpt.CurrentMeritFunction)    print('Cycles:', LocalOpt.Cycles)    # Get the elapsed time.    elapsed = time.time() - t    print('Time elapsed: ' + str(round(elapsed,3)) + 's') Output... Running Local Optimization ...Initial Merit Function: 3.6106045608778228Final M

Hi, I followed the sample script and extract the mtf data usingxRaw = data.XData.DatayRaw = data.YData.Data and what I realized is that the MTF is not given in integer location. instead of report the MTF at 50lp/mm it’s reporting MTF at 49.9136879lp/mm. is there any way to get the MTF right at the rounded location? Thanks,Yu

I've tried running the example file PythonStandalone_02_NSC_ray_trace.py and realized that it fails when trying to read out ObjectData:numXPixels = obj.ObjectData.NumberXPixels;Result: AttributeError: 'IObject' object has no attribute 'NumberXPixels'.The code runs flawlessly, except when reading ObjectData. I have spent a full day trying to debug this error without success.I have also tried the methods outlined in PPG example not working | Zemax CommunityandZOS-API Python: How to deal with AttributeError and apply the correct enumeration | Zemax Communitywithout success. Does anyone know how to continue debugging?Note: using Zemax OpticStudio 22.2.1

Hi, I have read this knowledgebase article on how to use pythonnet with ZOS-API. It suggests using Python 3.4 to 3.8. Yet, 3.4 to 3.6 have reached end of life, 3.7 will in 3 months and 3.8 next year. Also, pythonnet 2.5 is no longer maintained. The only active development is focused on version 3+.I would like to use ZOS-API work with modern versions of Python, 3.10+. The only pythonnet version compatible with them is 3+. Under these versions, quite a few ZOS-API calls are broken. For example, IZRDReaderResults.ReadNextSegmentFullraises an exception due to how pythonnet 3+ handles the conversion of int32 and Enum between .NET<->Python.Is there any way to use ZOS-API with these modern and maintained versions? Note that I don’t believe that using Python 3.8 or 3.9 with pythonnet 2.5.2 is a good solution, because pythonnet 2.5.2 is not actively maintained. The pythonnet team has stated multiple times that features/bugs would only be added/fixed in 3+ (for example here). Thank you,Tho

Hi community,I experienced some unexpected behaviour with ZOS-API (Zemax 2024 R1.00) and Python (3.11).I tried to set the surface opacity of a surface in a sequential system via ZOS-API, but it did not work; the surface opacity maintained its default value of 100 %. The following codeapp = ZOSAPI.ZOSAPI_Connection().CreateNewApplication()lde = app.PrimarySystem.LDElde.InsertNewSurfaceAt(2)surface2 = lde.GetSurfaceAt(2)surface2.TypeData.SurfaceOpacity = ZOSAPI.Common.ZemaxOpacity.P50print(str(surface2.TypeData.SurfaceOpacity))yields “P100”, indicating that the surface opacity was not affected.When I tried to find the source of the problem I noticed that the surface opacity is somehow affected by the setting of the surface color. To investigate, I set all possible combinations of surface color and surface opacity and subsequently read the actual values color_get and opacity_get (full code at end of post): color_set color_get opacity_set opacity_get0 Default Default P00

I’m trying to export Monte Carlo Tolerancing data to MATLAB through the ZOSAPI, and I can’t find a way to extract the data as a table or matrix. I would rather not write my own parser for the summary format. I have the tolerance data viewer object from TheSystem.Tools.OpenToleranceDataViewer, and it has a property called MonteCarloData that appears to contain a table/matrix with the correct dimensions. However, I can’t figure out how to actually bring that data into a useful format MATLAB.

Hi,After installing the latest version of Zemax OpticStudio (24.1), I’ve been having trouble with MATLAB scripts that interface via the ZOS-API. In particular, when running the initial boilerplate code to establish a connection between MATLAB and Zemax, I receive the following error: "Could not load file or assembly 'Google.Protobuf, Version=3.23.4.0, Culture=neutral, PublicKeyToken=a7d26565bac4d604' or one of its dependencies. The system cannot find the file specified." This occurs for all MATLAB scripts (example attached) and seems to relate to the InitConnection function. I have had to rollback to the previous version of Zemax (23.2.1) to use my MATLAB scripts.  Has anyone else encountered this issue and does anyone know of a solution? Thanks, Michael

ZOSPy 1.2.0 has just been released, and brings a definitive fix to the Python.NET 3 problems.How it works is explained in the documentation.Explanation of abbreviations:zp: abbreviation for ZOSPy zos: ZOSPy class that manages the connection with the ZOS-API. oss: ZOSPy's wrapper for optical systems, equivalent to TheSystem in the ZOS-API documentation. ZOSPy connects to the ZOS-API using Python.NET. Python.NET converts .NET objects to Python objects and vice versa, and it allows to customize this conversion behaviour using codecs.To solve the problems related to Python.NET 3, we use a custom encoder. This encoder automatically downcasts generic interfaces to specific implementations. The ZOS-API often defines a generic interface which is implemented by many other, more specific interfaces.Example:The ZOSAPI.Analysis.Settings.IAS_ interface specifies the properties and methods that should be implemented by the settings object of all analyses. Many analyses have settings that are specifi

We have just released ZOSPy v1.2.0, an open source library for more easy python-based optics simulations through OpticStudio. An example of this way of performing, documenting and sharing OpticStudio simulations can be found here. The main new features are:Support for OpticStudio v24 and python 3.12 (including auto-completion and unit tests) A definitive solution for problems related to Python.NET 3 (see this separate post for more details) A unified connection method (including the possibility to select the OpticStudio version) Wrapper for various analyses methods (a special thanks to all the users who have contributed in the last year!)A full list of the new functionality can be found in the release notes and in the documentation. Happy coding!

Hi All, I know if using ZPL , RAVY() is used to trace vignetting surface number. if I need to do that using API, how to implement it? Much appreciated for the help!

Is there a way to load preset tables for the Field Data Editor (.fld) and Wavelength Data (.wav) in the API? I’m not seeing a way in the syntax help guide for any type of loading of files in the SystemData namespace.

Hi,I’m trying to clear the vignetting and recalculate the vignetting by using the “Set Vignetting” and “Clear Vignetting” in the System explorer. I’m wondering if this accessible in zosapi?Thanks,   

There is a common error that can result from running 32-bit user extensions and user analyses in OpticStudio. The error may manifest in odd ways where an extension fails to open or has an unexpected user interface. When using the ZOS-API, it will engage a dynamic-link library (DLL) called the ZOSAPI_NetHelper.dll. The function of this DLL is to help the user extension locate the installed version of OpticStudio. OpticStudio versions older than 2023 R2 suffered from an issue where the NetHelper DLL could not properly search the Windows registry if the target bit setting of the user extension did not match OpticStudio. Since OpticStudio is a 64-bit program, it might not be found if a user extension was compiled as 32-bit, which is the default for common compilers.In short, if a user extension is compiled as 32-bit and tries to use the NetHelper to find the installation location of OpticStudio, it may fail and deliver the above error message: “OpticStudio cannot be found.” If you possess

Hello,I am using the python API to generate and save FFT PSFs. I can change all the parameters using the python API (with the ModifySettings function) appart the display size. How can I do it? It is not listed in the documentation for the Zemax macro. 

Hi, In the ZOSAPI, the settings for the Physical Optics Propagation analysis feature are now fully implemented:   So as an example, we may set the settings in the 'General' and 'Beam Definition' tabs using the ZOSAPI in MATLAB: TheSystem = TheApplication.PrimarySystem; TheAnalyses = TheSystem.Analyses; newPOP = TheAnalyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.PhysicalOpticsPropagation); newPOP.HasAnalysisSpecificSettings; newPOP_Settings = newPOP.Settings(); newPOP_Settings.Wavelength.SetWavelengthNumber(1); newPOP_Settings.Field.SetFieldNumber(1); newPOP_Settings.StartSurface.SetSurfaceNumber(1); newPOP_Settings.EndSurface.SetSurfaceNumber(4); newPOP_Settings.SurfaceToBeam = 0.0; newPOP_Settings.UsePolarization = true; newPOP_Settings.SeparateXY = false; newPOP_Settings.UseDiskStorage = false;   newPOP_Settings.BeamType = ZOSAPI.Analysis.PhysicalOptics.POPBeamTypes.GaussianWaist; newPOP_Settings.XSampling = ZOSAPI.Analysis.SampleSizes.S_128x128; newPOP

There use to be some nice ZOS-API self-paced training modules on the Zemax website available to registered users … perhaps pre-Ansys.  Are those still available somewhere?  I couldn’t seem find them on the Ansys Learning Hub.

Hello, I need to simulate a VEMD2000X01 photodiode in Non-sequential mode using ZOS-API. The photodiode has a small lens above giving it the attached radiance intensity dependence to angle. I would like first to avoid having to simulate the lens above the photodiode and would like instead to give the detector an "angular sensitivity". I was thinking of using a polar detector to do so, as described in example 8 of the ZOS-API: "PythonStandalone_08_NSCEDetectorData.py" with enough "polar pixels" and then weight the number of measured rays in each polar pixel by the relative sensitivity above using python:-Is this the correct way to go forward?-Alternatively, can all this be done entirely in Zemax: Enter relative radiant sensitivity to angle for a detector in Zemax? and if yes, how should this be implemented in the ZOS-API?Thanks,Greg