Skip to main content

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.

695 Topics
P
Ultraviolet
PhGeekUltraviolet
posted in ZPL
NSC Polygon Object: where is prism_array.zpl macro?

I found a NSC polygon object 'prism_array.pob' that does ALMOST what I want (put a linear array of microprisms on a 'slab' of material), but I would like to generate (micro-)prisms having different angles, spacing, scale, and different thickness 'slabs.' Editing the .POB file shows that it starts as follows with the comment that it was created by a ZPL macro 'prism_array.zpl': '! This polygon object was created by the prism_array.zpl macro ! V 1  82.50000000  50.00000000  0 V 2  82.50000000 -50.00000000  0 V 3 -82.50000000 -50.00000000  0 V 4 -82.50000000  50.00000000  0 R 1 2 3 4 0 0 V 5  82.50000000  50.00000000  10.00000000 ...' But I can't find the prism_array.zpl macro to edit it, see what can be varied, or to use it to generate new prism array .POBs. Can anybody provide a copy of prism_array.zpl, or point me to where to find it?  I have the latest OpticStudio release 20.2 (Professional, perpetual), and can't find

1112
P
Ultraviolet
4 years ago
Jacob.Fugal
Jacob.FugalSingle Emitter
posted in ZPL
ZMX File Specification

Good day. Where is the ZMX File Specification to be found? I used it last year, but now can't remember where I saw it.  

5543
K
Ultraviolet
4 years ago
V
Victor.Haase-CoelhoMonochrome
asked in ZOS-API
How do I insert an NS component as a surface in the LDE using the API?

How do I insert an NS component as a surface in the LDE using the API?

90
V
4 years ago
Jonathan.Bumstead
Jonathan.BumsteadMonochrome
asked in ZOS-API
Change solve type on thickness using Matlab

Hello, I'd like to run two different optimizations with different merit functions through Matlab. Before running the second optimization, I need to change the Solve Type of some thicknesses and radii to variables. The following code provides the current solve type, but it is a read-only property. Is there some way to change the solve type using Matlab?  TheLDE = TheSystem.LDE; S1_CollSolve = TheLDE.GetSurfaceAt(52); S1_CollSolve.ThicknessCell.Solve Thanks for your help. Best, Jon

1712
Jonathan.Bumstead
4 years ago
Kevin Scales
En-Lightened
Kevin ScalesEn-Lightened
posted in ZPL
Floating point number representation; issues in OpticStudio

OpticStudio is no different from any other software in using floating-point representation for storing numbers other than integers. Although the accuracy is very high, sometimes a number like 0.7 can be stored internally as a very close approximation, like 0.700000000001712 or 0.6999999999998394 for example. For calculations these differences are usually acceptable. The differences are generally confined to the digits near the limits of double precision storage anyway. Be very careful, however, using numbers like these in a comparative, like checking if a variable is less than another. In Zemax Programming Language (ZPL), OS operands, and some types of displays (bar charts), particularly with discrete data divisions, you might see unexpected results. For instance, in the following code, there is a big difference between A being 7.1 and A being 7.099999999981728. IF A >= 7.1   PRINT 'Success' ELSE   PRINT 'Fail' For similar reasons, the use of non-integers as indices in a FOR-

5062
Angel Morales
En-Lightened
4 years ago
Angel Morales
En-Lightened
Angel MoralesEn-Lightened
posted in ZPL
Can I reformat data output from analysis windows?

I have some data (such as the text output from a Surface Sag or Surface Phase window). I would like to save this data, but with a different representation of the significant digits. Is there any way to accomplish this?

2551
Angel Morales
En-Lightened
4 years ago
‪
‪Yiska.Fattal‬‏Single Emitter
posted in ZPL
access to cfg file

Hi I want to create zpl macro that  print TFR (throogh focus MTF) data to text file. In order to get relevant information I need to change the settings. I tried to do this by 'MODIFYSETTINGS' but then I got error massage that said 'cannot open setting file'. I did not find any explanation in Zemax manual where this setting file located and I can create it  such that it can be open. I would like if you can give me some information about this file type and how I can access into it. Thanks!   image of ZPL file:  

6523
Csilla Timar-Fulep
Zemax Staff
4 years ago
Allie
Zemax Staff
AllieZemax Staff
asked in ZPL
Can I use the ZPLM operand in a Universal Plot?

Operands may be used as dependent variables in Universal Plots. However, there are some cases where I use a ZPLM and the plot shows a straight line of constant value, instead of the curve I expect to see. 

