Skip to main content
Solved

Getting Raytrace.dll working in Python for SEQ raytracing?

J
Forum|alt.badge.img+1

Hello! I’m trying to run batch ray traces from Python and have encountered some difficulties. Originally I didn’t use this feature because it was quite slow - since each ray needed to be traced individually in a for loop. But after discovering this Knowledgebase article: Batch Processing of Ray Trace Data using ZOS-API in MATLAB or Python – Knowledgebase (zemax.com) I got excited to try the new Raytrace DLL.
|
I started by getting the MATLAB example file working, which was pretty trivial. It basically ran as soon as I downloaded it. 

However, I need the raytracing to be done in Python - so I tried to translate from the MATLAB example file, which did not work very well. First I encountered this error:

  • module ‘clr’ has no attribute ‘AddReference’

Which I fixed by uninstalling clr and installing pythonnet (woops, that’s on me). I had to downgrade to Python3.8 to install pythonnet. The next error I encountered after I finally got the code running seems more fundamental, when trying to run NET.addAssembly(pwd+’\Raytrace.dll’) it says

  • NameError: name ‘NET’ is not defined.

Where is NET supposed to be imported? I don’t see it explicitly earlier in the script, or the accompanying script “PythonNET_ZRDLoaderFull.py”. 

Alternatively, if someone could just point me to an example of sequential raytracing using the Raytrace.dll that would be very helpful.

Thanks!

Best answer by MichaelH

Hi Jaren,

