Click to edit Master title style - Zemax

Click to edit Master title styleMATLAB Integration with ZemaxPresenter – Rhys Poolman

Overview• Extracting Zemax Data– Loading a lens file (.ZMX).– Extracting data for analysis in MATLAB.• Modifying Zemax Data– Making Changes to a lens file.– Updating Zemax instance.• Accessing Zemax Functions– Tracing rays

Introduction- MATLAB and Zemax• MATLAB: Powerful numerical computingpackage– Useful for post-processing Zemax simulations– Larger range of mathematics and visualisationcommands• MATLAB and Zemax talk with DynamicData Exchange (DDE)

Introduction- DDE• DDE is a method for applications to passinformation to each other.– Client sends data and processing instructions.– Server returns processed data.– Zemax is server.• DDE is equivalent to a conversion– Client (MATLAB) starts conversion by askingserver (Zemax) to do something.– Server replies

Important Comment on DDE• DDE is an obsolete method ofinterprocess communication.– Superseded by COM and .NET.• Zemax still uses it because it’s so easy!• IMPORTANT: MATLAB no longer supportsor develops DDE methods.– DDE issues with Zemax and 64-bit MATLAB.– 32-bit works fine!

The DDE Link• Only three MATLAB commands arerequired:– ddeint• Opens a channel between MATLAB and Zemax.– ddereq• Sends requests to Zemax (server).– ddeterm• Closes the channel between the two applications.

The DDE Link- ddeint• The syntax for the DDE initialisationcommand:channel = ddeinit(‘service',‘topic');A reference numberto pass the channelto the other threeCommands.The applicationto act as theserver, in ourcase Zemax.A specific file, Zemaxonly opens one fileper instance so leaveblank.• Our DDE initialisation command ischannel = ddeinit(‘ZEMAX',‘');

The DDE Link- ddereq• The syntax for the DDE request command:result = ddereq(channel,‘item‘, format, timeout);• A full list of DataItems in manualin chapter 26Zemax Data ItemPassed as a string.Optional: Format ofinput and output in 2element array; 1string, 0 numeric,default [1, 0];Optional: Wait time,default 3000 ms.

The DDE Link- ddeterm• The syntax for the DDE terminationcommand:close = ddeterm(channel);• close contains a 0 indicating failure and 1indicating success.

Zemax Data Items• The slide on the ddereq command mention“Data Items”:result = ddereq(channel,‘item‘, format, timeout);• These are Zemax commands passed asstrings from MATLAB to Zemax GetName isa simple example:result = ddereq(channel,‘GetName‘, [1,1]);

Zemax Data Items• Last argument is format specifier.– Two integer elements [input, output] indicatewhether string or numeral is expected.– GetName outputs string so [1,1] is used.– Numerical output [1,0] is default.• General data item string format:‘DataItem, argument_1, argument2, …, argument_n‘• Important: MATLAB won’t pick up on thiscomma if its missing!

First Example- Test Connection• This is a simple example to get a lens title% Template MATLAB-ZEMAX DDE programclear all % removes all variables% initialize DDE connectionchannel = ddeinit('ZEMAX','');First command opensDDE channel for usewith ddereq andddeinit commands.% Main body of script. All commands are passed to ZEMAX using data items in% chapter 26 using the ddereq MATLAB command.name = ddereq(channel,'GetName', [1,1]);disp(name);% terminate DDE connetionclose = ddeterm(channel);Final command closeDDE channel.Second command getsthe lens title displayedin the Title/Notes tabof the General dialoguebox.

Second Example - Data Extraction• Loading a .ZMX file– Need file path (GetPath)– Load lens (LoadFile)Returns contents of Data boxand Lens box in Folders tab ofpreferences dialogue, bothof which strings so [1,1] is needed.% zemax data item to get pathpaths = ddereq(channel, 'GetPath', [1,1]);% MATLAB data processingmodify = strrep(paths, ',', ' '); % replaces comma with space[data_path lens_path] = strtok(modify); % splits paths into two variables% zemax data item to load lens fileitem = strcat('LoadFile,', lens_path, ...'\Non-sequential\Sources\led_model.zmx');load = ddereq(channel, item);Sends data item constructed by strcatMATLAB function to load lens file intoZemax instance memory NOT into LDE.

