Knowledgebase
User Groups

Community
Programming OpticStudio
ZOS-API

ZOS-API

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

184 Topics
516 Replies

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

184 Topics

Recently active

Most replies Most views Newest first

achatte01

asked in ZOS-API

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?

8 days ago

chrisInfrared

posted in ZOS-API

Optimizing non-sequential simulation speed

I am running dozens of non-sequential ray traces in a row, and I'd like to know of any tips for optimizing speed. My current process: Calculate a path for a moving source/detector. For each point in the path, move the source/detector a few mm (currently either a rectangle or STL detector) and run a ray trace. Aggregate the results at the end. I saw that you were considering using GPUs (in particular RTX cards) for ray tracing. Any progress on that? ETA? Maybe a beta build of OpticStudio that I can use? It would take a while to run 56 traces at 500k rays each on an 8k triangle STL. 🙂 Maybe I'm missing a simple way that this can be 10x faster.

8 days ago

Ali HVisible

posted in ZOS-API

Physical Optics Propagation (POP) - API settings

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

11 days ago

Niko.RomerSingle Emitter

asked in ZOS-API

Enter Zernike Fringe Phase Surface from Python API

I am trying to take a known set of Fringe Zernike Coefficients, and insert them into a zemax optical system model as a Zernike Fringe Phase surface. I’ve gotten as far as being able to insert the surface and set it as a Zernike Fringe Phase type, but I haven’t had any success with entering coefficient values into the LDE. I’ve tried LDE.GetSurfaceAt(28).GetCellAt(14).DoubleValue = valuewhere value is a float, but it throws an exception saying that a Double was expected and it got a string. I’ve also tried to just return a value that I’ve typed in manually, but had no success that way either. Can anyone point me in the right direction here? It seems like it should be simple with entering numbers into the LDE, but nothing has seemed to work so far. Thanks

12 days ago

Mo.Student

asked in ZOS-API

How to retrieve RMS Spot Radius Value after changing certain parameters (Thickness, TiltX)?

So my problem is roughly that I want to do my own tolerance analysis and retrieve the RMS Spot Radius value as my criterion. But after changing certain values, as the Thickness and Tilt X, the programme does not seem to register this. The Value is not changing and i just get the same value over and over again. Can someone explain how to effectively change these parameters in Optic Studio, so I can retrieve the actual RMS Spot Radius Value?I’m just assigning these parameters to my own values (f.e. from -10 to 10 with step 0.2) in a loop. Here a snippet of it:surf36 = TheSystem.LDE.GetSurfaceAt(36)mir1_thickness = surf36.ThicknessCell.DoubleValuemir1_tiltX = surf36.GetCellAt(14).DoubleValuefor indexTilt, stepTilt in enumerate(np.arange(-10, 10, 5)): mir1_tiltX = round(stepTilt, 2) spotdata_analysis = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.StandardSpot) spot_settings = spotdata_analysis.GetSettings() spot_settings.Wavelength.SetWavelengthNumber(0) spotd

15 days ago

SahilVisible

posted in ZOS-API

Export Analysis, Graph and Layout JPG using ZOSAPI Interactive Extension Python and Matlab using ZPLM

We can use Python or Matlab Interactive Extension to execute Macro using ZPLM. Please take these stepsWrite a ZPLM code that can export JPG or BMP from a given window. GETSYSTEMDATA 1 EXPORTJPG 1, "C:\test\JPG_file\3DLayout" EXPORTBMP 1, "C:\test\JPG_file\3DLayout" OPTRETURN 0 You can read more about ExportJPG and EXPORTBMP in our help files: The Programming Tab > About the ZPL > KEYWORDS (about the zpl) > EXPORTJPG Save the file as ZPL55 or ZPL”Any Number you like”. Use this ZPLM in Merit Function Editor. In case if you like to know more about using ZPLM as Operand in Merit Function Operand. Please check this KBA: Optimization using a ZPL Macro: the ZPLM operand. Save this Merit Function as “ExportImage.MF” in folder Zemax LLC\Documents\Zemax\MeritFunction 4.Write Python or Matlab Program to run the ZPLM through Inter

