{"id":368856,"date":"2024-05-28T05:12:03","date_gmt":"2024-05-28T05:12:03","guid":{"rendered":"\/forum\/forums\/topic\/i-am-new-to-use-matlab-zos-api-and-struggling-to-execute-this-file\/"},"modified":"2024-05-28T05:12:03","modified_gmt":"2024-05-28T05:12:03","slug":"i-am-new-to-use-matlab-zos-api-and-struggling-to-execute-this-file","status":"closed","type":"topic","link":"https:\/\/innovationspace.ansys.com\/forum\/forums\/topic\/i-am-new-to-use-matlab-zos-api-and-struggling-to-execute-this-file\/","title":{"rendered":"I am new to use MATLAB ZOS-API and struggling to execute this file."},"content":{"rendered":"
I am trying to carry non-sequential raytracing on a system of mine, I tried using a predefined script that works very well on an existing system but when I replace this with my system I am facing some errors. I am not able to resolve them and don’t know why this is happening.<\/span><\/span><\/div>\n
Here is my code and error,<\/span><\/span><\/div>\n
\n
\n
function <\/span>[ r ] = MATLABStandalone_NSC_ray_trace( args )<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
if <\/span>~exist(<\/span>‘args’<\/span>, <\/span>‘var’<\/span>)<\/span><\/span><\/div>\n<\/div>\n
\n
args = [];<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Initialize the OpticStudio connection<\/span><\/span><\/div>\n<\/div>\n
\n
TheApplication = InitConnection();<\/span><\/span><\/div>\n<\/div>\n
\n
if <\/span>isempty(TheApplication)<\/span><\/span><\/div>\n<\/div>\n
\n
% failed to initialize a connection<\/span><\/span><\/div>\n<\/div>\n
\n
r = [];<\/span><\/span><\/div>\n<\/div>\n
\n
else<\/span><\/span><\/div>\n<\/div>\n
\n
try<\/span><\/span><\/div>\n<\/div>\n
\n
r = BeginApplication(TheApplication, args);<\/span><\/span><\/div>\n<\/div>\n
\n
CleanupConnection(TheApplication);<\/span><\/span><\/div>\n<\/div>\n
\n
catch <\/span>err<\/span><\/span><\/div>\n<\/div>\n
\n
CleanupConnection(TheApplication);<\/span><\/span><\/div>\n<\/div>\n
\n
rethrow(err);<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
function <\/span>[r] = BeginApplication(TheApplication, args)<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
import <\/span>ZOSAPI.*<\/span>;<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% creates a new API directory<\/span><\/span><\/div>\n<\/div>\n
\n
apiPath = System.String.Concat(TheApplication.SamplesDir, <\/span>‘\\API\\Matlab’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
if <\/span>(exist(char(apiPath)) == 0) mkdir(char(apiPath)); <\/span>end<\/span>;<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Set up primary optical system<\/span><\/span><\/div>\n<\/div>\n
\n
TheSystem = TheApplication.PrimarySystem;<\/span><\/span><\/div>\n<\/div>\n
\n
sampleDir = TheApplication.SamplesDir;<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
%! [e02s01_m]<\/span><\/span><\/div>\n<\/div>\n
\n
% Open file<\/span><\/span><\/div>\n<\/div>\n
\n
testFile = System.String.Concat(sampleDir, <\/span>‘”D:\\Practice\\Zemax Practice\\Beam_expander-NONSEQ.zos”‘<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
TheSystem.LoadFile(testFile, false);<\/span><\/span><\/div>\n<\/div>\n
\n
%! [e02s01_m]<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
%! [e02s02_m]<\/span><\/span><\/div>\n<\/div>\n
\n
% Create ray trace<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace = TheSystem.Tools.OpenNSCRayTrace();<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.SplitNSCRays = false;<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.ScatterNSCRays = false;<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.UsePolarization = false;<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.IgnoreErrors = true;<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.SaveRays = false;<\/span><\/span><\/div>\n<\/div>\n
\n
%NSCRayTrace.ClearDetectors(0);<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Run ray trace<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.RunAndWaitForCompletion();<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.Close();<\/span><\/span><\/div>\n<\/div>\n
\n
%! [e02s02_m]<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Non-sequential component editor<\/span><\/span><\/div>\n<\/div>\n
\n
TheNCE = TheSystem.NCE;<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
%! [e02s03_m]<\/span><\/span><\/div>\n<\/div>\n
\n
% Get detector data<\/span><\/span><\/div>\n<\/div>\n
\n
data = NET.createArray(<\/span>‘System.Double’<\/span>, TheNCE.GetDetectorSize(6));<\/span><\/span><\/div>\n<\/div>\n
\n
TheNCE.GetAllDetectorData(6, 1, TheNCE.GetDetectorSize(6), data);<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
[~, rows, cols] = TheNCE.GetDetectorDimensions(6);<\/span><\/span><\/div>\n<\/div>\n
\n
% rotates and flips image to reflect ZOS orientation<\/span><\/span><\/div>\n<\/div>\n
\n
detectorData = flipud(rot90(reshape(data.double, rows, cols)));<\/span><\/span><\/div>\n<\/div>\n
\n
%! [e02s03_m]<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Plot<\/span><\/span><\/div>\n<\/div>\n
\n
close <\/span>all<\/span>;<\/span><\/span><\/div>\n<\/div>\n
\n
figure(<\/span>‘position’<\/span>, [50, 150, 700, 600])<\/span><\/span><\/div>\n<\/div>\n
\n
surf(detectorData);<\/span><\/span><\/div>\n<\/div>\n
\n
axis([1 100 1 100]);<\/span><\/span><\/div>\n<\/div>\n
\n
shading <\/span>flat<\/span>;<\/span><\/span><\/div>\n<\/div>\n
\n
xlabel(<\/span>‘Column #’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
ylabel(<\/span>‘Row #’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
title(<\/span>‘Incoherent Illuminance [lm\/cm^2]’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
colorbar;<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
r = [];<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
function <\/span>app = InitConnection()<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
import <\/span>System.Reflection.*<\/span>;<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Find the installed version of OpticStudio.<\/span><\/span><\/div>\n<\/div>\n
\n
zemaxData = winqueryreg(<\/span>‘HKEY_CURRENT_USER’<\/span>, <\/span>‘Software\\Zemax’<\/span>, <\/span>‘ZemaxRoot’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
NetHelper = strcat(zemaxData, <\/span>‘\\ZOS-API\\Libraries\\ZOSAPI_NetHelper.dll’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
% Note — uncomment the following line to use a custom NetHelper path<\/span><\/span><\/div>\n<\/div>\n
\n
% NetHelper = ‘C:\\Users\\Documents\\Zemax\\ZOS-API\\Libraries\\ZOSAPI_NetHelper.dll’;<\/span><\/span><\/div>\n<\/div>\n
\n
NET.addAssembly(NetHelper);<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
success = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize();<\/span><\/span><\/div>\n<\/div>\n
\n
% Note — uncomment the following line to use a custom initialization path<\/span><\/span><\/div>\n<\/div>\n
\n
% success = ZOSAPI_NetHelper.ZOSAPI_Initializer.Initialize(‘C:\\Program Files\\OpticStudio\\’);<\/span><\/span><\/div>\n<\/div>\n
\n
if <\/span>success == 1<\/span><\/span><\/div>\n<\/div>\n
\n
LogMessage(strcat(<\/span>‘Found OpticStudio at: ‘<\/span>, char(ZOSAPI_NetHelper.ZOSAPI_Initializer.GetZemaxDirectory())));<\/span><\/span><\/div>\n<\/div>\n
\n
else<\/span><\/span><\/div>\n<\/div>\n
\n
app = [];<\/span><\/span><\/div>\n<\/div>\n
\n
return<\/span>;<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Now load the ZOS-API assemblies<\/span><\/span><\/div>\n<\/div>\n
\n
NET.addAssembly(AssemblyName(<\/span>‘ZOSAPI_Interfaces’<\/span>));<\/span><\/span><\/div>\n<\/div>\n
\n
NET.addAssembly(AssemblyName(<\/span>‘ZOSAPI’<\/span>));<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Create the initial connection class<\/span><\/span><\/div>\n<\/div>\n
\n
TheConnection = ZOSAPI.ZOSAPI_Connection();<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% Attempt to create a Standalone connection<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% NOTE – if this fails with a message like ‘Unable to load one or more of<\/span><\/span><\/div>\n<\/div>\n
\n
% the requested types’, it is usually caused by try to connect to a 32-bit<\/span><\/span><\/div>\n<\/div>\n
\n
% version of OpticStudio from a 64-bit version of MATLAB (or vice-versa).<\/span><\/span><\/div>\n<\/div>\n
\n
% This is an issue with how MATLAB interfaces with .NET, and the only<\/span><\/span><\/div>\n<\/div>\n
\n
% current workaround is to use 32- or 64-bit versions of both applications.<\/span><\/span><\/div>\n<\/div>\n
\n
app = TheConnection.CreateNewApplication();<\/span><\/span><\/div>\n<\/div>\n
\n
if <\/span>isempty(app)<\/span><\/span><\/div>\n<\/div>\n
\n
HandleError(<\/span>‘An unknown connection error occurred!’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
if <\/span>~app.IsValidLicenseForAPI<\/span><\/span><\/div>\n<\/div>\n
\n
HandleError(<\/span>‘License check failed!’<\/span>);<\/span><\/span><\/div>\n<\/div>\n
\n
app = [];<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
function <\/span>LogMessage(msg)<\/span><\/span><\/div>\n<\/div>\n
\n
disp(msg);<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
function <\/span>HandleError(error)<\/span><\/span><\/div>\n<\/div>\n
\n
ME = MXException(error);<\/span><\/span><\/div>\n<\/div>\n
\n
throw(ME);<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
function<\/span> CleanupConnection(TheApplication)<\/span><\/span><\/div>\n<\/div>\n
\n
% Note – this will close down the connection.<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
% If you want to keep the application open, you should skip this step<\/span><\/span><\/div>\n<\/div>\n
\n
% and store the instance somewhere instead.<\/span><\/span><\/div>\n<\/div>\n
\n
TheApplication.CloseApplication();<\/span><\/span><\/div>\n<\/div>\n
\n
end<\/p>\n

<\/span><\/span>Error,<\/strong><\/div>\n

\n
\n
Beam_expander_NSC_raytrace<\/span><\/span><\/div>\n<\/div>\n
\n
Found <\/span>OpticStudio at:c:\\program files\\ansys zemax opticstudio 2023 r2.00<\/span><\/span><\/div>\n<\/div>\n
\n
Unrecognized <\/span>field name “RunAndWaitForCompletion”.<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
Error <\/span>in Beam_expander_NSC_raytrace>BeginApplication (line 55)<\/span><\/span><\/div>\n<\/div>\n
\n
NSCRayTrace.RunAndWaitForCompletion();<\/span><\/span><\/div>\n<\/div>\n
\n
 <\/div>\n<\/div>\n
\n
Error <\/span>in Beam_expander_NSC_raytrace (line 16)<\/span><\/span><\/div>\n<\/div>\n
\n
r = BeginApplication(TheApplication, args);<\/span><\/span><\/div>\n
 <\/div>\n
\n
\n
\n
\n
\n
\n
Any help in any regards is much appreciated.<\/span><\/span><\/div>\n
 <\/div>\n
Thank you and regards,<\/span><\/span><\/div>\n
Navaneeth<\/span><\/span><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
  0 Comments<\/span><\/h5>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
 <\/div>\n<\/div>\n<\/div>\n","protected":false},"template":"","class_list":["post-368856","topic","type-topic","status-closed","hentry","topic-tag-zos-api","topic-tag-zos-api-matlab"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t