Knowledgebase
User Groups

Community
Programming OpticStudio

Programming OpticStudio

Share your solutions or ask questions about the ZOS-API, ZPL, or DLLs. Code shared in these spaces is not reviewed by Zemax except for the Code Exchange.

444 Topics

Recently active

Most replies Most views Newest first

asked in ZOS-API

Ray trace settings using ZOS API in python

Hi all,I have been using ZOS-API Pythonnet to perform a ray trace and save the ray trace data as text files. The following program snippet worked perfectly fine up until a few months ago. Now, when I run the same code, it does the ray trace and saves the text file without changing any of the settings.import ZOSAPI;TheSystem = TheApplication.PrimarySystem;teleFile=('T_file.zmx')TheSystem.LoadFile(teleFile,False);Systemdata=TheSystem.SystemDataTheAnalyses=TheSystem.Analyses;X, Y = np.round(np.mgrid[(-1):(1):100j, (-1):(1):100j],3)positions = np.vstack([X.ravel(), Y.ravel()])pos=np.transpose(positions)px=pos[:,0]py=pos[:,1]max_rays=len(px)newWin=TheAnalyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.RayTrace);newWin_Settings=newWin.GetSettings();Field_1 = Systemdata.Fields.GetField(1)Field_1.X=0Field_1.Y=0path='\RT_trial'for i in range(max_rays): newWin_Settings.Px=px[i]; newWin_Settings.Py=py[i]; #newWin_Settings.Wavelength.SetWavelengthNumber(1); #newWin_Settings.Field.SetFiel

Dekang ChenSingle Emitter

asked in ZOS-API

How do I reload all surfaces by using Matlab API?

I notice these are “Reload Surface” and “Reload All Surfaces” tools on the top of the LDE window. Does anyone know how do we access this tool in Matlab API? I did not find such a function in ZOS-API. One similar function is “Reload Object” but it doesn’t work for “Reload Surface”.The reason why I need this function is I am simulating gradient index lenses whose property is read from an external file named “GRADIENT_9.DAT”. After I change the material property in this external “.DAT” file, I need to Reload All Surfaces to update the material.If anyone has suggestions on how to do this, I would appreciate it a lot.

CristinaFVSingle Emitter

OPEV / OPEW

Hi,I would like to know how to use the OCOD and OPEV operands with multi configuration files: In case the same operand is present more than once (for example for different configurations) how to read the right one?Also, I want to know if it is possible to use OCOD with mathematical operands, like MINN, or MAXX, and same question, what if there is more than one in the Merit Function?Otherwise, is there a simpler way to read one value from any line in the MF?Thanks, Cristina.

joshdfreemanUltraviolet

asked in ZOS-API

Access coating properties in ZOS-API?

Is there a way to access the properties of a coating in the ZOS-API? The article below shows how to access the name of the coating, but does not show how to get the properties of the coating.I’m not finding any handles that give the actual coating information. Thanks!

James.GoodSingle Emitter

posted in Code Exchange

Diffraction grating Littrow angle solve

Just a very simple ZPL solve to set the incident angle of a transmissive diffraction grating to the Littrow angle for order m = -1. #Define pipi = 2*ACOS(0)x = SOSO(0) #get preceeding coord break surface numberL = WAVL(PWAV()) #get primary wavelengthG = PARM(1,x+1) #return Lines/um from grating (pg 319)Litt = asin(L*G/2)*180/pi #Calculate Littrow anglesolvereturn Litt Just thought I’d share it to potentially save others a little time.It could be expanded for additional orders.

Jose Ulises.TorresMonochrome

Mie scattering from a single water droplet

Greetings,I am attempting to model mie scattering for a single water droplet illuminated by a laser beam (monochromatic, collimated, and planar) and see the 'rings' on the detector varying with particle size. There is already a similar post: but no solution was reached.My current setup features a 'source ellipse' as the light source and a single 'Sphere' object as the water droplet with DLL Defined Scattering enabled under the Volume Physics tab. This much I have learned from the Zemax knowledgebase article entitled 'How to simulate atmospheric scattering using a Mie model'. My question now is what values for density and mean path should I enter in the MIE.DLL section under the Volume Physics tab?Suppose I start with a 10 micron diameter water droplet and I place the detector 500um (0.5mm) away from it, what density and mean path values correspond? Or is there a better approach?Thank you in advance.

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

Helen.SimsonSingle Emitter

CodeV to Zemax conversion

Error in converting from CodeV file to Zemax. Maximum length for a string variable is exceeded.  Please shorten string and try again    SEQ Command: VUX   0.2862643455614489e-9 -0.002507618428442271 -0.01007430775580165 -0.02275146039691922 -0.04038529897597765 -0.06242137400922543 -0.08826487454143517 -0.1181757056085635 -0.1349076575530941 -0.152878222887056 -0.1719304103266932 -0.1914365142446497 -0.2096016968531782 -0.2187861418214183 -0.2257120003786426   How to debug this. Please let me know