21 days ago

Alex.TripsasMonochrome

asked in ZOS-API

Extracting Strehl Ratio in Huygens PSF with Python ZOS-API

I’m working on a code to see how the Strehl ratio of our system changes over different iterations. I’m trying to extract the Strehl Ratio from the Huygens PSF like in the image below However, I can’t seem to find how I can do this. Can anyone help?

25 days 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    

25 days ago

AllieZemax Staff

asked in ZOS-API

How can I pull Peak Irradiance or Total Hits from the Detector Viewer analysis in the API?

Within the API, we are able to quickly pull Peak Irradiance, Total Power, and Total Hits by using the property GetDetectorData as described in the forum post 'Methods for extracting detector data through the API.' However, this property will not take into account an applied ZRD file. We can apply a ZRD file to a Detector Viewer window, so is there a way to extract the same information from there?

28 days ago

SahilVisible

posted in ZOS-API

Python 3.10 not recommended to use for ZOSAPI-Python Interactive or Standalone application

Hello,Python's latest version 3.10 was released a few days back. Our ZOSAPI- Python User updated Python's older version to 3.10 which is not recommendable for Python Interactive and Standalone ZOSAPI -Python. The Pythonnet library which connects CLR of ZOS API dll to Python has not been updated for Python 3.10. So, if you find customers using Python 3.10 or Python 3.9. It would be better to use python 3.7 or Python3.8. As Pythonnet works well with these versions.As you can see after installing Pythonnet getting Attribute error Addrefrence.Attribute ErrorThanksSahil

1 month ago

David.NguyenLuminary

posted in ZOS-API

Current lens glass map

Hi everyone, I have written a code snippet to display a glass map of the materials that are found in the current lens file. I don’t think this is possible to obtain from the Libraries..Materials Analyses..Glass Map, but correct me if I’m wrong.The full code is available on my GitHub.These are the imports that are necessary in addition to what is already in the interactive extension or standalone template:import matplotlib.pyplot as pltfrom matplotlib.ticker import FormatStrFormatterimport numpy as npimport chardetThis is the actual code snippet:# Glass catalog foldercat_folder = TheApplication.GlassDir# Number of surfacesn_sur = TheSystem.LDE.NumberOfSurfaces# List of materialsmats = []# List of indices of refractionrefr = []# List of Abbe numbersabbe = []# List of relative costscost = []# Relative cost scale factorscal = 100# Material found flagmat_found = False# Loop over the surfacesfor ii in range(n_sur): # Current surface data sur = TheSystem.LDE.GetSurfaceAt(ii) # Surfac

1 month ago

redbottleMonochrome

asked in ZOS-API

single ray tracing error code

HI,Does anyone know if the following : singleTrace = ZOS.Z_Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.RayTrace);singleTrace.GetResults().IsValidcan be used as the error code for the single ray tracing? just like the error code returned in the batch ray tracing?Thanks!!

1 month ago

BrianMonochrome

asked in ZOS-API

ZOS API Total Track

I’m converting ZPL macros to ZOS API using C#I have a macro that calls GETSYSTEMDATA 1The contents of the operation at placed in a “vector” . Per the documentation, the vector’s "index” at 18 is “Total Track”I’ve having a hard time finding the corresponding API for accessing “Total Track” data.Does anyone know the corresponding ZOS API code?

1 month ago

redbottleMonochrome

asked in ZOS-API

API system parameter tracking

Hi I am trying to track the x, y coordinates using API. I know in Macros I would just use the following: SYSP 102, 1, xSYSP 103, 1, yanyone know how to pull these coordinates using API (Matlab) ? Thanks!!

1 month ago

BrianMonochrome

asked in ZOS-API

ZPL Question with SPRO

I’m converting ZPL macros to ZOS API using C#I’ve having a hard time finding the corresponding API for the macro SPRO(surf, code) with Code = 18From the macro documentation, code 18 will return the Glass Number (an integer?) for a Surface.Does anyone know the corresponding ZOS API code? I currently use OpticalSystem.LDE.GetGlass() to get the glass name. How about accessing the glass number?

