matplotlib.colorbar

Les barres de couleurs sont une visualisation du mappage des valeurs scalaires aux couleurs. Dans Matplotlib, ils sont attirés dans un fichier Axes.

Noter

Les barres de couleurs sont généralement créées via Figure.colorbarou son wrapper pyplot pyplot.colorbar, qui est utilisé en interne Colorbaravec make_axes_gridspec(pour GridSpecles axes positionnés) ou make_axes(pour GridSpecles axes non positionnés).

Les utilisateurs finaux n'auront probablement pas besoin d'utiliser directement l'API de ce module.

classe matplotlib.colorbar. Colorbar ( ax , mappable=Aucun , * , cmap=Aucun , norm=Aucun , alpha=Aucun , values=Aucun , bounds =Aucun , orientation='vertical' , ticklocation='auto' , extend=Aucun , spacing='uniform ' , ticks=Aucun , format=Aucun , drawedges=Faux , filled=< paramètre obsolète> , extendfrac=Aucun , extendrect=Faux , label='')

Socles :object

Dessinez une barre de couleurs dans un axe existant.

En règle générale, les barres de couleurs sont créées à l'aide Figure.colorbarde ou pyplot.colorbaret associées à ScalarMappables (comme une AxesImagegénérée via imshow).

Afin de dessiner une barre de couleurs non associée à d'autres éléments de la figure, par exemple lors de l'affichage d'une palette de couleurs par elle-même, on peut créer un vide ScalarMappableou passer directement cmap et norm au lieu de mappable à Colorbar.

Les méthodes publiques utiles sont set_label()et add_lines().

Paramètres :

hacheAxes

L' Axesinstance dans laquelle la barre de couleurs est dessinée.

mappableScalarMappable

Le mappable dont la palette de couleurs et la norme seront utilisées.

Pour afficher les couleurs de sous-valeur et de sur-valeur, la norme du mappable doit être spécifiée comme

norm = colors.Normalize(clip=False)

Pour afficher les couleurs par rapport à l'index plutôt que sur une échelle de 0 à 1, utilisez :

norm=colors.NoNorm()

cmap Colormap, par défaut : rcParams["image.cmap"](par défaut : 'viridis')

La palette de couleurs à utiliser. Ce paramètre est ignoré, sauf si mappable est None.

normeNormalize

La normalisation à utiliser. Ce paramètre est ignoré, sauf si mappable est None.

flotteur alpha

La transparence de la barre de couleurs entre 0 (transparent) et 1 (opaque).

orientation {'vertical', 'horizontal'}

ticklocation {'auto', 'gauche', 'droite', 'haut', 'bas'}

bords tirés bool

booléen rempli

étendre {'aucun', 'les deux', 'min', 'max'}

Faites des extrémités pointues pour les valeurs hors plage (sauf si "ni l'un ni l'autre"). Ceux-ci sont définis pour une palette de couleurs donnée à l'aide des méthodes colormap set_under et set_over.

extendfrac { Aucun , 'auto', longueur, longueurs}

S'il est défini sur None , les extensions de barre de couleurs triangulaires minimale et maximale auront une longueur de 5 % de la longueur de la barre de couleurs intérieure (il s'agit du paramètre par défaut).

Si défini sur 'auto', les extensions de barres de couleurs triangulaires ont la même longueur que les boîtes intérieures (lorsque l' espacement est défini sur 'uniforme') ou les mêmes longueurs que les boîtes intérieures adjacentes respectives (lorsque l' espacement est défini sur 'proportionnel').

S'il s'agit d'un scalaire, indique la longueur des extensions de barre de couleurs triangulaires minimale et maximale en tant que fraction de la longueur de la barre de couleurs intérieure. Une séquence de fractions à deux éléments peut également être donnée, indiquant les longueurs des extensions de barre de couleur minimale et maximale respectivement en tant que fraction de la longueur de la barre de couleur intérieure.

booléen extendrect

Si False , les extensions minimum et maximum de la barre de couleurs seront triangulaires (par défaut). Si True , les extensions seront rectangulaires.

espacement {'uniforme', 'proportionnel'}

