matplotlib.pyplot.colorbar #
- matplotlib.pyplot. colorbar ( mappable = None , cax = None , ax = None , ** kwargs ) [source] #
Ajouter une barre de couleurs à un tracé.
- Paramètres :
- mappable
Le
matplotlib.cm.ScalarMappable(c'est-à-dire,AxesImage,ContourSet, etc.) décrit par cette barre de couleurs. Cet argument est obligatoire pour laFigure.colorbarméthode mais facultatif pour lapyplot.colorbarfonction, qui définit la valeur par défaut sur l'image actuelle.Notez que l'on peut créer un
ScalarMappable"à la volée" pour générer des barres de couleurs non attachées à un artiste précédemment dessiné, par exemplefig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
- cax
Axes, facultatif Axes dans lesquels la barre de couleurs sera dessinée.
- hache
Axes, liste des haches, facultatif Un ou plusieurs axes parents à partir desquels l'espace pour un nouvel axe de barre de couleur sera volé, si cax vaut None. Cela n'a aucun effet si cax est activé.
- use_gridspec booléen , facultatif
Si cax vaut
None, un nouveau cax est créé en tant qu'instance de Axes. Si ax est une instance de Subplot et use_gridspec vautTrue, cax est créé en tant qu'instance de Subplot à l'aide dugridspecmodule.
- Retours :
- barre de couleur
Colorbar
- barre de couleur
- Autres paramètres :
- 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.
- é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 alternativeFormatterpeut ê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.
Remarques
Si mappable est un
ContourSet, son extension kwarg est automatiquement incluse.Le rétrécissement kwarg fournit un moyen simple de mettre à l'échelle la barre de couleurs par rapport aux axes. Notez que si cax est spécifié, il détermine la taille de la barre de couleurs et les kwargs de rétrécissement et d' aspect sont ignorés.
Pour un contrôle plus précis, vous pouvez spécifier manuellement les positions des objets axes dans lesquels le mappable et la barre de couleurs sont dessinés. Dans ce cas, n'utilisez aucune des propriétés d'axe kwargs.
Il est connu que certains visualiseurs de graphiques vectoriels (svg et pdf) affichent des espaces blancs entre les segments de la barre de couleurs. Cela est dû à des bogues dans les visualiseurs, pas à Matplotlib. Pour contourner ce problème, la barre de couleurs peut être rendue avec des segments qui se chevauchent :
cbar = colorbar() cbar.solids.set_edgecolor("face") draw()
Cependant, cela a des conséquences négatives dans d'autres circonstances, par exemple avec des images semi-transparentes (alpha < 1) et des extensions de barre de couleur ; par conséquent, cette solution de contournement n'est pas utilisée par défaut (voir problème #1188).
