matplotlib.cm

Les palettes de couleurs intégrées, les utilitaires de gestion des palettes de couleurs et le ScalarMappablemixin.

Voir également

Référence de palette de couleurs pour une liste de palettes de couleurs intégrées.

Création de cartes de couleurs dans Matplotlib pour des exemples de création de cartes de couleurs.

Choisir les cartes de couleurs dans Matplotlib une discussion approfondie sur le choix des cartes de couleurs.

Normalisation de la palette de couleurs pour plus de détails sur la normalisation des données.

classe matplotlib.cm. ColormapRegistre ( cmaps )

Socles :Mapping

Conteneur pour les palettes de couleurs connues de Matplotlib par leur nom.

Expérimental

Bien que nous nous attendions à ce que l'API soit définitive, nous la marquons formellement comme expérimentale pour la version 3.5, car nous souhaitons conserver la possibilité d'adapter l'API pour la version 3.6 en cas de besoin.

L'instance de registre universel est matplotlib.colormaps. Les utilisateurs ne devraient pas avoir besoin de s'instancier ColormapRegistryeux-mêmes.

L'accès en lecture utilise une interface de type dict mappant les noms à Colormaps :

import matplotlib as mpl
cmap = mpl.colormaps['viridis']

Les s retournés Colormapsont des copies, de sorte que leur modification ne change pas la définition globale de la palette de couleurs.

Des palettes de couleurs supplémentaires peuvent être ajoutées via ColormapRegistry.register:

mpl.colormaps.register(my_colormap)

registre ( cmap , * , nom = Aucun , force = Faux )

Enregistrez une nouvelle palette de couleurs.

Le nom de la palette de couleurs peut ensuite être utilisé comme argument de chaîne pour n'importe quel cmap paramètre dans Matplotlib. Il est également disponible en pyplot.get_cmap.

Le registre de la palette de couleurs stocke une copie de la palette de couleurs donnée, de sorte que les modifications futures apportées à l'instance de palette de couleurs d'origine n'affectent pas la palette de couleurs enregistrée. Considérez cela comme le registre prenant un instantané de la palette de couleurs lors de l'enregistrement.

Paramètres :

cmap matplotlib.colors.Colormap

La palette de couleurs à enregistrer.

chaîne de nom , facultatif

Nom de la palette de couleurs. S'il n'est pas donné, cmap.nameest utilisé.

force bool, par défaut : False

Si False, une ValueError est déclenchée si vous essayez d'écraser un nom déjà enregistré. True prend en charge l'écrasement des palettes de couleurs enregistrées autres que les palettes de couleurs intégrées.

désinscrire ( nom )

Supprimer une palette de couleurs du registre.

Vous ne pouvez pas supprimer les palettes de couleurs intégrées.

Si la palette de couleurs nommée n'est pas enregistrée, retourne sans erreur, se déclenche si vous essayez de désenregistrer une palette de couleurs par défaut.

Avertissement

Les noms de palette de couleurs sont actuellement un espace de noms partagé qui peut être utilisé par plusieurs packages. À n'utiliser unregisterque si vous savez que vous avez déjà enregistré ce nom. En particulier, ne désenregistrez pas juste au cas où pour nettoyer le nom avant d'enregistrer une nouvelle palette de couleurs.

Paramètres :

chaîne de nom

Nom de la palette de couleurs à supprimer.

Augmente :

Erreur de valeur

Si vous essayez de supprimer une palette de couleurs intégrée par défaut.

classe matplotlib.cm. ScalarMappable ( norm = None , cmap = None )

Socles :object

Une classe mixin pour mapper des données scalaires à RGBA.

Le ScalarMappable applique la normalisation des données avant de renvoyer les couleurs RGBA à partir de la palette de couleurs donnée.

Paramètres :

norm Normalize(ou sous-classe de celle-ci) ou str ou None

L'objet de normalisation qui met à l'échelle les données, généralement dans l'intervalle . Si a , une sous-classe est générée dynamiquement en fonction de l'échelle avec le nom correspondant. Si None , norm prend par défaut un objet colors.Normalize qui initialise sa mise à l'échelle en fonction des premières données traitées.[0, 1]strNormalize

chaîne cmap ouColormap

La palette de couleurs utilisée pour mapper les valeurs de données normalisées aux couleurs RVBA.

mise à l'échelle automatique ( )

Mise à l'échelle automatique des limites scalaires sur l'instance de norme à l'aide du tableau actuel

autoscale_None ( )

Mise à l'échelle automatique des limites scalaires sur l'instance de norme à l'aide du tableau actuel, en modifiant uniquement les limites qui sont Aucune

propriété callbacksSM

modifié ( )

Appelez ceci chaque fois que le mappable est modifié pour notifier tous les écouteurs callbackSM du signal 'modifié'.

barre de couleur

La dernière colorbar associée à ce ScalarMappable. Peut être Aucun.

get_alpha ( )

Retours :

flotteur

Renvoie toujours 1.

get_array ( )

Renvoie le tableau de valeurs, qui sont mappées aux couleurs.

La classe de base ScalarMappablene fait aucune hypothèse sur la dimensionnalité et la forme du tableau.

get_clim ( )

Renvoie les valeurs (min, max) qui sont mappées aux limites de la palette de couleurs.

get_cmap ( )

Renvoie l' Colormapinstance.

norme de propriété

set_array ( A )

Définissez le tableau de valeurs à partir d'un tableau de type A .

Paramètres :

Un type de tableau ou Aucun

Les valeurs qui sont mappées aux couleurs.

La classe de base ScalarMappablene fait aucune hypothèse sur la dimensionnalité et la forme du tableau de valeurs A .

