Skip to content

Two colormaps named "spectral" #879

Closed

Description

@endolith

I'm trying to figure out where all the different colormaps came from and document their purpose, and I noticed that there is a spectral and also a Spectral, which are not the same thing:

spectral and Spectral

Maybe one should be renamed? Or kept for backwards compatibility and given an alias to differentiate them?

Activity

  1. mdboom commented on May 18, 2012

    @mdboom
    Member

    This is great work! Having a quick colormap reference page in the docs would be awesome. Thanks!

    I agree the naming is too confusing, but it's too late in the day for me to come up with a better name for either. But I agree whatever we do that aliasing (and deprecating the old name) is a good idea.

  2. jswhit commented on May 18, 2012

    @jswhit

    I added the "Spectral" colormap a long time ago while adding all the colormaps from here:

    http://soliton.vm.bytemark.co.uk/pub/cpt-city/cb/div/index.html

    DIdn't realize it had the same spelling as an existing colormap (or maybe the "spectral" colormap was added later?)

    If anyone can suggest a better name I'll rename it (and leave an alias)

  3. endolith commented on May 18, 2012

    @endolith
    ContributorAuthor

    Lowercase spectral was added later, all by itself, while uppercase Spectral is part of the ColorBrewer set, so I would think the lowercase one should be renamed, since it isn't part of a group it needs to be consistent with.

    (spectral is the only non-MATLAB-copied map that gets its own function. Is there any rhyme or reason to which ones should get this?)

  4. endolith commented on May 19, 2012

    @endolith
    ContributorAuthor

    Ok, I found it: http://sourceforge.net/mailarchive/message.php?msg_id=8931272

    Originally from neuroimaging project, so rename spectral to nipy_spectral in the same way as gist_rainbow was copied from the GIST project? But then what should spectral() do?

  5. efiring commented on Aug 13, 2012

    @efiring
    Member

    Closed after #921 merge

  6. endolith commented on Aug 17, 2012

    @endolith
    ContributorAuthor

    Unless I'm really confused, this wasn't solved by #921. Was it changed in some other place?

  7. efiring commented on Aug 17, 2012

    @efiring
    Member

    You are right, it wasn't. Somehow I thought you had solved all colormap problems.

    Suggested pull request for this one: as you suggest, make nipy_spectral an alias for spectral (or vice-versa). I think I would then leave the spectral() function--it isn't doing any harm, and it has probably been there for a while--and modify the docstring to note that it is using nipy_spectral.

  8. endolith commented on Aug 17, 2012

    @endolith
    ContributorAuthor

    hmmm. so there will be

    • plt.cm.Spectral
    • plt.cm.nipy_spectral
    • plt.cm.spectral: alias for plt.cm.nipy_spectral, marked in the docstring as deprecated
    • spectral(): which is equivalent to set_cmap(plt.cm.nipy_spectral)
  9. efiring commented on Aug 18, 2012

    @efiring
    Member

    Alternative suggestions are welcome, but we can't simply delete spectral() or cm.Spectral or cm.spectral.

  10. endolith commented on Aug 20, 2012

    @endolith
    ContributorAuthor

    def spectral():
    says

    # This function was autogenerated by boilerplate.py.  Do not edit as
    # changes will be lost
    

    How do I edit the spectral function then?

  11. efiring commented on Aug 20, 2012

    @efiring
    Member

    You would have to remove "spectral" from the list of cmaps in boilerplate.py, manually add an equivalent function to pyplot.py, and re-run boilerplate.py, which will propagate the first change into pyplot.py. See the boilerplate.py docstring.

  12. endolith commented on Aug 21, 2012

    @endolith
    ContributorAuthor

    I left the spectral() function in the footnotes, since it was an oddball anyway, and recommended set_cmap('nipy_spectral') instead.

  13. dmcdougall commented on Mar 23, 2013

    @dmcdougall
    Member

    Sorted! #1127 has been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions