ZOS-API

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

  • 241 Topics
  • 695 Replies

241 Topics

Lmmartin
LmmartinSingle Emitter
asked in ZOS-API

Extract accurate MTF from simulated scenes without resorting to FFT PSF

HiI am  using Zemax to simulate images of scenes through customized imaging setups. However, I am unable to simulate images of scene with sufficient resolution.My current imaging setup convolves a complex PSF with the observed scene. Extracting actual scene information requires deconvolution of the image to obtain a meaningful image. This means that I cannot resort to the classical MTF procedure using the FFT of the simulated PSF, as it would only give me the MTF of the convoluted image.I have therefore tried to proceed by scene analysis to extract MTF, i.e. simulate with Zemax the image of classic checkerboard patterns seen through my custom design and then in a second stage extract the MTF using image processing software. The core issue is that the resolution of images obtained after deconvolution are insufficient for image analysis and MTF extraction by slanted edge method.Is there any way to get more accurate scene imaging through simulation with my setup? Or is there another metho

0
Lmmartin
1 day ago
Daniel P. Calero
Daniel P. CaleroMonochrome
asked in ZOS-API

Reading ZRD data on detector using ZOS-API Matlab

Hi,I am trying to use a Matlab script to trace rays and read only the rays that hit my detector after a ghost reflection.I have been trying to save the rays and use a filter to select only the ones I want. Unfortunately, I am not able to read the detector using the ray database. Does anybody have a tip to solve this issue?Thanks,Daniel

2
Daniel P. Calero
2 days ago
nikitasatcik
nikitasatcikMonochrome
asked in ZOS-API

Null reference after creating standalone application inside WinForm project

Dear all,I have a WinForm/WPF project where I want to use ZOS-API.The console application from ray tracing example file works fine. However, when I added ZOS references (ZOSAPI, ZOSAPI_Interfaces, ZOSAPI_Nethelper) to the WinForm project (compiled for x64), I got a null reference, like so:I’ve made minimum modifications to the original example of the ray tracing program. Basically, I just wrapped it into a separate class and removed the Main method, because the WinForm project already has an entry point.The program could be succesfully initialized, which means ZOSAPI references linked to the project:Found OpticStudio at: c:\program files\zemax opticstudioHowever, after new connection created, “TheApplication” reference is null:IZOSAPI_Application TheApplication = TheConnection.CreateNewApplication();I appreciate it if anyone knows the cause of this null reference. Regards,Mykyta

2
nikitasatcik
2 days ago
ArmandP
ArmandPMonochrome
asked in ZOS-API

Getting POP Output Data with Python ZOS API

Hello. I am currently trying to extract the POP output beam data with the ZOS API with not much luck. I would like to pull the data from the POP itself rather than the mfe since i have noticed that the mfe will not update POPD operand values with the input POP settings from an astigmatic gaussian POP. It seems that in the articles I have looked that the the GetResults() from POP will give you the header value and the datagrid pixel value. Since I am trying to get the Raleigh Range, Waist Location, and Waist size data of my beam at the out put place I thought that maybe pulling the data from HeaderData.Lines[7] would work since the beam data is in the line after the irradiance data (line 6t), but when I try this I get an error saying that 7 is past the limit of lines, so I am not sure where to pull this data? I am also noticing that there is a slight bug in the POP data where if propagating X and Y separately, like in my case, it will only output pilot beam data for just x vs for x and

5
Jeff.Wilde
Luminary
4 days ago
Nina Cathy
Nina CathyStudent
asked in ZOS-API

How to obtain the zernike coefficients without set fields in system explorer

Hello everyone,In the full-field aberration map, the sampling value of the field of view has a maximum value of 20. When I want to find the minimum point of an aberration, I often cannot get it precisely because of the lack of precision.I've read the question and the response below, and I am confused that if we use the ZERN operand to read the zernike coefficient value, then a lot of fields need to be setby using zosapi to calculate in matlab. After trying, I found that the fields  can only be set around 2000 at most, and the speed is slow. So I want to know how to get the aberration of any field point, and if  there exsits an interface like this, the optimization can be done to find the exact position of the minimum value. 

0
Nina Cathy
4 days ago
P_Gallardo
P_GallardoSingle Emitter
asked in ZOS-API

How to set a field coordinate variable using ZOS-API

How do I set a field position (say field coordinate X) to a variable using ZOS-API in Python?I am accessing the Fields information usingFields = TheSystem.SystemData.FieldsIt seems like the methods within the Fields object are slightly different to the MCE or LDE editors, as I can get a single field doing Fields.GetField(2) but I cannot find a method like SetSolveData(solve), which would work in the MCE.Any idea on how to set a field coordinate to a variable?Thanks.

1
Jeff.Wilde
Luminary
5 days ago
Julia
Zemax Staff
JuliaZemax Staff
posted in ZOS-API

Difference between GetAllDetectorData() and GetAllDetectorDataSafe()