Yes, as you discovered, pythonnet is only supported up to 3.8 (https://github.com/pythonnet/pythonnet); when pythonnet upgrades to 3.10 then you can also upgrade to the latest version of Python and still access the ZOS-API.

As for adding references via pythonnet, you need import clr and clr.AddReference() methods (I’m not sure where NET.AddReference is coming from).  When you first download the file, make sure you unblock the file so you can actually access it via Python (by default, Windows will block the execution of code from unsigned sources).  After downloading & extracting the ZIP file, you will need to right click on it, select Properties and then check the Unblock option at the bottom of the General tab:

 

As for sample Python code, refer to the below code for running a Normalized Unpolarized raytrace (it traces the 4 marginal rays at full field for the Double Gauss 28 degree field sample file):

--------------------------------------------------------

import zosapi
from System import Enum, Int32, Double

# add the raytrace.dll from the current directory
import clr, os
dll = os.path.join(os.path.dirname(os.path.realpath(__file__)), r'RayTrace.dll')

clr.AddReference(dll);

# import the raytrace namespace
import BatchRayTrace;

# load the double gauss
zos = zosapi.App()
TheSystem = zos.TheSystem
ZOSAPI = zos.ZOSAPI
TheSystem.LoadFile(os.path.join(zos.TheApplication.SamplesDir, r'Sequential\Objectives\Double Gauss 28 degree field.zmx'), False)

# check to make sure the file was loaded
if TheSystem.LDE.NumberOfSurfaces < 4:
    print('did not load the file properly')
    exit()

# run a sequential ray trace
maxrays = 4;        # let's trace the 4 marginal rays
tool = TheSystem.Tools.OpenBatchRayTrace();
normUnpol = tool.CreateNormUnpol(maxrays, ZOSAPI.Tools.RayTrace.RaysType.Real, TheSystem.LDE.NumberOfSurfaces - 1)

# pass raytracer to dll
reader = BatchRayTrace.ReadNormUnpolData(tool, normUnpol)
reader.ClearData();

# initialize the output (the number of indices in the output array is maxseg*maxseg
maxseg = 2;
rays = reader.InitializeOutput(maxseg);

# add the 4 full field marginal rays
reader.AddRay(2, 
    [0, 0, 0, 0], 
    [1, 1, 1, 1], 
    [1, -1, 0, 0], 
    [0, 0, 1, -1], Enum.Parse(ZOSAPI.Tools.RayTrace.OPDMode, 'None'));

# read the segments (array length is maxsegs * max segs)
isfinished = False
while not isfinished:
    segments = reader.ReadNextBlock(rays)
    if segments == 0:
        isfinished = True

# print the rays
print(list(rays.X))
print(list(rays.Y))

# always close your tools
tool.Close();

View original
Did this topic help you find an answer to your question?

4 replies

MichaelH
Ansys Staff
Forum|alt.badge.img+2
  • MichaelH
  • Ansys Staff
  • 356 replies
  • Answer
  • June 7, 2022

Hi Jaren,

Yes, as you discovered, pythonnet is only supported up to 3.8 (https://github.com/pythonnet/pythonnet); when pythonnet upgrades to 3.10 then you can also upgrade to the latest version of Python and still access the ZOS-API.

As for adding references via pythonnet, you need import clr and clr.AddReference() methods (I’m not sure where NET.AddReference is coming from).  When you first download the file, make sure you unblock the file so you can actually access it via Python (by default, Windows will block the execution of code from unsigned sources).  After downloading & extracting the ZIP file, you will need to right click on it, select Properties and then check the Unblock option at the bottom of the General tab:

 

As for sample Python code, refer to the below code for running a Normalized Unpolarized raytrace (it traces the 4 marginal rays at full field for the Double Gauss 28 degree field sample file):

--------------------------------------------------------

import zosapi
from System import Enum, Int32, Double

# add the raytrace.dll from the current directory
import clr, os
dll = os.path.join(os.path.dirname(os.path.realpath(__file__)), r'RayTrace.dll')

clr.AddReference(dll);

# import the raytrace namespace
import BatchRayTrace;

# load the double gauss
zos = zosapi.App()
TheSystem = zos.TheSystem
ZOSAPI = zos.ZOSAPI
TheSystem.LoadFile(os.path.join(zos.TheApplication.SamplesDir, r'Sequential\Objectives\Double Gauss 28 degree field.zmx'), False)

# check to make sure the file was loaded
if TheSystem.LDE.NumberOfSurfaces < 4:
    print('did not load the file properly')
    exit()

# run a sequential ray trace
maxrays = 4;        # let's trace the 4 marginal rays
tool = TheSystem.Tools.OpenBatchRayTrace();
normUnpol = tool.CreateNormUnpol(maxrays, ZOSAPI.Tools.RayTrace.RaysType.Real, TheSystem.LDE.NumberOfSurfaces - 1)

# pass raytracer to dll
reader = BatchRayTrace.ReadNormUnpolData(tool, normUnpol)
reader.ClearData();

# initialize the output (the number of indices in the output array is maxseg*maxseg
maxseg = 2;
rays = reader.InitializeOutput(maxseg);

# add the 4 full field marginal rays
reader.AddRay(2, 
    [0, 0, 0, 0], 
    [1, 1, 1, 1], 
    [1, -1, 0, 0], 
    [0, 0, 1, -1], Enum.Parse(ZOSAPI.Tools.RayTrace.OPDMode, 'None'));

# read the segments (array length is maxsegs * max segs)
isfinished = False
while not isfinished:
    segments = reader.ReadNextBlock(rays)
    if segments == 0:
        isfinished = True

# print the rays
print(list(rays.X))
print(list(rays.Y))

# always close your tools
tool.Close();

1 Attachments
~Michael
J
1 person likes this
  • J
    Jaren.Ashcraft
J
Forum|alt.badge.img+1

Hi Michael,

Thanks for your reply, I was able to get your example file working! Just had to install zos-api from pip

I didn’t see the option to Unblock the raytrace.dll file. I thought I was on my administrator account so I expected to see something similar, but my Properties window did not have this option:


I had another question if you don’t mind enlightening me - I see the line where the dll is loaded, and where the clr package adds it as a reference. But I don’t see any lines where the dll is used by the raytracer.

Does the OpenBatchRayTrace method implicitly use the Raytrace.dll when it is imported?

MichaelH
Ansys Staff
Forum|alt.badge.img+2
  • MichaelH
  • Ansys Staff
  • 356 replies
  • June 7, 2022

Hi Jaren,

The DLL is loaded with the lines:

# import the raytrace namespace
import BatchRayTrace;

And the DLL is first used with the lines:

# pass raytracer to dll
reader = BatchRayTrace.ReadNormUnpolData(tool, normUnpol)
reader.ClearData();

The OpenBatchRayTrace doesn’t use the RayTrace.dll; rather the RayTrace.dll uses the OpenBatchRayTrace interface.  The tool argument that is passed into the BatchRayTrace.ReadNormUnpolData is actually a reference to the OpenBatchRayTrace interface.

~Michael
S
  • seonho.lee
  • Single Emitter
  • 2 replies
  • April 18, 2025

Hello MichaelH,

 

I am a beginner of programing.

When I run your code in PyCharm, I get an error on the line import BatchRayTrace. Do I need to download the BatchRayTrace.dll file separately? 

If so, where can I download it from?

Reply


Community Posting GuidelinesCookie settings

Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie 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