PythonStandalone_14_Seq_Tolerance
Last update: 16.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
138if __name__ == '__main__':
139 zos = PythonStandaloneApplication()
140
141 # load local variables
142 ZOSAPI = zos.ZOSAPI
143 TheApplication = zos.TheApplication
144 TheSystem = zos.TheSystem
145 if not os.path.exists(TheApplication.SamplesDir + "\\API\\Python"):
146 os.makedirs(TheApplication.SamplesDir + "\\API\\Python")
147
148 #! [e14s01_py]
149 # Open Double Gauss sample file
150 samplesFolder = TheApplication.SamplesDir
151 DGfile = samplesFolder + r"\Sequential\Objectives\Double Gauss 28 degree field.zos"
152 TheSystem.LoadFile(DGfile, False)
153 #! [e14s01_py]
154
155 #! [e14s02_py]
156 # Set up Tolerance Wizard and run it
157 tWiz = TheSystem.TDE.SEQToleranceWizard
158
159 # Specify surface tolerances
160 tWiz.SurfaceRadius = 0.1
161 tWiz.SurfaceThickness = 0.1
162 tWiz.SurfaceDecenterX = 0.1
163 tWiz.SurfaceDecenterY = 0.1
164 tWiz.SurfaceTiltX = 0.2
165 tWiz.SurfaceTiltY = 0.2
166 # Specify element tolerances
167 tWiz.ElementDecenterX = 0.1
168 tWiz.ElementDecenterY = 0.1
169 tWiz.ElementTiltXDegrees = 0.2
170 tWiz.ElementTiltYDegrees = 0.2
171 # Specify tolerances not to be used
172 tWiz.IsSurfaceSandAIrregularityUsed = False
173 tWiz.IsIndexUsed = False
174 tWiz.IsIndexAbbePercentageUsed = False
175 tWiz.OK()
176 #! [e14s02_py]
177
178 #! [e14s03_py]
179 # Create a "Double Gauss" folder in the Samples folder
180 import os
181 dirLoc = samplesFolder + "\\API\\Python\\e14_seq_tolerance"
182 if not os.path.exists(dirLoc):
183 os.makedirs(dirLoc)
184 # Save new file to Double Gauss folder
185 fileNameSeq = dirLoc + "\\Double Gauss (seq).zos"
186 TheSystem.SaveAs(fileNameSeq)
187 #! [e14s03_py]
188 print('File saved: %s' % fileNameSeq)
189
190 #! [e14s04_py]
191 # Set up Tolerancing analysis and run it
192 tol = TheSystem.Tools.OpenTolerancing()
193 # Select Sensitivity mode
194 tol.SetupMode = ZOSAPI.Tools.Tolerancing.SetupModes.Sensitivity
195 # Select Criterion and related settings
196 tol.Criterion = ZOSAPI.Tools.Tolerancing.Criterions.RMSSpotRadius
197 tol.CriterionSampling = 3
198 tol.CriterionComp = ZOSAPI.Tools.Tolerancing.CriterionComps.OptimizeAll_DLS
199 tol.CriterionCycle = 2
200 tol.CriterionField = ZOSAPI.Tools.Tolerancing.CriterionFields.UserDefined
201 # Select number of MC runs and files to save
202 tol.NumberOfRuns = 20
203 tol.NumberToSave = 20
204 # Run the Tolerancing analysis
205 tol.RunAndWaitForCompletion()
206 tol.Close()
207 #! [e14s04_py]
208
209 #! [e14s05_py]
210 # Convert file to Non-sequential mode
211 convertNSmode = TheSystem.Tools.OpenConvertToNSCGroup()
212 convertNSmode.ConvertFileToNSC = True
213 convertNSmode.RunAndWaitForCompletion()
214 convertNSmode.Close();
215 # Save the Non-sequential file to the Double Gauss folder
216 fileNameNS = dirLoc + "\\Double Gauss (NS).zos"
217 TheSystem.SaveAs(fileNameNS)
218 #! [e14s05_py]
219 print('File saved: %s' % fileNameNS)
220
221 # This will clean up the connection to OpticStudio.
222 # Note that it closes down the server instance of OpticStudio, so you for maximum performance do not do
223 # this until you need to.
224 del zos
225 zos = None
Definition: ZemaxService.cs:198
