PythonStandalone_12_Seq_SystemExplorer
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 TheSystem.New(False)
149
150 #! [e12s01_py]
151 # Select 6 wavelengths with Gaussian Quadrature algorithm
152 sysWave = TheSystem.SystemData.Wavelengths
153 sysWave.GaussianQuadrature(0.45, 0.65, ZOSAPI.SystemData.QuadratureSteps.S6)
154 #! [e12s01_py]
155
156 #! [e12s02_py]
157 # Define fields using Paraxial Image Height
158 sysField = TheSystem.SystemData.Fields
159 sysField.SetFieldType(ZOSAPI.SystemData.FieldType.ParaxialImageHeight)
160 #! [e12s02_py]
161
162 # Inserts paraxial lens so there will not be an error message when using ParaxialImageHeight
163 TheSystem.SystemData.Aperture.ApertureValue = 10
164 s1 = TheSystem.LDE.GetSurfaceAt(1)
165 s1_type = s1.GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.SurfaceType.Paraxial)
166 s1.ChangeType(s1_type)
167 s1.Thickness = 100
168
169 #! [e12s03_py]
170 # Change field 1 to be x=1.0 and y=2.0
171 field1 = sysField.GetField(1)
172 field1.X = 1.0
173 field1.Y = 2.0
174 #! [e12s03_py]
175
176 #! [e12s04_py]
177 # Change polarization axis reference to be Y
178 sysPol = TheSystem.SystemData.Polarization
179 sysPol.Method = ZOSAPI.SystemData.PolarizationMethod.YAxisMethod
180 #! [e12s04_py]
181
182 #! [e12s05_py]
183 # Add Corning Catalog and remove Schott Catalog
184 sysCat = TheSystem.SystemData.MaterialCatalogs
185 sysCat.AddCatalog("Corning")
186 sysCat.RemoveCatalog("Schott")
187 #! [e12s05_py]
188
189 #! [e12s06_py]
190 # Add Title and Notes
191 sysTitleNotes = TheSystem.SystemData.TitleNotes
192 sysTitleNotes.Title = "Add Title Here"
193 sysTitleNotes.Notes = "Add Notes Here"
194 #! [e12s06_py]
195
196 #! [e12s07_py]
197 # As default Files choose: COATING.DAT, SCATTER_PROFILE.DAT, AGB_DATA.DAT
198 sysFiles = TheSystem.SystemData.Files
199 #sysFiles_cast = CastTo(sysFiles, "ISDFiles")
200 # Note: These new files must already be present in the correct folder
201 sysFiles.CoatingFile = "COATING.DAT"
202 sysFiles.ScatterProfile = "SCATTER_PROFILE.DAT"
203 sysFiles.ABgDataFile = "ABG_DATA.DAT"
204 sysFiles.ReloadFiles()
205 #! [e12s07_py]
206
207 #! [e12s08_py]
208 # Change lens units to inches
209 sysUnits = TheSystem.SystemData.Units
210 sysUnits.LensUnits = ZOSAPI.SystemData.ZemaxSystemUnits.Inches
211 #! [e12s08_py]
212
213 fileName = TheApplication.SamplesDir + r'\API\Python\e12_seq_system_explorer.zos'
214 TheSystem.SaveAs(fileName)
215 print('Saved file: %s' % fileName)
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
Definition: ZemaxService.cs:198
