Knowledgebase
Ansys Zemax Support FAQs
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.

688 Topics

Most replies

Most views

Newest first

Sandrine AuriolLuminary

posted in Code Exchange

API (CS User Analysis): Sequential Through Focus PSF

This Zemax User Analysis calculates a longitudinal PSF, a PSF through focus.Author: @Michael.Humphreys Click here to download Date Version OpticStudio Version Comment 2022/03/09 1.0 - Creation

3241

6 months ago

AschoSingle Emitter

asked in ZOS-API

How can I use "Test Plate Fitting via ZOS-API and Python

Hi, Is it possible to use “Testplatefitting via ZOS-API and python? Thanks, Anja

823

6 months ago

Aleksandr.MakarovUltraviolet

asked in ZPL

how open specified "Report Graph"?

how open specified "n x n Report Graph" with ZPL?

301

6 months ago

Aleksandr.MakarovUltraviolet

asked in ZPL

how find winnum?

how I can ask zemax which max winnum it have?

281

6 months ago

yonghong.LiMonochrome

asked in ZPL

read data from excel

How to create a sub program to read data from excel in ZPL?Does zemax have this function?

1526

6 months ago

Fredrik valfridssonMonochrome

asked in ZPL

IMAE runs slow

I’m changing four different parameters to find the highest efficency in an optical system.For this I have build a four layer loop that runs the comand IMAE and do some calculations using the returned value and the pramaters. Hovever zemax doesn’t seem to use the full processor capacity only about 7%.If I instead use the comand IMA to run the geometric image analyze the processor runs at full speed and the command runs more than 10x faster. Hovever I cant find any way to read out the data “Total flux”

1057

7 months ago

Fredrik valfridssonMonochrome

asked in ZPL

read data from geometric image analyze in a macro

To speed up a macro I need to read out data from certain pixels from the geometric image analyze in a macro.how do i do that

1062

7 months ago

Jan.VSingle Emitter

asked in ZPL

Export detector data as text of a CAD Part as detector

I have defined a CAD part as a detector in NSC. In the text tab of the detector viewer I am able to see the Irradiance and the position (XYZ) of each pixel. I want to export this text file with a macro in ZPL. When I do this, I get a .txt-file but always with ‘Detector Viewer Summary’ and not with ‘Detector Viewer Listing’ data inside. I have tried to select the correct detector with ‘MODIFYSETTINGS’, ‘DVW_DETECTOR’ but it looks like, I cannot select the correct object. How can I export the correct text file with ZPL?

862

7 months ago

Ilia.GruzinovMonochrome

asked in ZPL

ZPL toroidal graiting naiming

Hi Zemax community. I faced with trouble with false surface id in zemax manual for Toroidal Grating surface in Zemax Oprtic Studio 23.1 . Which surfaces have wrong surface id?

671

7 months ago

elisenda v.Single Emitter

asked in ZPL

Creating CAD objects from “Voxel Maker.ZPL” macro

Hello everyone, I tried to use the “Voxel Maker.ZPL” macro provided in the following article: How to show Detector Volume data in 3-D, but even though no errors appear, it doesn’t create any imported CAD. Is there any new version I can use?Thank you!

Questions about ZOS-API polarization ray tracing

480

7 months ago

GaldaSingle Emitter

asked in ZPL

Error with exporting objects to CAD (STL/STEP,...) by ZPL code

Hello, I am using code in ZPL which include exporting of objects (non-sequential mode) to CAD files-created by Zemax community:SUB export IF PureNSmode == 1 start_number = num_objects + 1 end_number = new_object - 1 ELSE start_number = surf_no end_number = surf_no ENDIF# Export the solid objects as CAD files VEC1(1) = ext # CAD file type VEC2(2) = 8 # spline segments VEC1(3) = start_number # start surface VEC1(4) = end_number # end surface VEC1(5) = 1 # ray data layer VEC1(6) = 0 # lens data layer VEC1(7) = 0 # do not export dummy surfaces VEC1(8) = 0 # do not export surfaces as solids VEC1(9) = 5 # ray pattern NONE VEC1(10) = 0 # number of rays = 0 VEC1(11) = 0 # wavenumber VEC1(12) = 0 # field number VEC1(13) = 0 # do not 'delete vignetted' VEC1(14) = 1 # dummy thickness VEC1(15) = 0 # do not split ra

331

7 months ago

Cheng-Mu TsaiStudent

