ZOS-API interface 2024 R1

PythonStandalone_20_export_CAD_File

Last update: 17.07.2025
1import clr, os, winreg
2from itertools import islice
3
4class PythonStandaloneApplication(object):
5 class LicenseException(Exception):
6 pass
7 class ConnectionException(Exception):
8 pass
9 class InitializationException(Exception):
10 pass
11 class SystemNotPresentException(Exception):
12 pass
13
14 def __init__(self, path=None):
15 # determine location of ZOSAPI_NetHelper.dll & add as reference
16 aKey = winreg.OpenKey(winreg.ConnectRegistry(None, winreg.HKEY_CURRENT_USER), r"Software\Zemax", 0, winreg.KEY_READ)
17 zemaxData = winreg.QueryValueEx(aKey, 'ZemaxRoot')
18 NetHelper = os.path.join(os.sep, zemaxData[0], r'ZOS-API\Libraries\ZOSAPI_NetHelper.dll')
19 winreg.CloseKey(aKey)
20 clr.AddReference(NetHelper)
21 import ZOSAPI_NetHelper
22
23 # Find the installed version of OpticStudio
24 if path is None:
25 isInitialized = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize()
26 else:
27 # Note -- uncomment the following line to use a custom initialization path
28 isInitialized = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize(path)
29
30 # determine the ZOS root directory
31 if isInitialized:
32 dir = ZOSAPI_NetHelper.ZOSAPI_Initializer.GetZemaxDirectory()
33 else:
34 raise PythonStandaloneApplication.InitializationException("Unable to locate Zemax OpticStudio. Try using a hard-coded path.")
35
36 # add ZOS-API referencecs
37 clr.AddReference(os.path.join(os.sep, dir, "ZOSAPI.dll"))
38 clr.AddReference(os.path.join(os.sep, dir, "ZOSAPI_Interfaces.dll"))
39 import ZOSAPI
40
41 # create a reference to the API namespace
42 self.ZOSAPI = ZOSAPI
43
44 # create a reference to the API namespace
45 self.ZOSAPI = ZOSAPI
46
47 # Create the initial connection class
48 self.TheConnection = ZOSAPI.ZOSAPI_Connection()
49
50 if self.TheConnection is None:
51 raise PythonStandaloneApplication.ConnectionException("Unable to initialize .NET connection to ZOSAPI")
52
53 self.TheApplication = self.TheConnection.CreateNewApplication()
54 if self.TheApplication is None:
55 raise PythonStandaloneApplication.InitializationException("Unable to acquire ZOSAPI application")
56
57 if self.TheApplication.IsValidLicenseForAPI == False:
58 raise PythonStandaloneApplication.LicenseException("License is not valid for ZOSAPI use")
59
60 self.TheSystem = self.TheApplication.PrimarySystem
61 if self.TheSystem is None:
62 raise PythonStandaloneApplication.SystemNotPresentException("Unable to acquire Primary system")
63
64 def __del__(self):
65 if self.TheApplication is not None:
66 self.TheApplication.CloseApplication()
67 self.TheApplication = None
68
69 self.TheConnection = None
70
71 def OpenFile(self, filepath, saveIfNeeded):
72 if self.TheSystem is None:
73 raise PythonStandaloneApplication.SystemNotPresentException("Unable to acquire Primary system")
74 self.TheSystem.LoadFile(filepath, saveIfNeeded)
75
76 def CloseFile(self, save):
77 if self.TheSystem is None:
78 raise PythonStandaloneApplication.SystemNotPresentException("Unable to acquire Primary system")
79 self.TheSystem.Close(save)
80
81 def SamplesDir(self):
82 if self.TheApplication is None:
83 raise PythonStandaloneApplication.InitializationException("Unable to acquire ZOSAPI application")
84
85 return self.TheApplication.SamplesDir
86
87 def ExampleConstants(self):
88 if self.TheApplication.LicenseStatus == self.ZOSAPI.LicenseStatusType.PremiumEdition:
89 return "Premium"
90 elif self.TheApplication.LicenseStatus == self.ZOSAPI.LicenseStatusTypeProfessionalEdition:
91 return "Professional"
92 elif self.TheApplication.LicenseStatus == self.ZOSAPI.LicenseStatusTypeStandardEdition:
93 return "Standard"
94 else:
95 return "Invalid"
96
97 def reshape(self, data, x, y, transpose = False):
98 """Converts a System.Double[,] to a 2D list for plotting or post processing
99
100 Parameters
101 ----------
102 data : System.Double[,] data directly from ZOS-API
103 x : x width of new 2D list [use var.GetLength(0) for dimension]
104 y : y width of new 2D list [use var.GetLength(1) for dimension]
105 transpose : transposes data; needed for some multi-dimensional line series data
106
107 Returns
108 -------
109 res : 2D list; can be directly used with Matplotlib or converted to
110 a numpy array using numpy.asarray(res)
111 """
112 if type(data) is not list:
113 data = list(data)
114 var_lst = [y] * x;
115 it = iter(data)
116 res = [list(islice(it, i)) for i in var_lst]
117 if transpose:
118 return self.transpose(res);
119 return res
120
121 def transpose(self, data):
122 """Transposes a 2D list (Python3.x or greater).
123
124 Useful for converting mutli-dimensional line series (i.e. FFT PSF)
125
126 Parameters
127 ----------
128 data : Python native list (if using System.Data[,] object reshape first)
129
130 Returns
131 -------
132 res : transposed 2D list
133 """
134 if type(data) is not list:
135 data = list(data)
136 return list(map(list, zip(*data)))
137
138
139if __name__ == '__main__':
140 zos = PythonStandaloneApplication()
141
142 # load local variables
143 ZOSAPI = zos.ZOSAPI
144 TheApplication = zos.TheApplication
145 TheSystem = zos.TheSystem
146 if not os.path.exists(TheApplication.SamplesDir + "\\API\\Python"):
147 os.makedirs(TheApplication.SamplesDir + "\\API\\Python")
148
149 # Load a non-sequential file
150 TheSystem.LoadFile(TheApplication.SamplesDir +'\\Non-Sequential\\Miscellaneous\\Digital_projector_flys_eye_homogenizer.zos', False)
151
152 #! [e20s01_py]
153 # Get interface of IExportCAD
154 ToolExportCAD = TheSystem.Tools.OpenExportCAD()
155 #! [e20s01_py]
156
157 #! [e20s02_py]
158 # default option settings
159 ToolExportCAD.FirstObject = 1
160 ToolExportCAD.LastObject = 8
161 ToolExportCAD.RayLayer = 1
162 ToolExportCAD.LensLayer = 0
163 ToolExportCAD.DummyThickness = 1
164 ToolExportCAD.SplineSegments = ZOSAPI.Tools.General.SplineSegmentsType.N_032
165 ToolExportCAD.FileType = ZOSAPI.Tools.General.CADFileType.STEP
166 ToolExportCAD.Tolerance = ZOSAPI.Tools.General.CADToleranceType.N_TenEMinus4
167 ToolExportCAD.SetCurrentConfiguration()
168 # For other configuration choices, use following methods.
169 # ToolExportCAD.SetConfigurationAllAtOnce()
170 # ToolExportCAD.SetConfigurationAllByFile()
171 # ToolExportCAD.SetConfigurationAllByLayer()
172 # ToolExportCAD.SetSingleConfiguration(1)
173 #! [e20s02_py]
174
175 #! [e20s03_py]
176 # default check boxes settings
177 ToolExportCAD.SurfacesAsSolids = True
178 ToolExportCAD.ScatterNSCRays = False
179 ToolExportCAD.ExportDummySurfaces = False
180 ToolExportCAD.SplitNSCRays = False
181 ToolExportCAD.UsePolarization = False
182 #! [e20s03_py]
183
184 #! [e20s04_py]
185 # set output file name
186 ToolExportCAD.OutputFileName = TheApplication.ObjectsDir + '\\CAD Files\\API_CADexport_sample.step'
187 #! [e20s04_py]
188
189 #! [e20s05_py]
190 # Starting exporting
191 # Run with a 3 minites timeout
192 print('Starting exporting...')
193
194 ToolExportCAD.Run()
195 runstatus = ToolExportCAD.WaitWithTimeout(float(3 * 60))
196
197 # Report the status
198 if runstatus == ZOSAPI.Tools.RunStatus.Completed:
199 print('Completed!')
200 elif runstatus == ZOSAPI.Tools.RunStatus.FailedToStart:
201 print('Failed To Start!')
202 elif runstatus == ZOSAPI.Tools.RunStatus.InvalidTimeout:
203 print('Invalid Timeout')
204 else:
205 print('Timed Out!')
206
207 print('Progress: ', ToolExportCAD.Progress)
208
209 # If the exporting is not completed and can be cancelled, cancel the work
210 if (runstatus != ZOSAPI.Tools.RunStatus.Completed and ToolExportCAD.CanCancel):
211 ToolExportCAD.Cancel()
212
213 # Close the tool
214 ToolExportCAD.Close()
215 #! [e20s05_py]
216
217 # This will clean up the connection to OpticStudio.
218 # Note that it closes down the server instance of OpticStudio, so you for maximum performance do not do
219 # this until you need to.
220 del zos
221 zos = None
ZOSAPI.ZOSAPI_Connection
Definition: ZemaxService.cs:198

Connect with Ansys