Is there a way to access the field 'Convert To' function in a ZPL macro?  If not, can this be added to the new features list? Thanks. Pat.

This python ZOS-API interactive extension creates a ray file based on batch ray tracing in a sequential system. This allows import of image-space ray data from a sequential model into NS mode and/or Speos, including black-boxed lens systems. For a user selected field coordinate, rays are randomly selected in the pupil and traced to the image plane. The image space ray data (intercept at a specified dummy surface) are saved as a ray file in both Zemax and Speos formats into the ...\Zemax\Objects\Sources\Source Files\ directory. Note that is merely intended as an example. The implementation this tool should be adapted and validated based on individual cases. Click here to Download 

What is the best way to validate that the parameters input by the user are valid? For example, say that I have a parameter “n_rows” that needs to be an integer greater than zero. Should I check this upon initialization of the DLL (case 8)? If the input is invalid, should I then change the corresponding FD->param[i] it to be a valid value (e.g., if the user input 0 then change it to 1)? Or is this a bad idea? The example files state that the DLL should only modify FIXED_DATA in case 7, when Zemax is asking for safe data. Thanks

Hi everybody,I need your advice / help for using the API.I am currently trying to run my Zemax file over the interactive mode with python. So far, I have managed with the help of the ZOS-API Syntax help and the examples presented there, but I am not getting any further at this point. The Zemax file I want to control is a non-sequential system.I would like to create a Universal 1-D Plot where I plot the value of one operand (=NSDD) in my merit function in dependence of the tilt angle of an object in my system. In the image attached at the bottom you can see the settings I would like to set over python. I am struggling with setting the field “NSC Data” with python. In the documentation under KEYWORDS-->MODIFYSETTINGS I cannot find any setting for this option: UN1_CATEGORY: Use 0 for surface, 1 for system, 2 for config.  I tried 3 for “NSC data” without success. You can find the python snippet I used below. My question boiled down:Is there a way to set the NSC category in an univ

溶液中に存在する粒子の吸光、散乱を評価できるようなモデルをノンシーケンシャル系で作成していて質問があります。Mie.1dllを使用し、光源、溶液、ディテクタの３つのオブジェクトで評価しているのですが、Particle Indexの設定時にわからないことがございます。シェードモデルで光線を確認しながらParticle indexを大きく（初期値から溶液の屈折率より上）していくと、散乱が発生する回数が増える事象が起きました。（光線を保存して光線データベースビューアで確認し、実際に代わっていることも確認しました）想定では屈折率が変わったときに散乱方向や散乱強度に影響はあるが、散乱回数は変わらないと思っていたのですが、こちらはどういった理由で起きているのでしょうか。 

Hi everyone,I am new here and trying to write a macro for a simple setup that I have. I have a beam at source with specific NA and goes through few optics and get focused on a surface with floating aperture. My inputs are relative position of source/object respect to image in X and Y and output is efficiency at “Geometric Image Analysis”. How can I write such a Macro? 

The Python code converts the Excel data into ZBF text format. The sample Excel is provided as ZBF_Example.xlsx.  Click here to download Date Version OpticStudio Version Comment 2025/01/26 1.0 - Creation  

I cannot find in the doc what are the names of the parameters in the API to change the field density and wavelength, especialy in the MODIFYSETTINGS which does not mention this type of analysisMaybe it is not implemented ?Also, the analysis results do not exihbit any data: print(analysis_results.NumberOfDataGrids)print(analysis_results.NumberOfDataGridsRgb)print(analysis_results.NumberOfDataScatterPoints)print(analysis_results.NumberOfDataScatterPointsRgb)print(analysis_results.NumberOfDataSeries)print(analysis_results.NumberOfDataSeriesRgb)print(analysis_results.NumberOfMessages)print(analysis_results.NumberOfRayData)all print 0, so is there a way to retrieve the results from this analysis ?

Hello Optics Team! I meet a question when writing ZPL. There is a mirror-reflected system and I would like to do the sensitivity analysis on some tolerances. When it comes to decenter, I found that it was difficult to pick up a surface’s ‘Before surface tilt/decenter’. There is a function of picking up ‘After surface tilt/decenter’ (SURP 66) but no such a function for ‘Before surface tilt/decenter’.Anyone have some experience about it? Thank you!

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

