Giter Club home page Giter Club logo

albumpl's Introduction

albumpl

Custom matplotlib color palettes based on album covers.

DOI Downloads

To install:

cd ~

git clone [email protected]:avapolzin/albumpl.git

cd albumpl

sudo python3 setupy.py install

or

pip install albumpl

If you use this package or the scripts in this repository in a publication, please add a footnote linking to https://github.com/avapolzin/albumpl and/or consider adding this software to your acknowledgments. If you would like to cite albumpl, please use the Zenodo DOI linked here.

@software{ava_polzin_2023_8307551,
  author       = {Ava Polzin},
  title        = {albumpl},
  month        = sep,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {v0.2.0},
  doi          = {10.5281/zenodo.8307551},
  url          = {https://doi.org/10.5281/zenodo.8307551}
}

I'd love to feature plots/figures that make use of these palettes in the wild, so should these palettes be of use, please send me a copy of that figure and/or a link to your paper or presentation and I will share it here.

Each of the included palettes has been checked with COBLIS, and should be legible for individuals with most common forms of color blindness. Best, though, is to check your specific figures' readability, too.

The palette options (to now) are:

  1. LondonCalling inspired by The Clash - London Calling (which, of course, technically means it was inspired by Elvis Presley's eponymous album) LondonCalling_summary

  2. Antisocialites inspired by Alvvays - Antisocialites Antisocialites_summary

  3. RhumbLine inspired by Ra Ra Riot - The Rhumb Line RhumbLine_summary

  4. Matangi inspired by M.I.A. - Matangi Matangi_summary

  5. MellonCollie inspired by the Smashing Pumpkins - Mellon Collie and the Infinite Sadness MellonCollie_summary

  6. MellonCollie2012 inspired by the Smashing Pumpkins - Mellon Collie and the Infinite Sadness (2012 Deluxe Edition) MellonCollie2012_summary

  7. Yoshimi inspired by the Flaming Lips - Yoshimi Battles the Pink Robots Yoshimi_summary

  8. Figure8 inspired by Elliott Smith - Figure 8 Figure8_summary

  9. LiveThroughThis inspired by Hole - Live Through This LiveThroughThis_summary

  10. Post inspired by Björk - Post Post_summary

  11. VampireWeekend inspired by Vampire Weekend's self-titled debut VampireWeekend_summary

  12. CopperBlue inspired by Sugar - Copper Blue CopperBlue_summary

  13. Dreamland inspired by Glass Animals - Dreamland Dreamland_summary

  14. Garbage inspired by Garbage - Garbage Garbage_summary

  15. BlameItOnGravity inspired by Old 97's - Blame It On Gravity BlameItOnGravity_summary

  16. ChutesTooNarrow inspired by the Shins - Chutes Too Narrow ChutesTooNarrow_summary

There are also a handful of alternative colormaps included in albumpl, which are not the default colormap associated with a particular palette, but can be accessed individually in the same way as any other colormap.

These standalone colormaps (named for songs on the album that inspired them) are:

Additional palettes and colormaps will be added moving forward. Is there a specific album you want considered for a future palette? Please open an issue with the name of the album and artist and an image of the album cover.

About the sample images: For sequential colormaps, the sample image is photometric HST data of the dwarf galaxy COSMOS-dw1 in F814W. The sample image for diverging colormaps is an HI velocity map of the galaxy M33 from GALFA-HI.

And, though it should go without saying, I'll add: use of an artist's album cover to make a palette is not an endorsement of the artist or their (broadcast) personal views.


How to use albumpl:

Some quick recipes.

Before doing anything you will need to register the new album-inspired colormaps. To do this:

from albumpl.cmap import register_all

register_all()

This is necessary for any of the albumpl.palette functions that use the colormaps, such as set_default and set_default_cmap.

  • To list all palettes and their properties:
from albumpl.palette import list_palettes

list_palettes()

You can also filter for number of colors in the color cycle or type of colormap (sequential/diverging) with the arguments mincolors and maptype.

  • To list all colormaps:
from albumpl.cmap import list_maps

list_maps()
  • To set palette as default for both color cycle and colormap:
from albumpl.palette import set_default

set_default('LondonCalling')
  • To set a palette as default for color cycle or colormap:
from alumpl.palette import set_default_ccyle, set_default_cmap

set_default_ccyle('Antisocialites')

or

set_default_cmap('RhumbLine')
  • To access colormaps without setting them as default: Having run register_all, you can access all of the colormaps using strings -- i.e., 'Matangi' or 'MellonCollie_r' for the reversed 'MellonCollie' map -- or you can access the colormaps via functions (offered as an option since it can be kind of nice for things like easily toggling whether a map is reversed or not).
import matplotlib.pyplot as plt
from albumpl.cmap import * #yes, this is bad practice, but easiest in this case!

register_all() #should only be run one time at the beginning of a script
plt.imshow(image, cmap = 'Yoshimi')

or

import matplotlib.pyplot as plt
from albumpl.cmap import * #yes, this is bad practice, but easiest in this case!

plt.imshow(image, cmap = Yoshimi())

To reverse the colormap, use the argument reverse_cmap = True or just feed the colormap the string "reverse" or "_r".

plt.imshow(image, cmap = Figure8(reverse_cmap = True))

or

plt.imshow(image, cmap = LiveThroughThis('reverse'))

or

plt.imshow(image, cmap = Post('_r'))
  • To access the colors in a color cycle/palette without setting a default:
from albumpl.palette import return_colors

return_colors('VampireWeekend')

These palettes and colormaps are designed with a focus on remaining faithful to the appearance of the album covers instead of emphasizing perceptual uniformity. Most are still pretty good in this regard, but, just for everyone's peace of mind, following matplotlib, the lightness of each colormap as a function of index is shown below (all sequential maps are shown dark-to-light for easier comparison). Lightness


Papers that use albumpl:

albumpl's People

Contributors

avapolzin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

7anooch

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.