Undocumented scatter plot behavior

October 12, 2009 18 Comments

One of my blog readers, Henrik Toft, reported an undocumented behavior of the well-known scatter plot function: scatter returns a handle to an hggroup-type object that contains child handles of the data points (patch-type objects). This enables easy manipulation of specific points (for example, changing the color or marker of interesting data points).
The undocumented behavior is that when the scatter plot contains more than 100 points, the returned hggroup object only has a single child – a handle to a unified patch object that contains all the data points. This prevents customization of specific points: color can be customized via the cdata property, but this is not trivial; the marker cannot be customized at all.
Both Henrik and I initially thought this was a simple bug. But when Henrik reported this issue to MathWorks support, he got the response that this is indeed the expected behavior (i.e., not a bug but a feature), which is not documented. MathWorks did not say whether this was because they didn’t think users need more than 100 child handles, or perhaps an issue with memory/performance. Whatever the reason, I feel that this behavior/feature should at least be documented:

>> hggroup = scatter(rand(99,1),rand(99,1));
>> size(get(hggroup,'Children'))
ans =
    99     1
>> hggroup = scatter(rand(100,1),rand(100,1));
>> size(get(hggroup,'Children'))
ans =
   100     1
>> hggroup = scatter(rand(101,1),rand(101,1));
>> size(get(hggroup,'Children'))
ans =
     1     1

Workaround: use the ‘v6’ option. Unfortunately, this option is deprecated and marked as obsolete by Matlab, with the warning that it will be removed in a future Matlab version. I hope this will not be done until a better workaround for the above-reported issue is implemented in the scatter function:

>> hPatches = scatter('v6',rand(101,1),rand(101,1));
Warning: The 'v6' argument to SCATTER is deprecated, and will no longer be supported in a future release.
> In usev6plotapi>warnv6args at 84
  In usev6plotapi at 40
  In scatter at 39
>> size(hPatches)
ans =
   101     1

If you have detected any other undocumented behavior, function or feature in Matlab, please report them in the comments section below, or directly by email to me: altmany at gmail dot com.

18 Responses

Naor October 12, 2009 at 11:59 Reply

Interesting. I use scatter with thousands of points all the time. Perhaps I am misusing it then? I don’t really need the ability to access each data marker but scatter is just an easy function to work with.

Yair Altman October 12, 2009 at 13:01 Reply

Naor – Perhaps I should have been clearer: scatter works correctly even with 101+ data points, as you correctly said. However, the returned value in this case is simply a single patch handle rather than hundreds or thousands of separate data-point handles. If you don’t need to customize specific data points then this issue doesn’t really matter; but if you do need this ability, you need to use the obsolete ‘v6’ option.

Venkat October 12, 2009 at 22:33 Reply

Hi Yair,
In my GUI, I have to add/delete/adjust lot of graphs. In matlab compiler documentation, PLOTTOOLS is stated under List of Unsupported Functions.
Is there any way to get PLOTTOOLS working with the compiled code of standalone EXE?

Yair Altman October 13, 2009 at 01:50 Reply

Venkat – Interesting question. Unfortunately, I do not know if it can be done or how.

Sebastiaan October 13, 2009 at 06:08 Reply
I do not like the method of using deprecated functions – they might just disappear the next release.

I suggest using something like this:
data = rand(227,2); hggroup(1) = scatter(data(1:100,1),data(1:100,2)); hold on hggroup(2) = scatter(data(101:200,1),data(101:200,2)); hggroup(3) = scatter(data(201:227,1),data(201:227,2));
data = rand(227,2); hggroup(1) = scatter(data(1:100,1),data(1:100,2)); hold on hggroup(2) = scatter(data(101:200,1),data(101:200,2)); hggroup(3) = scatter(data(201:227,1),data(201:227,2));
By default, it is plotted in different colours, but that can be easily overcome.

Sebastiaan
Performance: scatter vs. line | Undocumented Matlab October 14, 2009 at 08:01 Reply

[…] Charting Matlab’s unsupported hidden underbelly « Undocumented scatter plot behavior […]
Boyan March 26, 2010 at 09:15 Reply

