zemax与matlab混合编程仿真-使用ZOS-API

tinyheaven

目的：提供一个范例。通过MATLAB，使用ZOS-API执行特定操作。
注：在Python中的类似范例，可以点击http://customers.zemax.com/os/resources/learn/knowledgebase/zosapi-using-python
原链接：http://customers.zemax.com/os/resources/learn/knowledgebase/zosapi-using-matlab?lang=en-US
内容：
1.单光线序列追迹
2.创建NSC（非序列模式）并插入物体
3.在序列模式中改变变量
4.在序列模式中求解
5.插入操作数（索引到10个小数点）
6.使用Filter String(过滤器字符串),运行NSC（非序列模式）追迹
7.从一个ZRD文档中读取数据
8.批量光线（Batch Ray）序列追迹

作者：Michael Humphreys  发布时间：09/20/2016
应用：zemax,zemax-api.net,zemax编程

正文：有关ZOS-API的介绍，请在尝试运行这些代码之前，通过浏览以下资源以获取信息（必要的预备知识）。
Article: ZOS-API.NET: An Overview
Article: How to build and optimize a singlet using ZOS-API with Python
Article: How to create a User Analysis using ZOS-API
Webinar: Matlab & ZOS-API.NET

ZOS-API Matlab用户应该忽略一些内部函数：
AddChild
Equals
GetHashCode
RemoveChild
GetLifetimeService*
RunInternalCommand
ToString
CreateObjRef*
GetType
Disconnect*
InitializeLifetimeService*
标星号的方法会显示很多次，如果这些函数不被正确调用，可能会导致严重的运行问题。

1.序列光线追迹
下面代码将执行序列光线追迹，并将结果输出到output_file.txt。 目前，该API不支持详细的分析结果，因此结果对象将为空。

1. % Single Ray Trace
   
2. TheAnalyses  = TheSystem.Analyses;
   
3. newWin = TheAnalyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.RayTrace);   
   
4. newWin_Settings = newWin.GetSettings();
   
5. newWin_Settings.Hx = 0;
   
6. newWin_Settings.Hy = 1;
   
7. newWin_Settings.Px = 0;
   
8. newWin_Settings.Py = 1;
   
9. newWin_Settings.Wavelength.SetWavelengthNumber(2);
   
10. newWin_Settings.Field.UseAllFields();
    
11. newWin_Settings.Type = ZOSAPI.Analysis.Settings.Aberrations.RayTraceType.DirectionCosines;
    
12. newWin.ApplyAndWaitForCompletion();

复制代码

1. % Get and Save the results
   
2. newWin_Results = newWin.GetResults();
   
3. newWin_Results.GetTextFile('c:\temp\output_file.txt');

复制代码

2.创建NSC（非序列模式）并插入物体
下面代码在Matlab中在非序列模式中创建一个新文件。 样板代码仅用.PrimarySystem，但通过使用此默认序列/非序列模式进行初始化，用户将无法修改正确的编辑器（不管模式是哪种，.LDE和.NCE仍然可用）。

1. % Initializes new NSC system, inserts an object, changes an object type, and saves system
   
2. % Initializes into NSC Mode
   
3. TheSystem = TheApplication.CreateNewSystem(ZOSAPI.SystemType.NonSequential);
   
4. TheApplication.ProgramDir
   
5. 
   
6. % Creates new file
   
7. TheSystem.New(false);
   
8. 
   
9. % Non-sequential component editor & changing object
   
10. TheNCE = TheSystem.NCE;
    
11. Object_1 = TheNCE.InsertNewObjectAt(1);
    
12. Object_2 = TheNCE.GetObjectAt(1);
    
13. oType_1 = Object_1.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.StandardLens);
    
14. Object_1.ChangeType(oType_1);
    
15. 
    
16. % Saving System
    
17. TheSystem.SaveAs('c:\temp\test_file.zmx');

复制代码

3.在序列模式中改变变量
下面的代码在Matlab中插入一个新的曲面，更改曲面类型，并分别将材质和参数1列设置为字符串变量和双变量。

1. % Inserts new lens, changes surface type & changes parameter 1 value
   
2. TheLDE.InsertNewSurfaceAt(1);
   
3. Surface_1 = TheLDE.GetSurfaceAt(1);
   
4. sT=Surface_1.GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.SurfaceType.EvenAspheric);
   
5. Surface_1.ChangeType(sT);
   
6. colVal = Surface_1.GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Material).Col;
   
7. Surface_1.GetCellAt(colVal).Value = 'SF2';
   
