bugGNU Octave - Bugs: bug #49205, Rename hidden properties such as...

 
 

bug #49205: Rename hidden properties such as image "clim" to "__clim__"

Submitted by:  Dan Sebald <sebald>
Submitted on:  Wed 28 Sep 2016 08:34:58 AM UTC  
 
Category: PlottingSeverity: 1 - Wish
Priority: 5 - NormalItem Group: Feature Request
Status: NoneAssigned to: None
Originator Name: Open/Closed: Open
Release: devOperating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Fri 14 Oct 2016 10:46:48 PM UTC, comment #5:

I renamed some of the obvious Octave-only properties to have underscores, or more closely match Matlab's own hidden property names.

See http://hg.savannah.gnu.org/hgweb/octave/rev/4191f8b5070c.
See http://hg.savannah.gnu.org/hgweb/octave/rev/76f1164d2135.

This still leaves the more delicate work of renaming the hidden "alim", "clim", "xlim", "ylim", and "zlim" properties for the image, patch, surface, and hggroup objects.

Rik <rik5>
Project Administrator
Tue 11 Oct 2016 08:16:09 PM UTC, comment #4:

We have to be careful. Many "hidden" properties are also hidden in Matlab, but they are so well known that people expect to find them under the same names. Examples include 'xliminclude', 'looseinset', 'x_viewtransform'. Properties which strictly belong to octave, like 'fltk_label', should be renamed to have underscores.

Can someone run the following in Matlab to see if these properties are known in Matlab?

Rik <rik5>
Project Administrator
Wed 28 Sep 2016 03:57:54 PM UTC, comment #3:

Yes, you are right that it is easy to mistakenly get an image "clim" instead of its parent axes'. Renaming hidden properties would avoid confusion.
I'll retitle this report and make it a feature request.

Pantxo Diribarne <pantxo>
Project Member
Wed 28 Sep 2016 03:25:17 PM UTC, comment #2:

OK, this hidden property rings a bell. Probably using something like _clim_, _xlim_, etc. for the internal property name would have been better, as it is very easy for someone to stumble upon the object clim, xlim, etc.

Looking at graphics.cc, I'm guessing that these x/y/clim object properties are

min_val, max_val, min_pos, max_neg

So a max_neg of -Inf means there are no negative numbers in the data.

Dan Sebald <sebald>
Wed 28 Sep 2016 09:35:42 AM UTC, comment #1:

"clim" image property is an internal, hidden, non-documented, non matlab compatible property, see:

"clim" is used internally to compute the image parent axes limits, but is not meant to be used outside the graphics engine. So I think this report can be closed.

Pantxo Diribarne <pantxo>
Project Member
Wed 28 Sep 2016 08:34:58 AM UTC, original submission:

With the following set of commands there is a clim that has four elements, but I think only two elements are valid (toolkit doesn't matter):

The 2 and 255 seem correct. I don't know what 2 -Inf might represent. Out of curiosity:

Dan Sebald <sebald>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by pantxo (Posted a comment)
  • -unavailable- added by sebald (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Wed 28 Sep 2016 03:57:54 PM UTCpantxoSeverity3 - Normal=>1 - Wish
      Item GroupIncorrect Result=>Feature Request
      Summaryclim has four elements for imshow() result=>Rename hidden properties such as image "clim" to "__clim__"

    Back to the top


    Powered by Savane 3.1-cleanup1