asked in ZOS-API

How to speed up the optimization of Zemax NSC through Python programs

Hello,I have a question about NSC by Python program optimization.The program must iteratively run the local optimization defined by Zemax.However, after running some local optimizations, the optimization becomes very slow.How to speed up the optimization of Zemax NSC through Python programs?

12312

7 months ago

Ariel11Single Emitter

asked in ZPL

ZLPM file location

Hi,How do I know where my macro files are stored? are they in the general Zemax/macro directory or in the local project? After assuming its local, when reopening the file (after closing Zemax) it went to the general one instead. Is there a way to control this? Thanks

301

7 months ago

nc9289Infrared

asked in ZOS-API

ZOSAPI extention mode - importnotfound error

Hello, I am very new to ZOSAPI - python programming. I am simply following the article - https://support.zemax.com/hc/en-us/articles/1500005489681-Connect-to-OpticStudio-from-Python-with-the-ZOS-API-Interactive-ExtensionI am using pycharm IDE and running pythonZOSconnection6.py from it (as suggested, in running this in python console). Upto this point, everything seems to be working fine. I see the prompt in optics studio (given below) with the status : connected. OpticsStudio Connection made All the variable are also loaded : Variables Defined However, I don’t see this feature “It means that there is an “Intellisense” when working with the Interactive Extension” .Missing Intellisense That is, none of the methods of ZOSAPI are loaded. And if I try running the example code (as suggested in the article), I am getting an error, “ModuleNotFoundError: No module named 'ZOSAPI'” . ModuleNotFound ErrorI have already installed Pythonnet package, which helped to make the first connection with

1469

8 months ago

Michael ChengZemax Staff

published in Code Exchange

Python SPEOS and Zemax Source file converter

That example is a Python script to convert source file between Zemax and SPEOS. To learn more about that converter, check our article: https://support.zemax.com/hc/en-us/articles/4416068530579-SPEOS-and-Zemax-Source-file-converterDownloadFor more information about Ansys optical_automation, click here. TroubleshootingIt’s possible that we get an error message:Non binary files not supported.This happens when the file is not stored in form of ones and zeros, or in some other binary (two-state) sequence.Zemax source fileFor Zemax source file, the extension SDF is recommended, and DAT is supported only for backward compatibility. The file format may be either text or binary. This is mentioned in The Setup Tab > Editors Group (Setup Tab) > Non-sequential Component Editor > Non-sequential Sources > Source File. You can put a detector close to this source file and save the ray tracing data as new source file to convert the non-binary source to a binary one.Speos source fileAs for S

7791

8 months ago

Cheng-Mu TsaiStudent

asked in ZOS-API

how to run Python in Zemax OpticStudio version 16

Hi, I have a Zemax OpticStudio version 16.I'd like run Python in this version. Could anyone know how to start it?Best Regards

533

8 months ago

Cheng-Mu TsaiStudent

asked in ZOS-API

Python initial error in Zemax OpticStudio version 16

Hi, I run a Python program in Zemax OpticStudio version 16. But it show as following error. How do I fix it? aKey = winreg.OpenKey(winreg.ConnectRegistry(None, winreg.HKEY_CURRENT_USER), r"Software\Zemax", 0, winreg.KEY_READ)

250

8 months ago

Michael ChengZemax Staff

published in Code Exchange

DLL (Surface Scatter) Non-Sequential Lambertian Depolarizer

This Surface Scatter DLL models a Lambertian scattering and contains a depolarization fraction parameter to depolarize part of the scattered rays. That DLL is a good example to demonstrate how to control the electric field and how to implement importance sampling. The code is based on "{Zemax}\DLL\SurfaceScatter\Lambertian.DLL". Click here to download Date Version OpticStudio Version Comment 2019-01-13 1.0 - Creation

MilothMonochrome

Hi, I used Rust to build a very simple DLL, inspired by the examples in C and C++ provided with Zemax. The source code can be found here. I compiled it from Windows and a Unix machine with cross compiling. Both versions were as fast as the C alternative I wrote. The compilation method is pretty straightforward and documented in the repo README.It was quite easy to implement similar workflows and structures for some of the other types of DLLs used in Zemax.Yet, I would like to do the same with the 2D version of the diffraction grating. I could only find mentions to the 1D grating in the Zemax docs. The provided code sample covers only a portion of the elements of the pointer and not all of them are fully documented. Does anyone have that piece of information?

670

8 months ago