Second Example - Data Extraction• What if we move the source around inside thedetector?– Need to know the detector size (GetNSCParameter).– Need to know the detector position (GetNSCPostion).Polar Detector Radius% Zemax data item to get detectorradiussurf = num2str(1);object = num2str(4);parameter = num2str(2);item = strcat('GetNSCParameter, ',...surf, ', ', object, ', ', parameter);detector_radius = ...ddereq(channel,item);Source Position% Zemax data item to get detectorpositionsurf = num2str(1);object = num2str(1);item = strcat('GetNSCPosition,',...surf, ', ', object);detector_position = ...ddereq(channel, item, [1,1]);

Second Example - Data Extraction• Data processing using MATLABcommands:% MATLAB data processingmodify = strrep(detector_position, ',', ' ');position_data = textscan(modify, '%f %f %f %f %f %f %s');x = position_data{1};y = position_data{2};z = position_data{3};x_tilt = position_data{4};y_tilt = position_data{5};z_tilt = position_data{6};material = position_data{7};

Aside- MATLAB Functions• Return processing is messy and makesreading code difficult.• Can use MATLAB functions to executespecific ddereq calls e.g.[ x, y, z, x_tilt, y_tilt, z_tilt, material ] =GetNSCPosition( channel, surf, object )• Executes both GetNSCPosition ddereqand puts data into individual variables.• Zemax DDE Toolbox for MATAB

Third Example- Modifying Lens• We know:– range of movement for source (polar detectorradius).– starting position (object 1 position).• Loop over a range of positions usingSetNSCPosition• Update non-sequential component editor.• Return source to starting point.

Third Example- Moving Source• To change lens position useSetNSCPosition in for loopobject = num2str(1);code = num2str(3); % alters z positionfor ii = z-detector_radius/2:detector_radius/10:z+detector_radius/2;% Zemax data item to alter the source assembly positiondata = num2str(ii);item = ['SetNSCPosition, ', surf, ', ', object, ', ', code, ', ', data];result = ddereq(channel, item);end• Source doesn’t move in Non-sequentialcomponent editor, why?

Third Example- Modify Lens File• PushLens updates Zemax editors withcontents of sever memory.• Need to tell Zemax this is OK:

Third Example- PushLens• Use the PushLens data item inside the forloop% Zemax data item to update the non-sequential component editorerror = ddereq(channel, 'PushLens, 1');if errordisp(['PushLens failed to update editor for z = ',...num2str(ii), 'mm']);end• Changes the source position in the Nonsequentialcomponent editor.

Forth Example- Trace Rays• We’re altering the design from MATLAB.• Lets see what effect that has– Use TraceRays– Use NSCDetectorData• Order is Clear Detectors -> Trace Rays ->Recover Detector Data

Forth Example- Detector Data• Add NSCDetectorData to for loop afterpush lens:% Zemax data item to clear detectoritem = 'NSCDetectorData, 1, 0, 0, 0'; This zero indicates to Zemaxdata = ddereq(channel, item);to clear all detectors, just asNSDD optimisation operand.• Also need to recover data after ray trace:% Zemax data item to get RMS angular widthitem = ['NSCDetectorData, ', surf, ', 4, 0, 0'];total_power(jj) = ddereq(channel, item);jj = jj + 1;4- Detector object number0- Total flux in…0- position space.

Forth Example- Trace Rays• Between the two NSCDetectorData dataitems a TraceRays operand is required.% Zemax data item to trace rays throughitem = ['NSCTrace, ', surf, ', ', source, ', 0, 0, 0, 1, 1'];error = ddereq(channel, item);if errordisp('ray trace errors');endTranslation:‘, splitting off, scattering off, polarization off, ignore errors on, random ray trace on’

Forth Example- Return Source• Two data Items need to set source back tooriginal position.– SetNSCPosition with data set to original zvalue.– PushLens to change non-sequentialcomponent editor.• Use MATLAB plot command to plot totalpower as a function of source to detectordistance.

Results from MATLAB

Flashy Results from MATLAB!

Conclusion• You need three MATLAB commands:– ddeinit to initiate link with MATLAB– ddereq to tell Zemax what to do from MATLAB– ddeterm to terminate the link• Can use link to analyse Zemax results.• Take advantage of MATLAB mathematicaland plotting libraries.

Contact Details• Please direct questions to:– zemaxsupport@radiantzemax.com– eusupport@radiantzemax.com• I’ll be answering question for the next 30minutes.