Hi. I started to study ZOS-API with Matlab today. And I managed to set a specific material refractive index and get it to work without error. And My goal is to create code that can display PSF,MTF, Thorough Forcus Spot diagram and Zernike Standard Coefficients. Therfore, could you please give me some advice how to analyze them and receive their results in Matlab? import ZOSAPI.*;![endif]-->!--[if>% Set up primary optical systemTheSystem = TheApplication.PrimarySystem;![endif]-->!--[if>% AperturePupilDia = 8.0;TheSystemData = TheSystem.SystemData;TheSystemData.Aperture.ApertureValue = PupilDia / 2;![endif]-->!--[if>![endif]-->!--[if>% Lens dataTheLDE = TheSystem.LDE;% TheLDE.InsertNewSurfaceAt(2); % Surface_1 = TheLDE.GetSurfaceAt(1);Surface_2 = TheLDE.GetSurfaceAt(2);Surface_3 = TheLDE.GetSurfaceAt(3);![endif]-->!--[if>% Surf1 InfomationSurface_1.Radius = 24.397;Surface_1.Thickness = 9.915;%Setting RefractiveIndexnd = 1.52253; materialModel = Surface_1.Mat

Please do me a favor. Zemax has the function "Image Simulation". I can do this interactively. Now, I want to use "Image Simulation" to simulate 2000 frame images. Therefore, I want to use SampZOS-API Matlab programming to automatically do it.  I have learned the code ZOS-API\Sample Code\MATLAB\MATLABStandalone_04_pull_data_from_FFTMTF.m" to acquire MTF curves. Would you please tell me how to program codes. The codes can realize to load, simulate and save 2000 frame images based on "Image Simulation" moduale. It would be appreciated if you could reply me as soon as possible.

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?

Hello. I am trying to get the vertex position of each optical element in terms of global coordinates. I have found I need this as I am trying to find the full X, Y, Z location for each ray when running a “CreateNormUnpol” raytrace. When I am reading the ray information, I only get values for the X & Y locations and a 0.0 value for the Z location of the ray. Is there a way to enable global position for all axes? In a similar analysis, I want to know if there is a way to run a single ray trace and get all the location and angle information at each surface as is done in the Single Ray Trace window under the Analysis tab?

I am trying to set some coordinate breaks X-Y tilts as variable using ZOS-API in Matlab.for thickness I know that the code is:Surface1.ThicknessCell.MakeSolveVariable();I tried different approaches, but nothing worked so far.

I am having an issue with the example Matlab scripts in OpticStudio. They fail to connect to OpticStudio. Here, for example is the portion of the Matlab function that connects, InitConnection FunctionIf I uncomment the success variable to define a “custom” path to OpticStudio, then the function will work; however,  the line,success = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize();assigns 0 to success.I am curious as to why this is happening? I am running Zemax OpticStudio 2024 2.01. My installation folder for the program isC:\Program Files\Ansys Zemax OpticStudio 2024 R1.00\You can see the difference between the release number and the version that I’m running. I installed the program using the Ansys downloader.

Here is my most-used chunk of API code, which reads and displays the basic information in the Lens Data Editor (LDE).  I’ve highlighted the parts of this that are API code, which can easily be translated into other languages. (See the linked article below.)  Everything not highlighted is specific to Mathematica, so one would need to find the equivalent functions, etc., in Python, Matlab, etc.   

Just a quick note on converting API code between Mathematica, Python, and Matlab.  API code will be nearly identical in all languages, so it’s fairly easy to convert code from one to the other.  Here’s an example of getting the surface type from the LDE.Mathematica:mySurface = primarySystem@LDE@GetSurfaceAt[2]@Type@ToString[“”]Python or Matlab:mySurface = primarySystem.LDE.GetSurfaceAt(2).Type.ToString()And a table of the differences:Mathematica reserves the “_” character for variables, so an upper-case U is used instead.  For example, in Mathematica, a new FFT MTF analysis can be launched this way:newWin = primarySystem@Analyses@NewUFftMtf[]But in Matlab or Python, this is:newWin = primarySystem.Analyses.New_FftMtf()

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!

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?

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. 

I’m trying to run a simple macro to test printing to screen:PRINT “Hello world”When I run this, all that appears is a text viewer saying “Executing path/to/macro...” and nothing else. I tried adding OUTPUT SCREEN before the print statement to make sure the statement prints to screen, but same issue.Any advice?

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?

Hi,I would like to write a macro that runs the surface slope analysis and outputs the “Text” tab results (X-Coord, Y-Coord, and Slope) to a file. I was thinking of using GetTextFile, but I don’t see a string code for surface slope cross section (or slope either). What’s the best way to do this?Thank you,-Jen

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