2651
Allie
Zemax Staff
4 years ago
C
Chiara.BonatiSingle Emitter
posted in DLLs
Scatter dll not visible in Zemax OpticStudio Premium

Hi, I have a Global Academic Program License for OpticStudio, and from my License Manager I see this license is of type 'Premium' which should give me the possibility to use dll scattering model. I have downloaded one of Luminit's scattering dll and placed it in the correct folder, but nevertheless the model does not appear in the user defined scatter model list! Is this a limitation of the academic license? Thanks, Chiara

733
C
4 years ago
Allie
Zemax Staff
AllieZemax Staff
asked in ZOS-API
What is the difference between Python COM and Python .NET?

With the OpticStudio 20.2 release, the way we connect to Python has changed from using the COM interface to using .NET. Are there any differences in how the API code is implemented in Python after this change?

4331
Allie
Zemax Staff
4 years ago
G
George.DosterSingle Emitter
asked in ZOS-API
Python ZOSAPI Setting Power on Source

I'm using the python interface to ZOS API. I am trying to set the power on a source in the NSE. I can't seem to set this attribute. I am able to set the position, angle, source charateristics etc. any ideas? Code: (at least enough to illustrate what I'm doing...) NSCE = TheSystem.NCE S = NSCE.InsertNewObjectAt(1) S.ChangeType(S.GetObjectTypeSettings(constants.ObjectType_SourceDiode)) # This works fine. S.XPosition = DiodeFaceAtRadius ObjectSrc = CastTo(S.ObjectData, 'IObjectSources') # Neither one of these stements does anything. ObjectSrc.Power = 1.0 ObjectSrc.NumberOfLayoutRays = 100 # This works fine. ADiodeSrc = CastTo(S.ObjectData, 'IObjectSourceDiode') ADiodeSrc = CastTo(S.ObjectData, 'IObjectSourceDiode') ADiodeSrc.DeltaX = 0.18

1051
Allie
Zemax Staff
4 years ago
V
Victor.Haase-CoelhoMonochrome
asked in ZOS-API
How to load a Prescription Data Report into a Matlab struct?

Is there a way to get the Prescription Data Report using the Matlab ZOS_API? I've been trying: prescriptionData = ZOSAPI.Analysis.AnalysisIDM.PrescriptionDataSettings; But that seems to return an 'AnalysisIDM' object. My goal is to have the Prescription data as a struct but just a text file like the Report generated from the Analyze Tab would be great. Thank you for your time!

1971
V
4 years ago
G
Gareth.HastingsSingle Emitter
posted in ZOS-API
ZOS-API in Matlab

Dear All, I would be very grateful if someone is able to provide insight into an error we’ve experienced using the ZOS-API in Matlab please. We are simply trying to execute demo code “MATLABStandalone_04_pull_data_from_FFTMTF.m” from the “…Documents/Zemax/ZOS-API Sample Code/MATLAB” folder. (It is also one of the examples in the webinar.) At line 47: “newWin_Settings.SampleSize = ZOSAPI.Analysis.SampleSizes.S_256x256;” the code returns the following error: “The class ZOSAPI.Analysis.SampleSizes has no Constant property or Static method named 'S_256x256'.” Even when the default sampling in OpticStudio is manually changed to 256x256, such that newWin_Settings.SampleSize = _256x256 the same error occurs. We are able to perform the analysis and get the expected result manually in OpticStudio, it is only the API interface that is problematic. I would really appreciate any suggestions towards understanding the problem. Please let me know if any additional information would be helpful.

1375
Allie
Zemax Staff
4 years ago
H
Zemax Staff
Heng.LiZemax Staff
posted in ZOS-API
OpticsTalks: Tolerancing A (B/C) Irregularity per ISO

Here's the discussion space for the OpticsTalks: Tolerancing A (B/C) Irregularity per ISO, to be hosted by Dr. Erin Elliot.  Check out all the OpticsTalks: https://my.zemax.com/en-US/customer-events/

1222
E
Zemax Staff
4 years ago
V
Victor.Haase-CoelhoMonochrome
asked in ZOS-API
ZOS_API funtion to check wether a file is in sequential or non-sequential mode

I am writing a matlab script to export a .zmx as CAD. I'd like it to work with sequential and non-sequential files. Therfore the script should check what mode the file is in. I could only find: bool ZOSAPI.Tools.General.IExportCAD.SequentialSettingsEnabled which: Gets a value indicating whether or not the sequential-only settings are used. true if the sequentials settings are available; otherwise, false. Is there no higher level function to get the file's mode? I feel like that is a somewhat convoluted way to get the mode.

302
V
4 years ago
D
David.GoodwinMonochrome
posted in DLLs
Diffraction grating DLLs don't work

I wanted to try out the new diffraction grating DLLs.  Following the example in the knowledge base article, when I get to the point of selecting one of the DLLs I get an error message "Unable to load 'UserParamNames' function from DLL".  The only DLL that seems to work is diff_samp_1.DLL

3455
Nicholas Herringer
Zemax Staff
4 years ago
H
Heejoo.ChoiMonochrome
asked in ZOS-API
Exporting global coordinate of each surface in ZOS-API Matlab

Hello,  I'm studying the raytrace using ZOS-API and Matlab. I could get the raytrace results using Batch raytrace example. (example # 22)  The results show the each ray position(on the interesting surface) in local coordinate. If I want to convert this local coordinate to global, which way is best? I'm thinking of using global surface coordinate to use it as a reference for conversion. But, I cannot find the exporting global coordinate of the each surface as well. So my question is  1) Can the batch raytace result be exported in global coordinate? 2) How do I get the global coordinate of each surface? Thanks in advance for your help! 