Cheng-Mu TsaiStudent

posted in ZOS-API

How to change target file of NSC bitmap wizard by using Python

Hi, Is there any one know that how to change the target file in the NSC Bitmap Wizard of merit function editor by using Python?

453

8 months ago

David.NguyenLuminary

posted in Code Exchange

User-defined Operand: Modulo operator

Hi all, I’m not going to create a repository for this, but if you quickly need a modulo operator in your Merit Function, there you have it. Hx and Hy are the operand numbers (integer) that will be used as the numerator and denominator respectively.The relevant part of the code is self-explanatory (hopefully):int numerator = (int)TheApplication.OperandArgument1;int denominator = (int)TheApplication.OperandArgument2;...double numerator_value = TheSystem.MFE.GetOperandAt(numerator).Value;double denominator_value = TheSystem.MFE.GetOperandAt(denominator).Value;operandResults[0] = numerator_value % denominator_value;To install, download the ZIP file, extract it, and move UDOC12.exe to yourDocuments/Zemax/ZOS-API/Operandsfolder. Then, in the MFE you can do:The rest of the division of 5.00 by 2.00 is 1.00.In case you are wondering why I made this. I needed to have a linear polarization without caring about the orientation. I noticed that using CODA with data=110 (phase difference), some linea

1274

8 months ago

Axel.HeinriciInfrared

asked in ZOS-API

ZOSPy run FFT MTF

Hello,A comment on ZOSPy. I did already spent countless hours on my own python wrapper and I am very happy to see a team of skilled programmers working on that. Just getting rid of tons of boilerplate code is worth the effort!Getting connected to Zemax from my jupyter-lab to zemax as “Interactive Extension” works with ZOSPy or with the pasting several lines of boilerplate and directly acessing ZOS-API via pythonnet 3.x.Via ZOSPy I can add lenses, changes become visible in zemax. So I assume there is no general problem with library loading, connecting, etc..However, I cannot figure how to run a FFT MTF using ZOSPy. With the bare pythonnet this looks like this (Boilerplat-part from example 04 skipped)# Create analysisTheAnalyses = TheSystem.AnalysesnewWin = TheAnalyses.New_FftMtf()# SettingsnewWin_Settings = newWin.GetSettings()newWin_Settings.MaximumFrequency = 50newWin_Settings.SampleSize = ZOSAPI.Analysis.SampleSizes.S_256x256FFT MFT Window appears.And afterwards# Run AnalysisnewWin.

27611

8 months ago

Sean TurnerUltraviolet

asked in ZPL

ZPL Edit/Run UI status does not show actual ZPL code line number

I was just testing a macro when I noticed something strange. The number shown in the Edit/Run UI does not match the actual line number in the ZPL macro editor. I grabbed this image while the UPDATE ALL line was running, but the Status indicates line 5 is currently running. Line 5 is just a comment. It appears the lines with “!” are being ignored by the status indicator. For reference, I am using Zemax OpticStudio 23.2.1

170

9 months ago

mluninMonochrome

asked in DLLs

How to limit GRIN refractive index with *.dll

I am trying to write a custom GRIN *.dll file for non sequential mode that will allow me to limit refractive index above or below a certain value and just set it to a constant. However, I am having a hard time defining the derivatives to return as required in the GRIN *.dll files. As an example, if my refractive index looks something like below: I would like to cut everything off above and below a certain threshold, even if my n(x,y,z) function gives me a value thats within it. I have currently been doing this with just a merit function and limiting index that way, but would like to be able to just programmatically restrict it. I also tried a variant where I set the derivatives to 0 or ignored them, but had errors tracing the rays. Anyone have a good solution? Happy to provide any files needed.

633

9 months ago

Page 4 / 28

Badge winners

guangjun.gao@nasa.govhas earned the badge Allow me to introduce myself
Michael.Younghas earned the badge Visibly Un-Polarized
nadav.amitaihas earned the badge Visibly Un-Polarized
TMXhas earned the badge Allow me to introduce myself
Yang.Yongtaohas earned the badge Visibly Un-Polarized

Show all badges

Community Posting Guidelines Cookie settings

Sign up

Already have an account? Login

Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.

Enter your e-mail address

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.

Zemax Community

Manage email notification
Private Message Inbox
My Subscriptions
Posting guidelines

Need more help?

Ansys Zemax OpticStudio
Knowledgebase
Software Downloads
Consultants
Open a Case

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.).

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