Hi
This article has been very useful for me! I struggled few hours with this before I found this. Since I need to manipulate the individual points in a specific order it is worth noting that the order in, which the handle is returned with the ‘v6’ option is exactly the opposite of what the ‘Children’ property returns meaning that the first object is on top instead of on the bottom. I hope this helps to others and I have to say it is very disappointing Matlab decided to do this in such manner…

Boyan
jacob January 12, 2012 at 01:53 Reply

Thanks a lot! It took me quite a while to figure out why my functions suddenly stopped working.
Again, thanks! you made my day.
Undocumented scatter plot jitter | Undocumented Matlab June 6, 2012 at 06:05 Reply

[…] You may also be interested in the article I posted a few years ago about another undocumented scatterplot behavior […]

HTML tags such as <b> or <i> are accepted.
Wrap code fragments inside <pre lang="matlab"> tags, like this:

<pre lang="matlab">
a = magic(3);
disp(sum(a))
</pre>

I reserve the right to edit/delete comments (read the site policies).
Not all comments will be answered. You can always email me (altmany at gmail) for private consulting.

Click here to cancel reply.

Sky (2 days 4 hours ago): Matlab seems to catch on to mustBeMember and offers tab completion options when it is used. classdef foo < matlab.mixin.SetGet properties Coordinates {mustBeMember(Coordinates,{...
Yair Altman (8 days 10 hours ago): Philip – perhaps you forgot to update the table’s model to a DefaultStyleTableModel. In any case, this topic is way outside the scope of this blog, which is...
Philip (8 days 10 hours ago): Yair, I am a bit of a novice at programming with Java. Would you please expound a bit more or provide an example on how to use JIDE’s CellStyle in MATLAB? I have successfully...
Yair Altman (12 days 22 hours ago): @Philip – in the Java-based uitable you can use JIDE’s CellStyle to customize specific cells. Refer to JIDE’s documentation for details. In the web-based...
Philip (12 days 22 hours ago): Yair, You may have addressed this already in the past, if so, please kindly point me to the appropriate article(s). My issue is with creating a table which has (not column but) cell...
Yair Altman (17 days 20 hours ago): The javacomponent function returns 2 objects: a Java reference and a Matlab container. Simply set the value of the Units property of the Matlab container to...
Neeks (18 days 1 hour ago): This looks elegant. Thank you. One issue I am not able to sort out – on maximizing the figure window the location of “javax.swing.JSliderR 21; object does not scale...
Xiangrui Li (22 days 17 hours ago): Hi Yair, Thank you for digging into this. It seems I need following to get CEF container = struct(controllerProps.Platfor mHost);
Yair Altman (23 days 4 hours ago): Matlab recently modified the internal structure. You can now access the web-window (CEF) object as follows: hFig = uifigure(...); warning off MATLAB:structOnObject % suppress...
Xiangrui Li (23 days 17 hours ago): It seems the`Container` is removed. I see this error in R2019b: container = controllerProps.Container; Reference to non-existent field 'Container'.
Tim (30 days 21 hours ago): Thank you for this post, it is very useful. It seems that when using plot3, if I have more than 25,000 points and I change my figure size or rotate the image, the MarkerHandle values...
Rohit (37 days 3 hours ago): How do we put “MJDimensionPicker” ; in a “TSdropDownButton” ? (As it is in [ View (Tab) –> Tiles (Column) –> Custom (Drop-Down Button)] ). Thanks again...
Yair Altman (39 days 12 hours ago): Andrea – sqlite4java is an open-source project (https://code.google.com/archi ve/p/sqlite4java). You can modify its code and/or submit an issue on that project’s...
Andrea Carignano (39 days 12 hours ago): Thank you very much! I am using the first method of this article: sqlite4java. I have just a little problem. After every operation on database, I get some red messages in...
Wil Koenen (46 days 7 hours ago): The undocumented syntax, e.g. classdef MyClass properties prop@double scalar = 3; end end runs fine in R2019a, but produces a warning in R2019b: Warning: Class 'MyClass' uses an...

Related posts:

18 Responses

Leave a Reply