Hans-Jürgen FeigeMonochrome

C# template for user-defined surface dll

Hi All,I am looking for a template to create a user-defined surface dll in c#.Can someone provide me with this. I'm new to C# and UD surfaces.Many Thanks!Hans-Jürgen [Mod note: moved to the DLL subforum]

Karen.hampsonSingle Emitter

Running and Saving an Image Simulation using ZPL

I am wanting to use a macro to automatically run and store image simulations using a ZPL Macro. Does anyone have example code? 

AsafPeMonochrome

Change a detector position on Z-axis using SETNSCPOSITION

Suppose I have a source (surface 1) and a detector (surface 2) in NSC mode. I’m trying to make a macro that shifts the detector along Z-axis using the command SETNSCPOSITION but it doesn't seems to work.The syntax is SETNSCPOSITION surface, object, code, valueCan someone please explains each keyword and how to use it? The surface is the detector surface - 2 ? What is the object? code = 3 for Z Value is the new position?\ THANKS

Charlotte.BondSingle Emitter

asked in ZOS-API

How to acces airy disc in ZOS-API

Hi,I’m using ZOS-API in python to analyse PSFs using the Huygens and FFT methods. Is there a way to extract the airy radius and return it to Python?

Eric.AwSingle Emitter

asked in ZOS-API

Unable to connect Python (Spyder) to Zemax

Hi , I am currently trying to use python (Spyder) to connect with Zemax. But I am getting the errors below (shown in the picture below) . I can’t find any solution. I tried to use another python version - 3.7.0 , but still same error. Both standalone application and interactive extension result in same error messages. Appreciate if anyone could give me some guidance. Thank you

Chase.CalviSingle Emitter

asked in ZOS-API

Zernike Alteration in Python API

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?

Sandrine AuriolZemax Staff

posted in Code Exchange

Python Zemax to SPEOS coating converter: version in progress

This example is a Python script to convert Zemax coatings to Speos coatings. The script is available here. It is not yet in the main branch as we are still running some tests but do feel free to use it and leave a comment.https://github.com/ansys/optical-automation/blob/Converter_Coating_Zemax_to_Speos/ansys_optical_automation/application/example_convert_coating_zemax_to_speos.pyThe user inputs are: For each coating + substrate, the software will create a Speos coating. The script is using the Transmission vs Angle analysis from OpticStudio. For more information about Ansys optical_automation, click here.

Sandrine AuriolZemax Staff

posted in Code Exchange

DLL (Source): Non-sequential Astigmatic Gaussian

This Source DLL models an Astigmatic Gaussian Source. It is based on rays but the statistical distribution of rays gives a picture of a diffracting Gaussian beam. It is valid for small angles (paraxial approximation) and when propagating in free space. So clipping at apertures and aberrations will give incorrect results.w0x, w0y are the real beam waist radii (defined at the 1/e2 intensity point) in the XZ and YZ planes. They includes M^2. z0x, z0y are the positions of the beam waist in the XZ and YZ planes. z0<0: in propagation direction if the waist is located before source. M^2x, M^2y are the quality factors in the XZ and YZ planes.For more information, see "Representation of a Gaussian beam by rays" by P. P. Crooker, W. B. Colson, and J. Blau - Physics Department, Naval Postgraduate School, Monterey, California 93943Authors:Steffen Erhard and @Dirk Broemme Click here to download Date Version OpticStudio Version Comment 2020/05/06 1.0 21.1.2 Creation 2023/0

cloMonochrome

asked in ZOS-API

How to ignore Object in API ?

Hello to all,I read the topic about : “how to ignore Surface in API”. I tried to do something similar for non-sequential object but it is not working. surf4 = TheSystem.NCE.GetObjectAt(4) surf4.TypeData.IgnoreObjects = 1First TypeData.IgnoreObjects want a string but I don’t know what to write. Thank you very much in advance fir your answer. Clotilde

John.HygelundUltraviolet

asked in ZOS-API

how to Ignore Surface in API

I’m still new to the API and having trouble getting and setting the “Ignore this surface” via the API.I’m working in Matlab and trying:TheLDE.GetSurfaceAt(4).GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.ILDETypeData.IgnoreSurface)but get the error:The property 'IgnoreSurface' in class 'ZOSAPI.Editors.LDE.ILDETypeData' must be accessed from a class instance because it is not a Constant property. Can someone point me in the right direction?Thank you,John

SahilZemax Staff

posted in ZOS-API

Get and Set Folders in Project Preferences of OpticStudio from ZOS API