8. colVal = Surface_1.GetSurfaceCell(ZOSAPI.Editors.LDE.SurfaceColumn.Par1).Col;
   
9. % can also use .IntegerValue for integers
   
10. Surface_1.GetCellAt(colVal).DoubleValue = 0.1;

复制代码

4.在序列模式中求解
有些属性在Matlab中使用无效字符，被硬编码（hardcoded）到ZOS-API中，例如使用下划线开始属性名称。 例如，在单元格上设置F /＃曲率求解记录为使用_S_FNumber作为属性，但这对于Matlab来说是无效的语法。 要列出给定对象的所有属性，只需在最后，不包含分号情况下，打印出对象，确定属性Matlab特定属性名称，并像通常使用ZOS-API文档一样使用它。

1. % creates the LDE
   
2. TheLDE = TheSystem.LDE;
   
3. Surface_3 = TheLDE.InsertNewSurfaceAt(3);
   
4. 
   
5. % lists the properties of the CreateSolveType method
   
6. Solver = Surface_3.RadiusCell.CreateSolveType(ZOSAPI.Editors.SolveType.FNumber)

复制代码

完整的F数解决方案将如下所示：

1. % creates the LDE
   
2. TheLDE = TheSystem.LDE;
   
3. Surface_3 = TheLDE.InsertNewSurfaceAt(3);
   
4. 
   
5. % lists the properties of the CreateSolveType method
   
6. Solver = Surface_3.RadiusCell.CreateSolveType(ZOSAPI.Editors.SolveType.FNumber);
   
7. Solver.S_FNumber_.FNumber = 10;
   
8. Surface_3.RadiusCell.SetSolveData(Solver);

复制代码

5.插入操作数（索引到10个小数点）
在LDE中对玻璃进行建模时，如果使用TheLDE.GetSurfaceAt（1）.Material属性，LDE将始终为索引返回2个小数位，为阿贝数返回1个小数位。 为了看到更多小数位，必须使用Merit Function来获取值。

1. % Set up primary optical system
   
2. TheSystem = TheApplication.CreateNewSystem(ZOSAPI.SystemType.Sequential);
   
3. surface = 1;
   
4. 
   
5. % creates new file
   
6. TheSystem.New(false);
   
7. TheLDE = TheSystem.LDE;
   
8. 
   
9. % sets surface 1 to N-BK7 and then changes this to a model material
   
10. s1 = TheLDE.GetSurfaceAt(surface);
    
11. s1.Material = 'N-BK7';
    
12. s1.MaterialCell.CreateSolveType(ZOSAPI.Editors.SolveType.MaterialModel);
    
13. 
    
14. % get value directly from LDE (only shows 2 sig figs)
    
15. TheLDE = TheSystem.LDE;
    
16. TheLDE.GetSurfaceAt(surface).Material
    
17. 
    
18. % get value from merit function (shows double precision)
    
19. TheMFE = TheSystem.MFE;
    
20. mfo_1 = TheMFE.InsertNewOperandAt(1);
    
21. mfo_1.ChangeType(ZOSAPI.Editors.MFE.MeritOperandType.INDX);
    
22. mfo_1.GetCellAt(2).IntegerValue = surface;  % surface
    
23. mfo_1.GetCellAt(3).IntegerValue = 1;        % wavelength
    
24. 
    
25. % abbe number by using a boundary operand (independent of wavelength)
    
26. mfo_2 = TheMFE.InsertNewOperandAt(2);
    
27. mfo_2.ChangeType(ZOSAPI.Editors.MFE.MeritOperandType.MXAB);
    
28. mfo_2.GetCellAt(2).IntegerValue = surface;
    
29. mfo_2.GetCellAt(3).IntegerValue = surface;
    
30. 
    
31. % updates the merit function and gets the values for index and abbe
    
32. TheMFE.CalculateMeritFunction();
    
33. index_1 = mfo_1.ValueCell.Value
    
34. abbe_1 = mfo_2.ValueCell.Value

复制代码

6.使用Filter String(过滤器字符串),运行NSC（非序列模式）追迹
这允许用户设置非序列追迹，将过滤器字符串（Filter String）应用于ZRD文件，然后提取检测器（ Detector Viewer）的文本结果。 您可以将property.Filter应用于NSCRayTrace或newDetector_settings属性。 此外，由于OpticStudio在镜头文件所在的当前目录中查找以保存和打开ray数据库，因此ZRD文件的文件位置必须是单独的。 请注意，ZOS-API尚不支持图像输出，因此如果您需要探测器的二维图，则需要在Matlab中重新创建。

