- Undocumented Matlab - https://undocumentedmatlab.com -

FIG files format

Posted By Yair Altman On December 22, 2010 | 18 Comments

A short while ago, a StackOverflow user asked how to extract data from FIG files in Matlab [3]. The answer to this question is easy, but I wish to use the opportunity to show how this can be useful in Matlab applications.

The need: load a FIG without displaying it

In data-processing applications, we often present data in graphs that can then be manipulated and saved for later use. In Matlab, saving is done interactively (via the figure’s File/Save menu option or via the figure’s Save toolbar button), or programmatically (via the hgsave function). In all cases, the data is stored in a *.FIG file (the FIG extension can actually be changed, but I really don’t see why).

The point is that in order to re-load the stored data, we need to use hgload, which has a nasty side-effect of actually displaying the stored figure.

This is bad in terms of performance and memory, especially for heavily-laden GUI figures, not to mention the fact that sometimes we do not want to display the GUI at all. We often just need to extract a sub-set of the stored information (for example, the plot values), without having to display the figure.

The answer: FIGs are simply MATs in disguise

Here’s where the undocumented stuff enters:

It seems that a FIG file is simply a hierarchical structure of all the non-default properties of the stored figure and its descendant handles, all this stored within a simple MAT file.

This is hinted in several places, for example in hgsave‘s doc page, and in the MAT-file preferences panel:

MAT-file preferences (note the FIG clarification)

MAT-file preferences (note the FIG clarification)

Knowing this, we can easily load the data, without displaying the figure, by using load(filename,’-mat’) rather than hgload. For example:

% Create and store a simple plot figure
>> figure('Name','Test #1');
>> plot(1:9, sqrt(1:9));
>> hgsave(gcf,'testFig');
 
% Load the figure data
>> d = load('testFig.fig','-mat')
d = 
    hgS_070000: [1x1 struct]   % a Matlab 7 figure
 
% Investigate the figure data
>> d.hgS_070000
ans = 
          type: 'figure'
        handle: 1
    properties: [1x1 struct]
      children: [1x1 struct]
       special: []
 
>> d.hgS_070000.children
ans = 
          type: 'axes'
        handle: 176.08251953125
    properties: [1x1 struct]
      children: [1x1 struct]
       special: [4x1 double]
 
>> d.hgS_070000.children.children
ans = 
          type: 'graph2d.lineseries'
        handle: 177.0830078125
    properties: [1x1 struct]
      children: []
       special: []
 
>> d.hgS_070000.children.children.properties
ans = 
              Color: [0 0 1]
              XData: [1 2 3 4 5 6 7 8 9]
              YData: [1 1.4142 1.7321 2 2.2361 2.4495 2.6458 2.8284 3]
    ApplicationData: [1x1 struct]
        XDataJitter: 0
          XDataMode: 'manual'
      ObeyXDataMode: 'auto'
                ...
 
% Extract plot data
>> YData = d.hgS_070000.children.children.properties.YData
YData =
  1.0000  1.4142  1.7321  2.0000  2.2361  2.4495  2.6458  2.8284  3.0000

We see a couple of interesting things in this simple example:

First, note that the top-level structure node is called “hgS_070000” – we’ll dig into this next week. Basically, it indicates that the structure holds a Matlab 7 figure.

Secondly, we see hidden/undocumented properties [4] of the stored objects (for example, the lineseries’ XDataJitter and ObeyXDataMode properties). ApplicationData is such a hidden handle, which is widely used as a substitute for any handle’s UserData property (the built-in setappdata and getappdata functions are simply wrappers for accessing this property using standard set and get functions).

Have you used the FIG/MAT feature for any useful functionality? If so, please do share your experience in a comment [5].

Next week, I will explain how looking under hgsave‘s hood leads to useful functions and to an interesting insight about Matlab’s future. Merry Christmas everybody!

Categories: Figure window, Handle graphics, Hidden property, Low risk of breaking in future versions, Stock Matlab function, Undocumented feature


