PythonStandalone_19_Surface_Properties
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 # This code build a chain of prisms based on the KB article:
149 # http://zemax.com/os/resources/learn/knowledgebase/how-to-work-in-global-coordinates-in-a-sequential
150 TheSystem.New(False)
151
152 #! [e19s01_py]
153 # ISystemData represents the System Explorer in GUI.
154 # We access options in System Explorer through ISystemData in ZOS-API
155 TheSystemData = TheSystem.SystemData
156 TheSystemData.Aperture.ApertureValue = 10
157 TheSystemData.Aperture.AFocalImageSpace = True
158 TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55
159 #! [e19s01_py]
160
161 TheSystem.SystemData.MaterialCatalogs.AddCatalog('SCHOTT');
162
163 #! [e19s02_py]
164 # Get interface of Lens Data Editor and add 3 surfaces.
165 TheLDE = TheSystem.LDE
166 TheLDE.InsertNewSurfaceAt(2)
167 TheLDE.InsertNewSurfaceAt(2)
168 TheLDE.InsertNewSurfaceAt(2)
169
170 # Set thickness and material for each surface.
171 TheLDE.GetSurfaceAt(1).Thickness = 30
172 TheLDE.GetSurfaceAt(2).Thickness = 20
173 TheLDE.GetSurfaceAt(4).Thickness = 30
174 TheLDE.GetSurfaceAt(2).Material = 'N-BK7'
175 #! [e19s02_py]
176
177 #! [e19s03_py]
178 # GetSurfaceAt(surface number shown in LDE) will return an interface ILDERow
179 # Through property TiltDecenterData of each interface ILDERow, we can modify data in Surface Properties > Tilt/Decenter section
180 TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceOrder = ZOSAPI.Editors.LDE.TiltDecenterOrderType.Decenter_Tilt
181 TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceTiltX = 15
182 TheLDE.GetSurfaceAt(2).TiltDecenterData.AfterSurfaceTiltX = -15
183 TheLDE.GetSurfaceAt(3).TiltDecenterData.BeforeSurfaceTiltX = -15
184 TheLDE.GetSurfaceAt(3).TiltDecenterData.AfterSurfaceTiltX = 15
185 #! [e19s03_py]
186
187 #! [e19s04_py]
188 # To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
189 Rect_Aper = TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.RectangularAperture)
190 Rect_Aper._S_RectangularAperture.XHalfWidth = 10
191 Rect_Aper._S_RectangularAperture.YHalfWidth = 10
192 TheLDE.GetSurfaceAt(2).ApertureData.ChangeApertureTypeSettings(Rect_Aper)
193 TheLDE.GetSurfaceAt(3).ApertureData.PickupFrom = 2
194 #! [e19s04_py]
195
196 #! [e19s05_py]
197 # To change surface type, we need to first get an ISurfaceTypesettings and then assign it.
198 SurfaceType_CB = TheLDE.GetSurfaceAt(4).GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.SurfaceType.CoordinateBreak)
199 TheLDE.GetSurfaceAt(4).ChangeType(SurfaceType_CB)
200 #! [e19s05_py]
201
202 #! [e19s06_py]
203 # Set Chief Ray solves to surface 4, which is Coordinate Break
204 # To set a solve to a cell in editor, we need to first create a ISolveData and then assign it.
205 Solve_ChiefNormal = TheLDE.GetSurfaceAt(4).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par1).CreateSolveType(ZOSAPI.Editors.SolveType.PickupChiefRay)
206 TheLDE.GetSurfaceAt(4).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par1).SetSolveData(Solve_ChiefNormal)
207 TheLDE.GetSurfaceAt(4).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par2).SetSolveData(Solve_ChiefNormal)
208 TheLDE.GetSurfaceAt(4).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par3).SetSolveData(Solve_ChiefNormal)
209 TheLDE.GetSurfaceAt(4).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par4).SetSolveData(Solve_ChiefNormal)
210 TheLDE.GetSurfaceAt(4).GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par5).SetSolveData(Solve_ChiefNormal)
211 #! [e19s06_py]
212
213 #! [e19s07_py]
214 # Copy 3 surfaces starting from surface number 2 in LDE and paste to surface number 5, which will become surface number 8 after pasting.
215 for i in range(10):
216 TheLDE.CopySurfaces(2, 3, 5)
217 # Save file
218 TheSystem.SaveAs(TheApplication.SamplesDir + '\\API\\Python\\e19_Sample_Prism_Chain.zos')
219 #! [e19s07_py]
220
221 #! [e19s08_py]
222 # Run tool Convert Local To Global Coordinates to convert surface #2 to surface #35 to be globally referenced to surface #1
223 TheLDE.RunTool_ConvertLocalToGlobalCoordinates(2, 35, 1)
224 TheSystem.SaveAs(TheApplication.SamplesDir + '\\API\\Python\\e19_Sample_Prism_Chain_GlobalCoordinate.zos')
225 #! [e19s08_py]
226
227 #! [e19s09_py]
228 # Run tool Conver Global To Local Coordinates to convert surface #1 to surface #57 back to local coordinate.
229 TheLDE.RunTool_ConvertGlobalToLocalCoordinates(1, 57, ZOSAPI.Editors.LDE.ConversionOrder.Forward)
230 TheSystem.SaveAs(TheApplication.SamplesDir + '\\API\\Python\\e19_Sample_Prism_Chain_BackTo_LocalCoordinate.zos')
231 #! [e19s09_py]
232
233 print("Saved Prism example file")
234
235 # This will clean up the connection to OpticStudio.
236 # Note that it closes down the server instance of OpticStudio, so you for maximum performance do not do
237 # this until you need to.
238 del zos
239 zos = None
Definition: ZemaxService.cs:198