set_clim ( vmin = Aucun , vmax = Aucun )

Définissez les limites de la norme pour la mise à l'échelle de l'image.

Paramètres :

flottant vmin, vmax

Les limites.

Les limites peuvent également être transmises sous forme de tuple ( vmin , vmax ) en tant qu'argument positionnel unique.

set_cmap ( cmap )

Définissez la palette de couleurs pour les données de luminance.

Paramètres :

cmap Colormapou str ou Aucun

set_norm ( norme )

Définissez l'instance de normalisation.

Paramètres :

norm Normalizeou str ou None

Remarques

Si des barres de couleurs utilisent le mappable pour cette norme, la définition de la norme du mappable réinitialisera la norme, le localisateur et les formateurs sur la barre de couleurs par défaut.

to_rgba ( x , alpha = None , bytes = False , norm = True )

Renvoie un tableau rgba normalisé correspondant à x .

Dans le cas normal, x est une séquence 1D ou 2D de scalaires, et le ndarray correspondant des valeurs rgba sera renvoyé, en fonction de la norme et de la palette de couleurs définies pour ce ScalarMappable.

Il existe un cas particulier, pour la gestion des images qui sont déjà rgb ou rgba, comme celles qui auraient pu être lues à partir d'un fichier image. Si x est un ndarray à 3 dimensions et que la dernière dimension est 3 ou 4, il sera traité comme un tableau rgb ou rgba et aucun mappage ne sera effectué. Le tableau peut être uint8 ou il peut être à virgule flottante avec des valeurs comprises entre 0 et 1 ; sinon une ValueError sera déclenchée. S'il s'agit d'un tableau masqué, le masque sera ignoré. Si la dernière dimension est 3, l' alpha kwarg (par défaut à 1) sera utilisé pour remplir la transparence. Si la dernière dimension est 4, l' alpha kwarg est ignoré ; il ne remplace pas l'alpha préexistant. Une ValueError sera déclenchée si la troisième dimension est autre que 3 ou 4.

Dans les deux cas, si bytes est False (par défaut), le tableau rgba sera flottant dans la plage 0-1 ; si c'est True , le tableau rgba renvoyé sera uint8 dans la plage de 0 à 255.

Si norm est False, aucune normalisation des données d'entrée n'est effectuée et elles sont supposées être dans la plage (0-1).

matplotlib.cm. get_cmap ( nom = Aucun , lut = Aucun )

[ Obsolète ] Obtenez une instance de palette de couleurs, par défaut les valeurs rc si le nom est None.

Paramètres :

name matplotlib.colors.Colormapou str ou None, par défaut : None

S'il s'agit d'une Colormapinstance, elle sera renvoyée. Sinon, le nom d'une palette de couleurs connue de Matplotlib, qui sera rééchantillonnée par lut . La valeur par défaut, Aucun, signifie rcParams["image.cmap"](par défaut : 'viridis').

lut int ou None, par défaut : None

Si name n'est pas déjà une instance de Colormap et que lut n'est pas None, la palette de couleurs sera rééchantillonnée pour avoir des entrées lut dans la table de recherche.

Retours :

Palette de couleurs

Remarques

Obsolète depuis la version 3.6 : utilisez à la matplotlib.colormaps[name]place.

matplotlib.cm. register_cmap ( nom = Aucun , cmap = Aucun , * , override_builtin = False )

[ Obsolète ] Ajouter une palette de couleurs à l'ensemble reconnu par get_cmap().

Enregistrer une nouvelle palette de couleurs accessible par nom

LinearSegmentedColormap('swirly', data, lut)
register_cmap(cmap=swirly_cmap)

Paramètres :

chaîne de nom , facultatif

Le nom qui peut être utilisé dans get_cmap()ou rcParams["image.cmap"](par défaut : 'viridis')

S'il est absent, le nom sera l' name attribut de la cmap .

cmap matplotlib.colors.Colormap

Bien qu'il s'agisse du deuxième argument et qu'il ait une valeur par défaut, il s'agit d'un argument obligatoire.

override_builtin booléen

Permettre aux palettes de couleurs intégrées d'être remplacées par une palette de couleurs fournie par l'utilisateur.

Veuillez ne pas l'utiliser à moins d'être sûr d'en avoir besoin.

Remarques

Obsolète depuis la version 3.6 : utilisez à la matplotlib.colormaps.register(name)place.

matplotlib.cm. unregister_cmap ( nom )

[ Obsolète ] Supprimer une palette de couleurs reconnue par get_cmap().

Vous ne pouvez pas supprimer les palettes de couleurs intégrées.

Si la palette de couleurs nommée n'est pas enregistrée, retourne sans erreur, se déclenche si vous essayez de désenregistrer une palette de couleurs par défaut.

Avertissement

Les noms de palette de couleurs sont actuellement un espace de noms partagé qui peut être utilisé par plusieurs packages. À n'utiliser unregister_cmapque si vous savez que vous avez déjà enregistré ce nom. En particulier, ne désenregistrez pas juste au cas où pour nettoyer le nom avant d'enregistrer une nouvelle palette de couleurs.

Paramètres :

chaîne de nom

Le nom de la palette de couleurs à désenregistrer

Retours :

ColorMap ou Aucun

Si la palette de couleurs a été enregistrée, retournez-la sinon retournez-laNone

Augmente :

Erreur de valeur

Si vous essayez de désenregistrer une palette de couleurs intégrée par défaut.

Remarques

Obsolète depuis la version 3.6 : utilisez à la matplotlib.colormaps.unregister(name)place.