18 Comments (Open | Close)

18 Comments To "FIG files format"

#1 Comment By Jos von Asmuth On December 23, 2010 @ 7:55 am

Hi Yair,

Thanks again. Perhaps it is a simple issue, but do you happen to know how to, once loaded, create a gui or figure out of such a structure? It could be helpfull for automaticcally generating GUI’s.

Kind regards,
Jos

#2 Comment By Yair Altman On December 23, 2010 @ 10:51 am

@Jos – You can use the struct2handle function for this. I will explain its usage next week. Of course, you can always use hgload on the original FIG filename.

#3 Comment By Volkmar Glauche On December 25, 2010 @ 12:02 am

I am using this feature to “repair” GUI figures created with some versions of guide. Some versions of guide store callbacks as function handles in a way that is not compatible with all versions of MATLAB I have to work with (R14SP3 onwards). I parse the function handles and replace them with a callback string (if possible).
Also, in conjunction with [12] this is useful to read and modify the MATLAB code of a saved figure.

Best,

Volkmar

#4 Comment By Robin Lundberg On December 17, 2014 @ 8:29 am

Trying this in matlab 2014b still opens the gui (sometimes).
When you load a gui you get

>>figData = load('guiPostProcessing.fig', '-mat')
figData = 
    hgS_070000: [1x1 struct]
    hgM_070000: [1x1 struct]

And this might open the figure. To prevent this I did this instead and it seems to work fine

>> figData = load('guiPostProcessing.fig', '-mat', 'hgS_070000')
figData = 
    hgS_070000: [1x1 struct]

#5 Comment By Mariam On July 27, 2015 @ 11:13 pm

Hi,

I have used above following command to load the attributes of figures

d = load('testFig.fig','-mat')

and then changed those attributes. I want to know how could I apply new attributes to my figure or how can I save variable ‘d’ into .fig format. Please reply.

Regards,
Mariam

#6 Comment By Yair Altman On July 28, 2015 @ 1:07 am

@Mariam – you can simply use the save command to save your modified d struct back into the *.fig file, and then open this FIG file normally:

save('testFig.fig','d','-mat'); % save modified d struct
testFig; % open figure

#7 Comment By Mariam On July 28, 2015 @ 5:19 am

I already tried this and this the error I am getting

>> save('C:\Users\Mariam\Desktop\fitted response\atlas masks\IPS_1.fig','s','-mat')
>> open('C:\Users\Mariam\Desktop\fitted response\atlas masks\IPS_1.fig')
??? Error using ==> open at 163
Invalid Figure file format

#8 Comment By Yair Altman On July 28, 2015 @ 5:23 am

@Mariam – You probably updated your s data-struct incorrectly

#9 Comment By Mariam On July 28, 2015 @ 8:53 pm

I tried it without making any changes to ‘s’. Just loading it

s = load('C:\Users\Mariam\Desktop\fitted response\atlas masks\IPS.fig','-mat');

and re-saving it

save('testFig.fig','s','-mat'); % save modified d struct

However the effect remains it

open('testFig.fig')
??? Error using ==> open at 163
Invalid Figure file format.

#10 Comment By Yair Altman On July 29, 2015 @ 1:12 am

@Mariam – the save command save the data including the variable name as top-level struct field. You should keep the same top-level field-name as used by the FIG format (hgS_070000 or hgM_070000):

s = load('IPS.fig','-mat');
hgS_070000 = s.hgS_070000;
 
% modify hgS_070000
 
save('IPS.fig','hgS_070000','-mat');

#11 Comment By Martin On July 29, 2015 @ 3:53 am

@Mariam – you can also use the -struct flag of the save function, if you want to modify the struct s directly without going through another temporary variable:

save('testFig.fig', '-struct', 's', '-mat');

That way the field names of the struct s are treated as the variable names to be saved to the file.