GetAllDetectorData() and GetAllDetectorDataSafe() are both methods that can be used to retrieve detector data for a specified detector object. The main difference between the two methods is that GetAllDetectorDataSafe() returns a two-dimensional array of double values double[,] that contains all the detector data for the detector object, while GetAllDetectorData() returns a boolean value that indicates whether the detector data was retrieved successfully, and one-dimensional array double[] . GetAllDetectorDataSafe() does not require the input of numPixels and detectorData, whereas GetAllDetectorData() requires these parameters in addition to (detector) ObjectNumber and Data(type).Check the examples to use the two methods: For python: TheNCE = TheSystem.NCEDetObj = 4obj = TheSystem.NCE.GetObjectAt(DetObj);numXPixels = obj.ObjectData.NumberXPixels;numYPixels = obj.ObjectData.NumberYPixels;DetRectangleData_FluxArea = TheSystem.NCE.GetAllDetectorDataSafe(4, 1)for x in range(numXPixels):

1
Julia
Zemax Staff
9 days ago
ArmandP
ArmandPMonochrome
asked in ZOS-API

Help with POP Python

Hello,I am having some difficulty finding answers on this elsewhere online and have not found any helpful forum posts on this either so here I am. I am trying to communicate with the POP with the python ZOSAPI with the program in interactive mode. Currently I have tried this little code snippit to set the surface desired to 2 and pull the irradiance with not much luck. Python more or less yells at me with an error saying “IAS_ object has no attribute ‘EndSurface’ I am not having the best of luck finding a solution to this problem in the help document. Please Help! :)FYI: See code snippit below # initialize analysis toolsTheAnalyses = TheSystem.AnalysesPOP = TheAnalyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.PhysicalOpticsPropagation)POP_set = POP.GetSettings()POP_set.DataType = ZOSAPI.Analysis.PhysicalOptics.POPDataTypes.IrradiancePOP_set.EndSurface.SetSurfaceNumber(2)POP.ApplyAndWaitForCompletion()POP_result = POP.GetResults()Irr = float(POP_result.DataGrids(1).Values) Cheers,Armand

4
MichaelH
Luminary
10 days ago
Stephen.Chapman
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

6
MichaelH
Luminary
16 days ago
D
devin.vega_01Single Emitter
asked in ZOS-API

Batch Raytracing With the ZOS-API MATLAB dll

I started modifying the boilerplate code included on this page: https://support.zemax.com/hc/en-us/articles/1500005576882 Looking through the ZOS-API help from the Programming Tab in OpticStudio I can tell that there are some differences between the way the code is implemented in the .dll versus the way it is described in the help files. How do I access the API for the methods and classes inside the .dll file? 

7
D
16 days ago
Sangyeol
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.  

3
MichaelH
Luminary
17 days ago
Benjamin.N
Benjamin.NSingle Emitter
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

3
David.Nguyen
Luminary
23 days ago
MichaelH
Luminary
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

5
chaasjes
1 month ago
jwbeenakker
jwbeenakkerSingle Emitter
posted in ZOS-API

ZOSPy v1.0.0 is out!

We recently released ZOSPy 1.0.0, our open source library for easy communication between Python and OpticStudio. It uses the ZOS-API, but takes care of most of the programming, such as establishing the communication with OpticStudio and running and parsing analyses.The main new features included in this version are:Support for Python.NET 3.0 A uniform and pythonic interface to analyses:from zp.analyses.mtf import fft_through_focus_mtf mtf = fft_through_focus_mtf(oss, sampling='64x64', deltafocus=0.1) Autocomplete for the complete ZOS-APIAnd much more, see the release notes Check out the new version on GitHub. 

0
jwbeenakker
1 month ago
MichaelH
Luminary
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.

2
Sandrine Auriol
Zemax Staff
1 month ago
Allie
Zemax Staff
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

4
David.Nguyen
Luminary
1 month ago
Allie
Zemax Staff
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?

9
Allie
Zemax Staff
2 months ago
S
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??     

4
Allie
Zemax Staff
2 months ago
Julia
Zemax Staff
JuliaZemax Staff
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

0
Julia
Zemax Staff
2 months ago
I
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!

0
I
2 months ago
S
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? 

1
Sahil
Zemax Staff
2 months ago
M
MilothSingle Emitter
asked in ZOS-API

ZOS-API not compatible with modern versions of Python and pythonnet

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

4
Sandrine Auriol
Zemax Staff
2 months ago
Leon0228zz
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值並匯出?感謝

2
Leon0228zz
2 months ago
Sahil
Zemax Staff
SahilZemax Staff
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

4
Sandrine Auriol
Zemax Staff
2 months ago
alexander_dumont
alexander_dumontMonochrome
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

7
alexander_dumont
2 months ago

Badge winners

  • Allow me to introduce myself
    doris.Chas earned the badge Allow me to introduce myself
  • Allow me to introduce myself
    Guopei.Lihas earned the badge Allow me to introduce myself
  • Allow me to introduce myself
    Richard.Migliacciohas earned the badge Allow me to introduce myself
  • Allow me to introduce myself
    Berta.Bernadhas earned the badge Allow me to introduce myself
  • Visibly Un-Polarized
    cynthiapadthas earned the badge Visibly Un-Polarized
Show all badges
Community Posting GuidelinesCookie settings


Company

Products

Zemax Community

Need more help?



Privacy policy   License Agreements    Terms of service    Cookie Policy   Zemax Account Licensing Policies