PythonStandalone_18_SetMulticonfiguration
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
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 # Setup
149 TheSystem.LoadFile(TheApplication.SamplesDir + "\Sequential\Objectives\Double Gauss 28 degree field.zos", False)
150 TheMCE = TheSystem.MCE
151
152 #! [e18s01_py]
153 # Add 2 configurations (totally 3)
154 TheMCE.AddConfiguration(False)
155 TheMCE.AddConfiguration(False)
156 #! [e18s01_py]
157
158 #! [e18s02_py]
159 # Add one operand (totally 2)
160 TheMCE.AddOperand()
161 #! [e18s02_py]
162
163 #! [e18s03_py]
164 # Get interface of each operand
165 MCOperand1 = TheMCE.GetOperandAt(1)
166 MCOperand2 = TheMCE.GetOperandAt(2)
167 # Change both operands' type to THIC
168 MCOperand1.ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC)
169 MCOperand2.ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC)
170 #! [e18s03_py]
171
172 #! [e18s04_py]
173 # Set parameters of operands
174 # If the type of operand is THIC, the first parameter here means surface number
175 MCOperand1.Param1 = 0
176 MCOperand2.Param1 = 11
177 #! [e18s04_py]
178
179 #! [e18s05_py]
180 # Set values of operand for each configuration
181 MCOperand1.GetOperandCell(1).DoubleValue = 10000.0
182 MCOperand1.GetOperandCell(2).DoubleValue = 5000.0
183 MCOperand1.GetOperandCell(3).DoubleValue = 1000.0
184 #! [e18s05_py]
185
186 #! [e18s06_py]
187 # Refocus for each configuration
188 quickfocus = TheSystem.Tools.OpenQuickFocus()
189 TheMCE.SetCurrentConfiguration(1) # Set system to config 1
190 quickfocus.RunAndWaitForCompletion() # Quick focus for config 1
191 TheMCE.SetCurrentConfiguration(2)
192 quickfocus.RunAndWaitForCompletion()
193 TheMCE.SetCurrentConfiguration(3)
194 quickfocus.RunAndWaitForCompletion()
195 #! [e18s06_py]
196
197 TheSystem.SaveAs(TheApplication.SamplesDir + "\\API\\Python\\e18_Double_Gauss_28_degree_field_MultiConfig.zos")
198
199 #! [e18s07_py]
200 # An example of manually "Make Thermal"
201 TheSystem.LoadFile(TheApplication.SamplesDir + "\Sequential\Objectives\Doublet.zos", False)
202 # Add 1 configuration (totally 2)
203 TheMCE.AddConfiguration(False)
204 # Add 12 operands (totally 13)
205 for i in range(0, 12):
206 TheMCE.AddOperand()
207 # Create an operand type array and later we will input the array into MCE with a for loop
208 operandType = [ZOSAPI.Editors.MCE.MultiConfigOperandType.TEMP, ZOSAPI.Editors.MCE.MultiConfigOperandType.PRES,
209 ZOSAPI.Editors.MCE.MultiConfigOperandType.CRVT, ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC,
210 ZOSAPI.Editors.MCE.MultiConfigOperandType.GLSS, ZOSAPI.Editors.MCE.MultiConfigOperandType.SDIA,
211 ZOSAPI.Editors.MCE.MultiConfigOperandType.CRVT, ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC,
212 ZOSAPI.Editors.MCE.MultiConfigOperandType.GLSS, ZOSAPI.Editors.MCE.MultiConfigOperandType.SDIA,
213 ZOSAPI.Editors.MCE.MultiConfigOperandType.CRVT, ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC,
214 ZOSAPI.Editors.MCE.MultiConfigOperandType.SDIA]
215 # Set parameter 1 for each config operand
216 param1value = [1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3]
217 for i in range(0, 11):
218 TheMCE.GetOperandAt(i+3).Param1 = param1value[i]
219
220 # Set type for each config operand
221 for i in range(13):
222 TheMCE.GetOperandAt(i+1).ChangeType(operandType[i])
223
224 # Set thermal pickup solves
225 ThermalPickupSolve = TheMCE.GetOperandAt(1).GetOperandCell(1).CreateSolveType(ZOSAPI.Editors.SolveType.ThermalPickup)
226 ThermalPickupSolve._S_ThermalPickup.Configuration = 1
227 ThermalPickup_num = [3, 4, 6, 7, 8, 10, 11, 12, 13]
228 for i in ThermalPickup_num:
229 TheMCE.GetOperandAt(i).GetOperandCell(2).SetSolveData(ThermalPickupSolve)
230
231 # Set Pickup Solve
232 ConfigPickupSolve = TheMCE.GetOperandAt(1).GetOperandCell(1).CreateSolveType(ZOSAPI.Editors.SolveType.ConfigPickup)
233 ConfigPickupSolve._S_ConfigPickup.Configuration = 1
234 GLSSops = [5, 9] # Operands 5 and 9 are GLSS operands
235 for i in GLSSops:
236 ConfigPickupSolve._S_ConfigPickup.Operand = i # Set pickup solve's "operand" value to pickup from correct place
237 TheMCE.GetOperandAt(i).GetOperandCell(2).SetSolveData(ConfigPickupSolve) # apply solve for operands 5 and 9
238
239 # Set temperature of configuration 2 to 100 degrees
240 TheMCE.GetOperandAt(1).GetOperandCell(2).DoubleValue = 100
241 TheSystemData = TheSystem.SystemData
242 TheSystemData.Environment.AdjustIndexToEnvironment = True
243
244 TheSystem.SaveAs(TheApplication.SamplesDir + "\\API\\Python\\e18_Doublet_MakeTermal.zos")
245 #! [e18s07_py]
246 print("Saved 'Doublet_MakeTermal.zos' file")
247
248 # This will clean up the connection to OpticStudio.
249 # Note that it closes down the server instance of OpticStudio, so you for maximum performance do not do
250 # this until you need to.
251 del zos
252 zos = None
Definition: ZemaxService.cs:198