1 month ago

Csilla Timar-FulepZemax Staff

posted in ZOS-API

F# solve from Excel API

Hello,This sample code demonstrates how to set solves from Excel API.The example below applies an F# solve:Dim Surface_Last As ILDERowSet Surface_Last = TheLDE.GetSurfaceAt(TheLDE.NumberOfSurfaces - 2)Dim Solver As ISolveDataDim SolveFNumber As ISolveFNumberSet Solver = Surface_Last.RadiusCell.CreateSolveType(SolveType_FNumber)Set SolveFNumber = Solver.[_S_FNumber]SolveFNumber.FNumber = 3.1Surface_Last.RadiusCell.SetSolveData SolverFor further examples about how to use the Excel API, please take a look at these sample files:ZOS-API and Excel | Zemax Community

1 month ago

tariqjhStudent

asked in ZOS-API

Python multiprocessing licensing error

Hi I’m currently attempting to run some a series of Physical Optics Propagations in parallel, using pythonnet. They are pretty simple standalone codes which load in a lens file, carry out the propagation and output the coupling. I’ve been using multiprocessing/Pool and have an unusual issue when using too many cpus.The computer I’m using has 16 cpus, but if I were to try and run more than 7 in parallel using Pool, I get a LicenseException (License is not valid for ZOSAPI use), though only for the 8th cpu.I just wondered if you had any insight as to what could be causing this/different recommendations for running the API in parallel in Python. Thanks!

1 month ago

Csilla Timar-FulepZemax Staff

posted in ZOS-API

Single Ray Trace from Excel API

Hello,This sample code demonstrates how to change the settings and then run an analysis from Excel API.The example below uses the Single Ray Trace:Dim SRT As IA_Dim SRT_settings As IAS_RayTraceSet SRT = TheSystem.Analyses.New_RayTrace()Set SRT_settings = SRT.GetSettingsSRT_settings.Px = 0.5SRT_settings.Py = 0.5SRT_settings.Wavelength.SetWavelengthNumber (2)SRT_settings.Field.SetFieldNumber (2)SRT.ApplyAndWaitForCompletion

1 month ago

Michaelkm8Infrared

asked in ZOS-API

isInitialized = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize(FilePath); Always true.

I have a custom FilePath that I pass into the above method and I am trying to check to see if it is valid so I can alert the user if OpticStudio was found on the local machine or not. However, when I pass anything to the method the bool is true and only the HandleError() method in BeginStandAloneApplication() catches the incorrect FilePath input. Can someone point out my error or offer any advise as to what is going on? Thanks in advance.The method StartZos is the only method I have changed so far.TypePath is hardcoded to always be as 0 or 1.The solution compiles and works as designed expect for the bool issue.There is an XAML GUI calling the Program class.namespace CSharpStandaloneApplication{ public class Program { public static void Main() { } public static string StartZos(int TypePath, string FilePath) { bool isInitialized = false; if (TypePath == 0) { //Find the installed version of opticstudio automatic

2 months ago

Alberto.DonazzanVisible

asked in ZOS-API

How do I get the MFE row number of the DMFS operand?

I am looking at the ZOS-API Help file, but I’m not able to find a way to get the row number of the DMFS operand.My final goal is to programmatically build a DMF at that location. Should I scan the MFE rows 1 by 1 in a for loop, until i find that operand type?

2 months ago

mbelioSingle Emitter

asked in ZOS-API

Python connection

Good morning, I’m trying to connect Zemax with Python and I know that ZOS API and PyZDDE are possible options to use. Now I wonder if it is possible to use PyZDDE with the latest version of Zemax OpticStudio or if some functionalities are not supported with this connection.

2 months ago

Page 1 / 8

Badge winners

lenorehas earned the badge Allow me to introduce myself
Michael Chenghas earned the badge Visibly Un-Polarized
achatte01has earned the badge Allow me to introduce myself
Ryosuke.Niitsuhas earned the badge Allow me to introduce myself
jp7745has earned the badge Allow me to introduce myself

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