## On this page # Example 04 - C# Last update: 17.07.2025 # C# using System; using [ZOSAPI](namespace_z_o_s_a_p_i.xhtml); using [ZOSAPI.Analysis](namespace_z_o_s_a_p_i_1_1_analysis.xhtml); using [ZOSAPI.Analysis.Data](namespace_z_o_s_a_p_i_1_1_analysis_1_1_data.xhtml); using [ZOSAPI.Analysis.Settings.Mtf](namespace_z_o_s_a_p_i_1_1_analysis_1_1_settings_1_1_mtf.xhtml); namespace CSharpStandaloneApplication { class Program { static void Main(string[] args) { // Find the installed version of OpticStudio bool isInitialized = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize(); // Note -- uncomment the following line to use a custom initialization path //bool isInitialized = ZOSAPI\_NetHelper.ZOSAPI\_Initializer.Initialize(@"C:\\Program Files\\OpticStudio\\"); if (isInitialized) { LogInfo("Found OpticStudio at: " + ZOSAPI_NetHelper.ZOSAPI_Initializer.GetZemaxDirectory()); } else { HandleError("Failed to locate OpticStudio!"); return; } BeginStandaloneApplication(); } static void BeginStandaloneApplication() { // Create the initial connection class [ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml) TheConnection = new [ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml)(); // Attempt to create a Standalone connection [IZOSAPI\_Application](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml) TheApplication = TheConnection.[CreateNewApplication](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml#aadc54af7d7415a765592acf23d3a08ef)(); if (TheApplication == null) { HandleError("An unknown connection error occurred!"); return; } // Check the connection status if (!TheApplication.[IsValidLicenseForAPI](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#a5b8d6c216c668d13d6dcb870698c247f)) { HandleError("Failed to connect to OpticStudio: " + TheApplication.[LicenseStatus](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#a95179eb8038b629caa12397723aacb3a)); return; } if (TheApplication.[Mode](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#a8d2a89bafe9778c14f592276e5a5eb19) != [ZOSAPI\_Mode](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2a).Server) { HandleError("User plugin was started in the wrong mode: expected Server, found " + TheApplication.[Mode](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#a8d2a89bafe9778c14f592276e5a5eb19).ToString()); return; } [IOpticalSystem](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml) TheSystem = TheApplication.[PrimarySystem](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#aca8045fe84351622e0ee58814a2a3364); // Add your custom code here... // creates new directory string strPath = System.IO.Path.Combine(TheApplication.[SamplesDir](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#ae8fc2a9409927955cc362f9262b052bb), @"API\\CS"); System.IO.Directory.CreateDirectory(strPath); // Set up primary optical system string sampleDir = TheApplication.[SamplesDir](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#ae8fc2a9409927955cc362f9262b052bb); // Open file string testFile = sampleDir + "\\\\Sequential\\\\Objectives\\\\Cooke 40 degree field.zos"; TheSystem.[LoadFile](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml#a6eb1455ac53555ae6f30032d85b63735)(testFile, false); // Create analysis [IA\_](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml) newWin = TheSystem.[Analyses](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml#a830cf50c046528c752605eea3cf5e899).New_FftMtf(); // Settings [IAS\_FftMtf](interface_z_o_s_a_p_i_1_1_analysis_1_1_settings_1_1_mtf_1_1_i_a_s___fft_mtf.xhtml) newWin_Settings = newWin.[GetSettings](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml#af82c93423d06452642e5cb31203cc109)() as [IAS\_FftMtf](interface_z_o_s_a_p_i_1_1_analysis_1_1_settings_1_1_mtf_1_1_i_a_s___fft_mtf.xhtml); newWin_Settings.MaximumFrequency = 50; newWin_Settings.SampleSize = [SampleSizes](namespace_z_o_s_a_p_i_1_1_analysis.xhtml#a479044c3e49c63d5670e891fccffe840).S_256x256; // Run Analysis newWin.[ApplyAndWaitForCompletion](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml#aff285af72f196b9c4915c531ff9873a4)(); [IAR\_](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml) newWin_Results = newWin.[GetResults](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml#a4c6f286eaffe67e97984cf1f91cc5cef)(); // Read data series System.Text.StringBuilder sbReport = new System.Text.StringBuilder(); sbReport.Append("X Data\\t"); for (int i = 0; i < newWin_Results.[NumberOfDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#a9927f175c0167aefcb103b77f255ad80); i++) { sbReport.Append("Series " + i + "\\t\\t"); } sbReport.AppendLine(""); for (int k = 0; k < newWin_Results.[GetDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#ad3e069c5493976ca2654839e7bc23d7f)(0).XData.Length; k++) { sbReport.Append(newWin_Results.[GetDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#ad3e069c5493976ca2654839e7bc23d7f)(0).[XData](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r___data_series.xhtml#a83aaff0e2b0dd0794b9c6f22e5c89f3d).GetValueAt(k) + "\\t"); for (int i = 0; i < newWin_Results.[NumberOfDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#a9927f175c0167aefcb103b77f255ad80); i++) { for (int j = 0; j < newWin_Results.[GetDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#ad3e069c5493976ca2654839e7bc23d7f)(i).NumSeries; j++) { sbReport.Append(newWin_Results.[GetDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#ad3e069c5493976ca2654839e7bc23d7f)(i).[YData](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r___data_series.xhtml#a7724e43c32625fdb176d9130f20ce5ee).GetValueAt(k, j) + "\\t"); } } sbReport.AppendLine(""); } string resFile = TheApplication.SamplesDir + "\\\\API\\\\CS\\\\e04\_pull\_data\_from\_FFTMT.txt"; System.IO.File.WriteAllText(resFile, sbReport.ToString()); Console.WriteLine("Press any key to continue..."); Console.ReadKey(); // Clean up FinishStandaloneApplication(TheApplication); } static void FinishStandaloneApplication([IZOSAPI\_Application](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml) TheApplication) { // Note - TheApplication will close automatically when this application exits, so this isn't strictly necessary in most cases if (TheApplication != null) { TheApplication.[CloseApplication](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#ab662a3cc1b97d8632a324b1137fa943b)(); } } static void LogInfo(string message) { // TODO - add custom logging Console.WriteLine(message); } static void HandleError(string errorMessage) { // TODO - add custom error handling throw new Exception(errorMessage); } } } [ZOSAPI.ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml) **Definition:** ZemaxService.cs:198 [ZOSAPI.ZOSAPI\_Connection.CreateNewApplication](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml#aadc54af7d7415a765592acf23d3a08ef) IZOSAPI_Application CreateNewApplication() Attempts to launch a new instance of Optic Studio in 'headless' mode. Note that although the Optic St... **Definition:** ZemaxService.cs:864 [ZOSAPI.Analysis.Data.IAR\_DataSeries.YData](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r___data_series.xhtml#a7724e43c32625fdb176d9130f20ce5ee) IMatrixData YData **Definition:** IAR_Base.cs:381 [ZOSAPI.Analysis.Data.IAR\_DataSeries.XData](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r___data_series.xhtml#a83aaff0e2b0dd0794b9c6f22e5c89f3d) IVectorData XData **Definition:** IAR_Base.cs:377 [ZOSAPI.Analysis.Data.IAR\_](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml) Properties and methods for retrieving analysis window data. This interface can be accessed via the IA... **Definition:** IAR_Base.cs:21 [ZOSAPI.Analysis.Data.IAR\_.NumberOfDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#a9927f175c0167aefcb103b77f255ad80) int NumberOfDataSeries **Definition:** IAR_Base.cs:57 [ZOSAPI.Analysis.Data.IAR\_.GetDataSeries](interface_z_o_s_a_p_i_1_1_analysis_1_1_data_1_1_i_a_r__.xhtml#ad3e069c5493976ca2654839e7bc23d7f) IAR_DataSeries GetDataSeries(int index) [ZOSAPI.Analysis.IA\_](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml) Base interface for all analysis windows. This interface can be accessed via the I_Analyses interface. **Definition:** IA_Base.cs:29 [ZOSAPI.Analysis.IA\_.GetResults](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml#a4c6f286eaffe67e97984cf1f91cc5cef) IAR_ GetResults() Gets the result data (if available) for the current analysis. [ZOSAPI.Analysis.IA\_.GetSettings](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml#af82c93423d06452642e5cb31203cc109) IAS_ GetSettings() Gets the settings for the current analysis. [ZOSAPI.Analysis.IA\_.ApplyAndWaitForCompletion](interface_z_o_s_a_p_i_1_1_analysis_1_1_i_a__.xhtml#aff285af72f196b9c4915c531ff9873a4) IMessage ApplyAndWaitForCompletion() Re-runs the analysis with the current settings and waits for it to finish calculating. [ZOSAPI.Analysis.Settings.Mtf.IAS\_FftMtf](interface_z_o_s_a_p_i_1_1_analysis_1_1_settings_1_1_mtf_1_1_i_a_s___fft_mtf.xhtml) **Definition:** IAS_FftMtf.cs:29 [ZOSAPI.IOpticalSystem](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml) Represent a complete optical system. A IOpticalSystem corresponds to a single .ZMX file.... **Definition:** Interfaces.cs:687 [ZOSAPI.IOpticalSystem.LoadFile](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml#a6eb1455ac53555ae6f30032d85b63735) bool LoadFile(string LensFile, bool saveIfNeeded) Replaces the current system with data from the specified file. [ZOSAPI.IOpticalSystem.Analyses](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml#a830cf50c046528c752605eea3cf5e899) I_Analyses Analyses Gets the analyses for the current system. **Definition:** Interfaces.cs:925 [ZOSAPI.IZOSAPI\_Application](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml) This interface contains all information about the current ZOS-API connection, as well as methods for ... **Definition:** Interfaces.cs:261 [ZOSAPI.IZOSAPI\_Application.IsValidLicenseForAPI](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#a5b8d6c216c668d13d6dcb870698c247f) bool IsValidLicenseForAPI Gets a value indicating whether this the API is currently useable. **Definition:** Interfaces.cs:287 [ZOSAPI.IZOSAPI\_Application.Mode](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#a8d2a89bafe9778c14f592276e5a5eb19) ZOSAPI_Mode Mode Gets the current connetion mode. Use this to check if Optic Studio is expecting a user operand / anal... **Definition:** Interfaces.cs:306 [ZOSAPI.IZOSAPI\_Application.LicenseStatus](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#a95179eb8038b629caa12397723aacb3a) LicenseStatusType LicenseStatus Gets the license status. Note that this displays the license edition if successful,... **Definition:** Interfaces.cs:280 [ZOSAPI.IZOSAPI\_Application.CloseApplication](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#ab662a3cc1b97d8632a324b1137fa943b) void CloseApplication() Shut down the Optic Studio process. [ZOSAPI.IZOSAPI\_Application.PrimarySystem](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#aca8045fe84351622e0ee58814a2a3364) IOpticalSystem PrimarySystem Gets the primary system. When Mode is ZOSAPI_Mode.Server, this will initially be an empty sequential ... **Definition:** Interfaces.cs:328 [ZOSAPI.IZOSAPI\_Application.SamplesDir](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#ae8fc2a9409927955cc362f9262b052bb) string SamplesDir Gets the full path for the current user's samples directory (in the My Documents\Zemax\Samples\ folde... **Definition:** Interfaces.cs:505 [ZOSAPI.Analysis.Data](namespace_z_o_s_a_p_i_1_1_analysis_1_1_data.xhtml) **Definition:** IAR_Base.cs:11 [ZOSAPI.Analysis.Settings.Mtf](namespace_z_o_s_a_p_i_1_1_analysis_1_1_settings_1_1_mtf.xhtml) **Definition:** IAS_ContrastLoss.cs:5 [ZOSAPI.Analysis](namespace_z_o_s_a_p_i_1_1_analysis.xhtml) **Definition:** IAS_FieldCurvatureAndDistortion.cs:5 [ZOSAPI.Analysis.SampleSizes](namespace_z_o_s_a_p_i_1_1_analysis.xhtml#a479044c3e49c63d5670e891fccffe840) SampleSizes **Definition:** I_SampleSizes.cs:13 [ZOSAPI](namespace_z_o_s_a_p_i.xhtml) The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,... **Definition:** IAS_FieldCurvatureAndDistortion.cs:5 [ZOSAPI.ZOSAPI\_Mode](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2a) ZOSAPI_Mode **Definition:** Interfaces.cs:77