Pour les barres de couleurs discrètes ( BoundaryNormou contours), 'uniforme' donne à chaque couleur le même espace ; 'proportionnel' rend l'espace proportionnel à l'intervalle de données.

ticks Aucun ou liste de ticks ou Locator

Si aucun, les graduations sont déterminées automatiquement à partir de l'entrée.

format Aucun ou str ou Formatter

Si Aucun, ScalarFormatterest utilisé. Les chaînes de format, par exemple, "%4.2e"ou "{x:.2e}", sont prises en charge. Une alternative Formatterpeut être donnée à la place.

bords tirés bool

S'il faut tracer des lignes aux limites de couleur.

étiquette str

L'étiquette sur l'axe long de la barre de couleurs.

frontières, valeurs Aucune ou une séquence

S'il n'est pas défini, la palette de couleurs sera affichée sur une échelle de 0 à 1. S'il s'agit de séquences, les valeurs doivent avoir une longueur inférieure de 1 à bounds . Pour chaque région délimitée par des entrées adjacentes dans bounds , la couleur associée à la valeur correspondante dans values ​​sera utilisée. Normalement utile uniquement pour les couleurs indexées (c'est-à-dire norm=NoNorm()) ou d'autres circonstances inhabituelles.

Attributs :

hacheAxes

L' Axesinstance dans laquelle la barre de couleurs est dessinée.

liste de lignes

Une liste de LineCollection(vide si aucune ligne n'a été tracée).

séparateursLineCollection

Une LineCollection (vide si drawedges vaut False).

add_lines ( * args , ** kwargs )

Dessinez des lignes sur la barre de couleurs.

Les lignes sont ajoutées à la liste lines.

Paramètres :

niveaux de type tableau

Les positions des lignes.

couleurs couleur ou liste de couleurs

Soit une seule couleur s'appliquant à toutes les lignes, soit une valeur de couleur pour chaque ligne.

largeurs de ligne flottantes ou de type tableau

Soit une largeur de ligne unique s'appliquant à toutes les lignes, soit une largeur de ligne pour chaque ligne.

effacer bool, par défaut : Vrai

S'il faut supprimer les lignes ajoutées précédemment.

Remarques

Alternativement, cette méthode peut également être appelée avec la signature , auquel cas les niveaux , les couleurs et les largeurs de ligne sont extraits de contour_set .colorbar.add_lines(contour_set, erase=True)

drag_pan ( bouton , clé , x , y )

draw_all ( )

[ Obsolète ] Calculez tous les paramètres libres en fonction de la cmap et de la norme actuelles, et faites tout le dessin.

Remarques

Obsolète depuis la version 3.6 : utilisez plutôt fig.draw_without_rendering().

propriété remplie

formateur de propriété

Étiquette de coche majeure Formatterpour la barre de couleurs.

get_ticks ( mineur = False )

Renvoyez les coches sous forme de liste d'emplacements.

Paramètres :

booléen mineur , par défaut : False

si True renvoie les graduations mineures.

localisateur de propriété

Coche majeure Locatorpour la barre de couleurs.

propriété minorformatter

Coche mineure Formatterpour la barre de couleurs.

propriété minorlocator

Coche mineure Locatorpour la barre de couleurs.

minorticks_off ( )

Désactivez les graduations mineures de la barre de couleurs.

minorticks_on ( )

Activez les tiques mineures de la barre de couleur.

n_rasterize = 50

correctif de propriété

supprimer ( )

Supprimez cette barre de couleur de la figure.

Si la barre de couleurs a été créée avec use_gridspec=Truela spécification de grille précédente, elle est restaurée.

set_alpha ( alpha )

Réglez la transparence entre 0 (transparent) et 1 (opaque).

Si un tableau est fourni, alpha sera défini sur Aucun pour utiliser les valeurs de transparence associées à la palette de couleurs.

set_label ( label , * , loc = None , ** kwargs )

Ajoutez une étiquette à l'axe long de la barre de couleurs.

Paramètres :

étiquette str

Le texte de l'étiquette.

loc str, facultatif

L'emplacement de l'étiquette.

• Pour l'orientation horizontale, choisissez {'left', 'center', 'right'}

• Pour l'orientation verticale, choisissez {'bottom', 'center', 'top'}

La valeur par défaut est rcParams["xaxis.labellocation"](par défaut : 'center') ou rcParams["yaxis.labellocation"](par défaut : 'center') selon l'orientation.

**kwargs

Les arguments de mot-clé sont passés à set_xlabel/ set_ylabel. Les mots clés pris en charge sont labelpad et Textproperties.

set_ticklabels ( ticklabels , update_ticks=< paramètre obsolète> , * , minor=False , **kwargs )

[ Déconseillé ] Définissez des étiquettes de coche.

Découragé

L'utilisation de cette méthode est déconseillée, en raison de la dépendance aux positions des ticks. Dans la plupart des cas, vous voudrez utiliser à la place.set_ticks(positions, labels=labels)

Si vous utilisez cette méthode, vous devez toujours fixer les positions des ticks avant, par exemple en utilisant Colorbar.set_ticksou en définissant explicitement un FixedLocatorsur l'axe long de la barre de couleurs. Sinon, les coches sont libres de se déplacer et les étiquettes peuvent se retrouver dans des positions inattendues.

Paramètres :

ticklabels séquence de str ou deText

Textes pour étiqueter chaque emplacement de tick dans la séquence définie par Colorbar.set_ticks; le nombre d'étiquettes doit correspondre au nombre d'emplacements.

update_ticks booléen , par défaut : Vrai

Cet argument de mot clé est ignoré et sera supprimé. Obsolète

booléen mineur

Si True, définissez des graduations mineures au lieu de graduations majeures.

**kwargs

Textpropriétés des étiquettes.

set_ticks ( ticks , update_ticks=< paramètre obsolète> , labels=None , * , minor=False , **kwargs )

Définissez les emplacements des ticks.

Paramètres :

ticks liste des flotteurs

Liste des emplacements de tiques.

étiquettes liste de str, facultatif

Liste des étiquettes de tiques. S'il n'est pas défini, les étiquettes affichent la valeur des données.

booléen mineur , par défaut : False

Si False, définissez les graduations principales ; si True, les ticks mineurs.

**kwargs

Textpropriétés des étiquettes. Celles-ci ne prennent effet que si vous passez des étiquettes . Dans les autres cas, veuillez utiliser tick_params.

update_normal ( mappable )

Mettre à jour les patchs solides, les lignes, etc.

Ceci est censé être appelé lorsque la norme de l'image ou du tracé de contour auquel appartient cette barre de couleurs change.

Si la norme sur le mappable est différente de celle d'avant, cela réinitialise le localisateur et le formateur de l'axe, donc si ceux-ci ont été personnalisés, ils devront être personnalisés à nouveau. Cependant, si la norme ne change que les valeurs de vmin , vmax ou cmap , l'ancien formateur et le localisateur seront conservés.

update_ticks ( )

Configurez les ticks et les ticklabels. Cela ne devrait pas être nécessaire aux utilisateurs.

matplotlib.colorbar. ColorbarBase

pseudonyme deColorbar

matplotlib.colorbar. make_axes ( parents , location = None , orientation = None , fraction = 0.15 , shrink = 1.0 , aspect = 20 , ** kwargs )

Créez un Axesapproprié pour une barre de couleurs.

Les axes sont placés dans la figure des axes parents , en redimensionnant et repositionnant parents .

Paramètres :

parents Axesou liste deAxes

Les axes à utiliser comme parents pour placer la barre de couleurs.

emplacement Aucun ou {'left', 'right', 'top', 'bottom'}

L'emplacement, par rapport aux axes parents, où les axes de la barre de couleurs sont créés. Il détermine également l' orientation de la barre de couleurs (les barres de couleurs à gauche et à droite sont verticales, les barres de couleurs en haut et en bas sont horizontales). Si aucun, l'emplacement proviendra de l' orientation si elle est définie (barres de couleurs verticales à droite, horizontales en bas), ou par défaut à "droite" si l' orientation n'est pas définie.

orientation Aucune ou {'vertical', 'horizontal'}

L'orientation de la barre de couleurs. Il est préférable de définir l' emplacement de la barre de couleurs, car cela détermine également l' orientation ; le passage de valeurs incompatibles pour l' emplacement et l'orientation lève une exception.

flottant de fraction , par défaut : 0,15

Fraction des axes d'origine à utiliser pour la barre de couleurs.

flotteur de rétrécissement , par défaut : 1.0

Fraction par laquelle multiplier la taille de la barre de couleurs.

aspect flottant, par défaut : 20

Rapport entre les dimensions longues et courtes.

pad flottant, par défaut : 0,05 si vertical, 0,15 si horizontal

Fraction des axes d'origine entre la barre de couleurs et les nouveaux axes de l'image.

ancre (flotteur, flotteur), en option

Le point d'ancrage des axes de la barre de couleurs. La valeur par défaut est (0,0, 0,5) si vertical ; (0.5, 1.0) si horizontal.

panchor (float, float), ou False , facultatif

Le point d'ancrage des axes parents de la barre de couleurs. Si False , l'ancre des axes parents sera inchangée. Par défaut (1.0, 0.5) si vertical ; (0.5, 0.0) si horizontal.

Retours :

encaisserAxes

Les axes de l'enfant.

Kwargs dict

Le dictionnaire de mots-clés réduit à transmettre lors de la création de l'instance colorbar.

matplotlib.colorbar. make_axes_gridspec ( parent , * , location = None , orientation = None , fraction = 0.15 , shrink = 1.0 , aspect = 20 , ** kwargs )

Créez un SubplotBaseapproprié pour une barre de couleurs.

Les axes sont placés dans la figure des axes parents , en redimensionnant et repositionnant parent .

Cette fonction est similaire à make_axes. Les principales différences sont

• make_axes_gridspecne doit être utilisé qu'avec un SubplotBaseparent.

• make_axescrée un Axes; make_axes_gridspeccrée un SubplotBase.

• make_axesmet à jour la position du parent. make_axes_gridspec remplace l' grid_specattribut du parent par un nouveau.

Bien que cette fonction soit censée être compatible avec make_axes, il peut y avoir quelques différences mineures.

Paramètres :

parentAxes

Les axes à utiliser comme parent pour placer la barre de couleurs.

emplacement Aucun ou {'left', 'right', 'top', 'bottom'}

L'emplacement, par rapport aux axes parents, où les axes de la barre de couleurs sont créés. Il détermine également l' orientation de la barre de couleurs (les barres de couleurs à gauche et à droite sont verticales, les barres de couleurs en haut et en bas sont horizontales). Si aucun, l'emplacement proviendra de l' orientation si elle est définie (barres de couleurs verticales à droite, horizontales en bas), ou par défaut à "droite" si l' orientation n'est pas définie.

orientation Aucune ou {'vertical', 'horizontal'}

L'orientation de la barre de couleurs. Il est préférable de définir l' emplacement de la barre de couleurs, car cela détermine également l' orientation ; le passage de valeurs incompatibles pour l' emplacement et l'orientation lève une exception.

flottant de fraction , par défaut : 0,15

Fraction des axes d'origine à utiliser pour la barre de couleurs.

flotteur de rétrécissement , par défaut : 1.0

Fraction par laquelle multiplier la taille de la barre de couleurs.

aspect flottant, par défaut : 20

Rapport entre les dimensions longues et courtes.

pad flottant, par défaut : 0,05 si vertical, 0,15 si horizontal

Fraction des axes d'origine entre la barre de couleurs et les nouveaux axes de l'image.

ancre (flotteur, flotteur), en option

Le point d'ancrage des axes de la barre de couleurs. La valeur par défaut est (0,0, 0,5) si vertical ; (0.5, 1.0) si horizontal.

panchor (float, float), ou False , facultatif

Le point d'ancrage des axes parents de la barre de couleurs. Si False , l'ancre des axes parents sera inchangée. Par défaut (1.0, 0.5) si vertical ; (0.5, 0.0) si horizontal.

Retours :

encaisserSubplotBase

Les axes de l'enfant.

Kwargs dict

Le dictionnaire de mots-clés réduit à transmettre lors de la création de l'instance colorbar.