## On this page # PythonStandalone\_01\_new\_file\_and\_quickfocus 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](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml)() 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 146 \# creates a new API directory 147 if not os.path.exists(TheApplication.SamplesDir + "\\\\API\\\\Python"): 148 os.makedirs(TheApplication.SamplesDir + "\\\\API\\\\Python") 149 150 \# Set up primary optical system 151 sampleDir = TheApplication.SamplesDir 152 153 \#! \[e01s01\_py\] 154 \# Make new file 155 testFile = os.path.join(os.sep, sampleDir, r'API\\Python\\e01\_new\_file\_and\_quickfocus.zos') 156 TheSystem.New(False) 157 TheSystem.SaveAs(testFile) 158 \#! \[e01s01\_py\] 159 160 TheSystem.SystemData.MaterialCatalogs.AddCatalog('SCHOTT') 161 162 \#! \[e01s02\_py\] 163 \# Aperture 164 TheSystemData = TheSystem.SystemData 165 TheSystemData.Aperture.ApertureValue = 40 166 \#! \[e01s02\_py\] 167 168 \#! \[e01s03\_py\] 169 \# Fields 170 Field_1 = TheSystemData.Fields.GetField(1) 171 NewField_2 = TheSystemData.Fields.AddField(0, 5.0, 1.0) 172 \#! \[e01s03\_py\] 173 174 \#! \[e01s04\_py\] 175 \# Wavelength preset 176 slPreset = TheSystemData.Wavelengths.SelectWavelengthPreset(ZOSAPI.SystemData.WavelengthPreset.d_0p587) 177 \#! \[e01s04\_py\] 178 179 \#! \[e01s05\_py\] 180 \# Lens data 181 TheLDE = TheSystem.LDE 182 TheLDE.InsertNewSurfaceAt(2) 183 TheLDE.InsertNewSurfaceAt(2) 184 Surface_1 = TheLDE.GetSurfaceAt(1) 185 Surface_2 = TheLDE.GetSurfaceAt(2) 186 Surface_3 = TheLDE.GetSurfaceAt(3) 187 \#! \[e01s05\_py\] 188 189 \#! \[e01s06\_py\] 190 \# Changes surface cells in LDE 191 Surface_1.Thickness = 50.0 192 Surface_1.Comment = 'Stop is free to move' 193 Surface_2.Radius = 100.0 194 Surface_2.Thickness = 10.0 195 Surface_2.Comment = 'front of lens' 196 Surface_2.Material = 'N-BK7' 197 Surface_3.Comment = 'rear of lens' 198 \#! \[e01s06\_py\] 199 200 \#! \[e01s07\_py\] 201 \# Solver 202 Solver = Surface_3.RadiusCell.CreateSolveType(ZOSAPI.Editors.SolveType.FNumber) 203 SolverFNumber = Solver._S_FNumber 204 SolverFNumber.FNumber = 10 205 Surface_3.RadiusCell.SetSolveData(Solver) 206 \#! \[e01s07\_py\] 207 208 \#! \[e01s08\_py\] 209 \# QuickFocus 210 quickFocus = TheSystem.Tools.OpenQuickFocus() 211 quickFocus.Criterion = ZOSAPI.Tools.General.QuickFocusCriterion.SpotSizeRadial 212 quickFocus.UseCentroid = True 213 quickFocus.RunAndWaitForCompletion() 214 quickFocus.Close() 215 \#! \[e01s08\_py\] 216 217 \#! \[e01s09\_py\] 218 \# Save and close 219 TheSystem.Save() 220 \#! \[e01s09\_py\] 221 222 \# This will clean up the connection to OpticStudio. 223 \# Note that it closes down the server instance of OpticStudio, so you for maximum performance do not do 224 \# this until you need to. 225 del zos 226 zos = None [ZOSAPI.ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml) **Definition:** ZemaxService.cs:198