#12 Pingback By Lo que he aprendido: exportar todas las imágenes fig de una carpeta a pdf con Matlab | Onda Hostil On April 14, 2016 @ 4:48 pm

[…] Relación entre figuras y archivos mat […]

#13 Comment By Varshini Guddanti On June 16, 2016 @ 4:54 am

Can the ‘load’ method convert the figure into a matrix to do some operations later?

#14 Comment By Yair Altman On June 16, 2016 @ 9:32 am

@Varshini – load() simply returns a Matlab struct. You can then process and convert this struct in your Matlab code in whichever way that you wish.

#15 Comment By ElGalloGringo On July 21, 2016 @ 8:18 pm

I am trying to write my own script to parse this struct data and generate a figure from a subset of the children handles. One weird thing I am running into is that even though in the struct from the FIG file the title, xlabel, and ylabel show up as children of the axes, when the FIG file is loaded with openfig, those children handles get assigned to the ‘title’, ‘xlabel’, and ‘ylabel’ properties of the axes. I can’t figure out how Matlab is determining that these children handles are special and shouldn’t just be added as children.

Any thoughts?

#16 Comment By Malcolm Lidierth On July 24, 2016 @ 12:24 am

Not sure why you think it should not. Any MATLAB OOP class can define custom saveobj and loadobj methods to deal with the serialisation/deserialization process.

Not your question but maybe relevant to what you are doing: an undocumented (I think) feature of MATLAB is that constructors will accept a structure on input. So

s.Name='This is my figure';
h=figure(s);

will give you a figure with the specified Name and other properties set to their default values. All HG objects seem to comply with this. Add properties as required to s.

#17 Comment By E. LeFort On June 5, 2017 @ 7:00 pm

Hello, great post. I want to share an issue and hopefully receive some help in defining the solution. Fist I derived a plot using the risetime function in matlab. This plot contains all types of information I would like to extract. Specifically the upper cross time which is marked with a red “x” by default.

I performed the following code:

fig.hgS_070000.children.children.properties

However, when ran I received the following error:

"Expected one output from a curly brace or dot indexing expression, but there were 2 results."

Is there a way to access this curly brace Information? I suspect this is an indexing issue however I have no idea how to access it.

Any help is greatly appreciated.

#18 Comment By Yair Altman On June 5, 2017 @ 7:08 pm

There are probably multiple children, so accessing children.children and/or children.properties results in an understandable error. You can try to access individual children using indexing, for example: fig.hgS_070000.children(1).children(1).properties


Article printed from Undocumented Matlab: https://undocumentedmatlab.com

URL to article: https://undocumentedmatlab.com/blog/fig-files-format

URLs in this post:

[1] Image: http://undocumentedmatlab.com/feed/

[2] email feed: http://undocumentedmatlab.com/subscribe_email.html

[3] how to extract data from FIG files in Matlab: http://stackoverflow.com/questions/2976505/how-can-i-extract-data-from-a-fig-file-in-matlab

[4] hidden/undocumented properties: https://undocumentedmatlab.com/blog/displaying-hidden-handle-properties/

[5] comment: https://undocumentedmatlab.com/blog/fig-files-format/#respond

[6] Plot LimInclude properties : https://undocumentedmatlab.com/blog/plot-liminclude-properties

[7] HG2 update : https://undocumentedmatlab.com/blog/hg2-update

[8] Using linkaxes vs. linkprop : https://undocumentedmatlab.com/blog/using-linkaxes-vs-linkprop

[9] Undocumented scatter plot jitter : https://undocumentedmatlab.com/blog/undocumented-scatter-plot-jitter

[10] Getting default HG property values : https://undocumentedmatlab.com/blog/getting-default-hg-property-values

[11] Draggable plot data-tips : https://undocumentedmatlab.com/blog/draggable-plot-data-tips

[12] : http://www.mathworks.com/matlabcentral/fileexchange/24447

Copyright © Yair Altman - Undocumented Matlab. All rights reserved.