3844
H
4 years ago
Katsumoto Ikeda
Ultraviolet
Katsumoto IkedaUltraviolet
posted in ZPL
ZPL Macros: What FUNCTIONS and KEYWORDS are replaced or obsolete?

There are times when we run an old ZPL Macro and it may not work in the newest version of OpticStudio. This happens because FUNCTIONS and KEYWORDS are obsolete, even though Zemax/OpticStudio have not made any KEYWORDS obsolete since before 2006, and only 1 function obsolete in the past 5 years.The table below is for mapping the FUNCTIONS/KEYWORDS. If you have a macro that doesn't work and are forced to use Zemax 13 or earlier, perhaps you can check the table below and lookup what the old code is to manually map it and make it work in the newest version of OpticStudio.Feel free to add any we've missed in the comments section, and I'll update the main post.   Type   Old   New   Comment   Function   FVAN(x)   FTAN(x)       Function   STDD(surf, 0)   SPRO(surf, 60)       Function   STDD(surf, 1)   SPRO(surf, 61)       Function   STDD(surf, 2)   SPRO(surf, 62)  

3583
Mark.Nicholson
Luminary
4 years ago
David Nguyen
Zemax Staff
David NguyenZemax Staff
posted in ZPL
Copying Image Simulation images in ZPL macros

Saving Image Simulation images in a ZPL macroTo output an image file from the Image Simulation tool in a macro, one needs to create a configuration file. This has to be done once manually by pressing Save from the settings menu of the analysis window (Fig. 1).Figure 1 - Creation of a configuration file (*.CFG) from the settings menu of the Image Simulation window.If an Output File is specified, the next time Image Simulation is called from a macro, a file will be saved in the image folder of OpticStudio, typically: User.Name\Documents\Zemax\IMAFiles\, with the corresponding name. The Image Simulation analysis can be called in a macro with the command line:  OPENANALYSISWINDOW "Sim"If the Output File is to be specified in the macro, it can be done with this command line:  MODIFYSETTINGS name_of_cfg_file$, ISM_OUTPUTFILE, output_name$Where the string variables name_of_cfg_file$ and output_name$ correspond to the configuration file full path, and the output file name, such as MyOutputImag

6790
David Nguyen
Zemax Staff
4 years ago
A
Alan.HoskinsMonochrome
asked in ZOS-API
Matlab ZOS Connection returns "License Check Failed"

I am running OpticStudio Professional (19.4) using a black USB key with with support expiring in Decemeber.  When I try to connect using a Matlab ZOS interactive extension it fails the license check.  What can I do about this. I suppose I could run it standalone in debug mode...  Other ideas? Thanks.

3053
joshdfreeman
Ultraviolet
5 years ago

Badge winners

Show all badges
Community Posting GuidelinesCookie settings


Zemax Community

Need more help?

To Chinese users:

Do not provide any information or data that is restricted by applicable law, including by the People’s Republic of China’s Cybersecurity and Data Security Laws ( e.g., Important Data, National Core Data, etc.).


不要提供任何受适用法律，包括中华人民共和国的网络安全和数据安全法限制的信息或数据（如重要数据、国家核心数据等）。



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