Hi Susan,

Have a look at Example 25 from the ZOS-API Syntax Help. You can find it from the OpticStudio interface by clicking Programming...ZOS-API Help...ZOS-API Syntax Help. In the Help document, which just opened, click on the Examples menu, and select Example 25 > MATLAB.

This is a rather complex example, but the interesting bit is how you setup your Detector Color after you've run a raytrace:

% Creates a new detector viewer window, changes to true color

det = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.DetectorViewer);

det_settings = det.GetSettings();

det_settings.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.TrueColor;

det.ApplyAndWaitForCompletion();

And how you can read its RGB values:

% Creates System.Single[] buffers to store pixel data

rData = NET.createArray('System.Single', (x_pixel * y_pixel));

gData = NET.createArray('System.Single', (x_pixel * y_pixel));

bData = NET.createArray('System.Single', (x_pixel * y_pixel));

% Loads RGB data into System.Single buffer

det_raw = det.GetResults().DataGridsRgb.Get(0);

det_raw.FillValues((x_pixel * y_pixel), rData, gData, bData);

% Converts buffer to RGB array; rotates & resizes RGB array

dData = zeros(y_pixel, x_pixel, 3) - 1;

dData(:,:,1) = rot90(reshape(rData.double ./ 255, x_pixel, y_pixel));

dData(:,:,2) = rot90(reshape(gData.double ./ 255, x_pixel, y_pixel));

dData(:,:,3) = rot90(reshape(bData.double ./ 255, x_pixel, y_pixel));

It calls for the GetResults().DataGridsRgb.Get(0) method, and not the GetAllDetectorData() method you used, which I think is confined to monochromatic data.

Let me know if this helps as I didn't try it myself with MATLAB (I don't own a licence at the moment).

PS: from what I know, the ZOS-API will retrieve your data in a Double-format with 64-bits precision in each color channel, and store it into a 'double' 3D MATLAB matrix (third dimension is RGB). It is up to you to downscale it to 8-bits before saving (let me know if you need help with that).

Take care,

David

Hi Susan,

The image is stored as a 3D matrix in MATLAB, the first two dimensions are the pixels of your image, and the third one is the color channel. Index 0 is the red component, 1 is the green component, and 2 is the blue component.

You can use this matrix to save it as an rgb-jpeg, but you can also take the mean value along the third dimension to save a grayscale image. Does this make sense?

Let me know once you had a chance to look at the code, which is not from me by the way. Its an OpticStudio built-in example.

Take care,

David

Hi Susan,

You do not need to specify where your detector is if you know the pixel size (to allocate the memory for the MATLAB matrix). Let me explain, what you do with this line:

TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.DetectorViewer)

Is you effectively create and open a new Detector Viewer analysis window, and the Detector represented in the Detector Viewer is a setting of the Detector Viewer itself. You can also see this directly in OpticStudio, in a Detector Viewer window, you can press Settings...Detector, and see what Detector it picks its data from. If you have only one detector, it will use this one by default. If you have more than a single detector, it'll pickup the first one in the non-sequential data editor. It is not shown in this example, but you can change the Detector programatically with this line:

det_settings.Detector.SetDetectorNumber(30)

Which you would put just after the line where you retrieve the analysis settings:

det_settings = det.GetSettings()

In Example 25 though, they have their Detector Color in Object 5 (called o5 in the code). And they use it to setup the dimension of the detector in pixels. However, I don't think this is relevant for you, so you might want to ignore it at first.

You should not use:

det.GetResults().GetDataGridRgb(30)

Because, the integer parameter is not the detector number. This parameter correspond to the index of the data grid you are looking for. Most of the time, it'll be 0, because those analysis only return a single data grid, and in most langages (except MATLAB), the first index is zero.

You can check how many data grids are available with this line of code:

det.GetResults().NumberOfDataGridsRgb

If this returns anything other than 1 (based on your error, it probably returns 0), I'd suspect you might not have the right Detector in the settings. In which case, you can use the code I've proposed to change it to your Detector Color, perhaps something like:

# creates a new detector viewer window, changes to true color

det = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.DetectorViewer)

det_settings = det.GetSettings()

# ensure detector viewer is true color to extract RGB data

det_settings.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.TrueColor

# specify detector color position

det_settings.Detector.SetDetectorNumber(30)

det.ApplyAndWaitForCompletion()

Let me know if this helps,

David

Ah, I see... problem is that I don't know how to use SAVEDETECTORDATA from the UI, ZPL or ZOS-AP.

I am totally a newbie to ZEMAX. 

I now tried removing all the other detectors and just keeping the one I want to plot,

 with code changes

 still get error 'Attempting to access the property or method of an invalid object.' at 'det_raw = det.GetResults().DataGridsRgb.Get(0);'

Cannot figure out what the problem is. 

Notice that i changed truecolor to Gray Scale Inverted since this is the one I use to plot the image. Not sure what to use as det.GetResults().DataGridsRgb.Get(0);' DataGrid when using show as 'gray inverted'. 

I tried 

 and that worked but then i got error at line

Error says then, No appropriate method, property, or field 'FillValues' for class 'ZemaxUI.ZOSAPI.Analysis.AR_DataGrid'.

 

Hi Susan,

I'm glad to hear you are sorted. I hope this discussion helped you.

Don't hesitate to share your solution as well, if you think it can be helpful to someone else.

Take care,

David