1. zrd_file = 'temp4.ZRD'; % this needs to be a RELATIVE path
   
2. 
   
3. % Creat ray trace & modify settings
   
4. NSCRayTrace = TheSystem.Tools.OpenNSCRayTrace();
   
5. NSCRayTrace.SplitNSCRays = true;
   
6. NSCRayTrace.ScatterNSCRays = false;
   
7. NSCRayTrace.UsePolarization = true;
   
8. NSCRayTrace.IgnoreErrors = true;
   
9. NSCRayTrace.SaveRays = true;
   
10. NSCRayTrace.Filter = 'H2';
    
11. NSCRayTrace.SaveRaysFile = zrd_file;
    
12. 
    
13. % Run ray trace
    
14. NSCRayTrace.RunAndWaitForCompletion();
    
15. NSCRayTrace.Close();
    
16. 
    
17. % initializes Detector Viewer, saves the ZRD file & applies a Filter
    
18. TheAnalyses = TheSystem.Analyses;
    
19. newDetector = TheAnalyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.DetectorViewer);
    
20. newDetector_settings = newDetector.GetSettings();
    
21. newDetector_settings.RayDatabaseFilename = zrd;
    
22. newDetector.ApplyAndWaitForCompletion();
    
23. 
    
24. % saves the Detector Viewer results
    
25. newDetector_results = newDetector.GetResults();
    
26. newDetector_results.GetTextFile('c:\temp\detector_viewer.txt');

复制代码

7.从一个ZRD文档中读取数据
这允许用户打开任何ZRD文件并提取您将以非序列模式从Ray Database Viewer中获取的相同信息。 请注意，Matlab不像编译代码那样快速读取像ZRD这样的大文件，所以Matlab比OpticStudio处理ZRD要花费更长的时间（以1-2个数量级）。 在编译的API代码中实现此解决方案（例如使用C＃/ C ++语言）将会提高性能。

1. % Set up primary optical system
   
2. TheSystem = TheApplication.CreateNewSystem(ZOSAPI.SystemType.NonSequential);
   
3. TheAnalyses  = TheSystem.Analyses;
   
4. 
   
5. % loads and runs ZRD ray database
   
6. zrdFile = 'C:\Temp\nsc.ZRD';
   
7. zrd = TheSystem.Tools.OpenRayDatabaseReader();
   
8. zrd.ZRDFile = zrdFile;
   
9. zrd.RunAndWaitForCompletion();
   
10. zrd_results = zrd.GetResults();
    
11. 
    
12. % reads data from ZRD file
    
13. [success,ray_num,wave,wlum,segs] = zrd_results.ReadNextResult();
    
14. while success > 0
    
15.     fprintf('Ray %i, Wave_Number %i, Wavelength %d, Segs %i, success %d \n',...
    
16.         ray_num,wave,wlum,segs, success);
    
17.     [success,segLevel,segPar,hitObj,HitFace,insideOf,rayStatus,x,y,z,l,m,n,...
    
18.         exr,exi,eyr,eyi,ezr,ezi,intensity,pathLength] = zrd_results.ReadNextSegment();
    
19.     while success > 0
    
20.         fprintf('    Segment: %+e, x: %+e, y: %+e, z: %+e, l: %+e, m: %+e, n: %+e \n',...
    
21.             segLevel,x,y,z,l,m,n);
    
22.         [success,segLevel,segPar,hitObj,HitFace,insideOf,rayStatus,x,y,z,l,m,n,...
    
23.             exr,exi,eyr,eyi,ezr,ezi,intensity,pathLength] = zrd_results.ReadNextSegment();
    
24.     end
    
25.     [success,ray_num,wave,wlum,segs] = zrd_results.ReadNextResult();
    
26. end

复制代码

8.批量光线（Batch Ray）序列追迹
批量光线追迹允许用户通过系统将[Hx，Hy，Px，Py]定义的光线网格追踪到给定的平面。 可以从光线追踪中提取XYZ截距，LMN方向余弦，表面法向量，OPD和强度。 这些数据可以直接从API中提取，而无需将数据写入磁盘。 对于多个曲面，光线追迹应放置在FOR循环中。

1. % Set up Batch Ray Trace
   
2. raytrace = TheSystem.Tools.OpenBatchRayTrace();
   
3. nsur = TheSystem.LDE.NumberOfSurfaces - 1;
   
4. max_rays = 2; % number of rays to be traced minus 1 (will always trace hy=0 and hy=1)
   