We can get and set the folders in Project Preferences in OpticStudio using ZOS API.Save the Project Preferences Configuration(.CFG) file in Zemax LLC\Documents\Zemax\Configs or you can use default Project Prefrences configuration file OpticStudio Save Project Prefrences Configuration file Add the following code for connecting saved configuration file Python Code print('\n===PreferencesFile===\n') cfgFile = r"ZemaxLLC\Documents\Zemax\Configs\Project_Prefferences_test.CFG" print(os.path.exists(cfgFile)) if (cfgFile): self.TheConnection.PreferencesFile = cfgFile else: print('Default OpticStudio.CFG preferences used\n') MATLAB Code: fprintf('\n===PreferencesFile===\n') cfgFile = 'C:\Users\Documents\Zemax\Configs\Project_Pre

Michaelkm8Visible

ZPL "GET" Commands for the LDE in NS Mode

Hello, Is there a way to query the LDE in NS mode to get the column ints, doubles, or strings? Additionally, query the column name of the row number? [Mod note: moved to more appropriate forum for ZPL-related discussions.]

AllieZemax Staff

posted in Code Exchange

ZPL Operand: Optimize without vignetting TMA systems

Some time ago, one of our engineers used the ZPL to create a ZPLM for analyzing TMA systems. A ReadMe doc and example file are attached below. Here is a summary of how the ZPLM works:The ZPL actually checks that a surface does not vignette a ray in sequential mode. In sequential mode, a ray only knows about the next (n+1) surface that it's travelling to...the ray doesn't know about previous surfaces or surfaces beyond the next surface. Therefore, you can have surfaces other than n+1 which can clip the ray in real life but SEQ won't detect that. The macro traces a specific marginal ray (±x or ±y) and targets the Mechanical Semi-Diameter of a specific surface. The ZPLM then forces a minimum clearance distance between between the edge of the mirror and the specified marginal ray. Note: The ZPLM has been written with circular apertures in mind. For systems with other aperture types, the code will need to be updated. Additional note: This macro has not been rigorously tested, which is wh

Sandrine AuriolZemax Staff

posted in ZOS-API

NSC Surface Sag using ZOS-API

The NSC Surface Sag (available in Ansys Zemax OpticStudio 2023 R1 and OpticStudio 23.1) is fully implemented in ZOS-API. It means that you can open that analysis, define the settings and get the results. It makes it easy to convert an object face into a Grid Sag Surface.Here is an example of a Matlab code:TheSystem=TheApplication.PrimarySystem;MyNSCSag = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.NSCSurfaceSag)MyNSCSag.HasAnalysisSpecificSettingsreturns TrueThe settings are:MyNSCSag.ApplyAndWaitForCompletionMyNSCSag_results = MyNSCSag.GetResultsreturns a DataGrid containing the sag pointsSag = MyNSCSag_results.GetDataGrid(0).Values.double;

extract distortion percentage or ref height with ZPL

Hi, I have a question of how to extract the reference height or distortion in percentage with ZPL? I was using RAYY to get the real height but I’d like to extract the other two col data as well. Thanks!

Victoria.ChanSingle Emitter

How do I retrieve coordinate break tilt about x data using GETVARDATA operand in a ZPL macro?

How do I retrieve coordinate break value (Tilt About X) from a particular surface number using GETVARDATA operand in a ZPL macro?

Callum.VidlerSingle Emitter

Exporting volume detector data

Hi, I'm quite new to Zemax and was wondering if someone could assist me with processing some volume detector data. I'm currently trying to reconstruct some data from the volume detector and display it in 3D using the Voxel Maker macro. However, the process tends to be quite slow and often crashes with large models. I've written a Matlab script that will pass a binary array and compute the 3D voxelization. However, I need a way of exporting all of the detector cross-sections from Zemax, so that they can be passed by the script. Does anyone know of a way I can do this? I know I can save the individual images seperately within the detector viewer, however, these images will contain the legend and axis titles. It will also be very time-consuming doing this for 100+ cross-sections. Any help would be greatly appreciated! Regards, Callum Here's the link to the macro I was using for reference: How to show Detector Volume data in 3-D · MyZemax

1
2
3
4
...
18

Page 1 / 18

Badge winners

Mike.Joneshas earned the badge Visibly Un-Polarized
Alessandra Crocehas earned the badge Allow me to introduce myself
Florent.Basinhas earned the badge OpticsAcademy Certified: Tolerancing
Bianca.Jugureanuhas earned the badge OpticsAcademy Certified: Tolerancing
Vaidas.Nagreckishas earned the badge OpticsAcademy Certified: Tolerancing

Show all badges

Powered by inSided

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

Redirecting to the Zemax Community...

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.

OK

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.

OK

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

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