5. normUnPolData = raytrace.CreateNormUnpol(max_rays + 1,ZOSAPI.Tools.RayTrace.RaysType.Real,nsur);
   
6. normUnPolData.ClearData();
   
7. 
   
8. % Adding Rays to Batch, varying normalised object height hy
   
9. waveNumber=2; hx = 0; px = 0; py = 0;
   
10. hy_ary = [0:(1 / max_rays):1];
    
11. for i = 1:max_rays+1
    
12.     normUnPolData.AddRay(waveNumber, hx, hy_ary(:,i), px, py, ...
    
13.         ZOSAPI.Tools.RayTrace.OPDMode.CurrentAndChief);
    
14. end
    
15. 
    
16. % Run Batch Ray Trace
    
17. raytrace.RunAndWaitForCompletion();
    
18. 
    
19. % Read and display results
    
20. normUnPolData.StartReadingResults();
    
21. fprintf('All results use hx=%4.2f, px=%4.2f, py=%4.2f\n', hx, px, py);
    
22. for i= 1:max_rays+1
    
23.     [success, rayNumber, errCode, vigCode, x, y, z, l, m, n, l2, m2, n2,...
    
24.         opd, intensity] = normUnPolData.ReadNextResult();
    
25.     if success == 1
    
26.         fprintf('Ray Number %i, hy=%4.2f, Error Code %i, Vignette Code %i\n', ...
    
27.             rayNumber, hy_ary(:,i), errCode, vigCode);
    
28.         if errCode == 0
    
29.             fprintf('    x %5.2f, y %5.2f, z %5.2f, l %5.2f, m %5.2f, n %5.2f, ',...
    
30.                 x, y, z, l, m, n);
    
31.             fprintf('l2 %5.2f, m2 %5.2f, n2 %5.2f, opd %5.2f, intensity %5.2f\n', ...
    
32.                 l2, m2, n2, opd, intensity);
    
33.         end
    
34.     else
    
35.         fprintf('Ray trace for %i unsuccessful', i)
    
36.     end
    
37. end

复制代码

tinyheaven

先占个坑，后期有空运行一下再总结。

1228

用MATLAB来编程处理zemax里面的数据可以做到zemax宏做不到的事情吗，或者有什么优点呢？现在用过的就是matlab曲线拟合zemax里面的数据，而zemax做不到。自己可能也接触的比较少。

雪坼寒宵

你好！请问zemax大量光线追迹支持模式1吗？相当于getTraceDirect,设置起始坐标，方向余弦等。因为我看到的资料都是模式0的。而且Matlab-zemax工具箱里也只有模式0的参数设置函数。

tinyheaven

雪坼寒宵 发表于 2018-7-13 15:27
你好！请问zemax大量光线追迹支持模式1吗？相当于getTraceDirect,设置起始坐标，方向余弦等。因为我看到的 ...

不好意思，我只是负责翻译的。具体的还没有研究过。

tinyheaven

qq305042523 发表于 2018-5-13 13:34
用MATLAB来编程处理zemax里面的数据可以做到zemax宏做不到的事情吗，或者有什么优点呢？现在用过的就是matl ...

不好意思，我只是负责翻译的。具体的还没有研究过。
但是matlab的数据处理功能确实相当强大。

雪坼寒宵

tinyheaven 发表于 2018-7-14 09:49
不好意思，我只是负责翻译的。具体的还没有研究过。
但是matlab的数据处理功能确实相当强大。

哦，我也是刚刚接触，而且我不是学光学的，但是我的项目涉及这方面内容，我也是在摸索，一头雾水啊。。。

tinyheaven

雪坼寒宵 发表于 2018-7-16 11:38
哦，我也是刚刚接触，而且我不是学光学的，但是我的项目涉及这方面内容，我也是在摸索，一头雾水啊。。。 ...

你可以把自己的问题整理一下，另开一个帖子啊。我们的论坛很喜欢这种有实际项目涉及的问题。

tinyheaven

雪坼寒宵 发表于 2018-7-16 11:38
哦，我也是刚刚接触，而且我不是学光学的，但是我的项目涉及这方面内容，我也是在摸索，一头雾水啊。。。 ...

你可以自己把问题整理一下另开一个帖子。
我们的站友都很热心的。

雪坼寒宵

tinyheaven 发表于 2018-7-17 08:48
你可以自己把问题整理一下另开一个帖子。
我们的站友都很热心的。

谢谢，已经开了一个提问帖，但还没有人回答。