matplotlib.colorbar#

Le barre dei colori sono una visualizzazione della mappatura dai valori scalari ai colori. In Matplotlib vengono inseriti in un file Axes.

Nota

Le barre dei colori vengono in genere create tramite Figure.colorbaro il suo pyplot wrapper pyplot.colorbar, che utilizza internamente Colorbarinsieme a make_axes_gridspec(per GridSpecgli assi -posizionati) o make_axes(per GridSpecgli assi non -posizionati).

Molto probabilmente gli utenti finali non dovranno utilizzare direttamente l'API di questo modulo.

classe matplotlib.colorbar. Colorbar ( ax , mappable=Nessuno , * , cmap=Nessuno , norm=Nessuno , alpha=Nessuno , valori=Nessuno , confini=Nessuno , orientamento='verticale' , ticklocation='auto' , extend=Nessuno , spaziatura='uniforme ' , ticks=Nessuno , format=Nessuno , drawedges=False , filled=< parametro deprecato> , extendfrac=Nessuno , extendrect=False , label='') [fonte] #

Basi:object

Disegna una barra dei colori in un asse esistente.

In genere, le barre dei colori vengono create utilizzando Figure.colorbaro pyplot.colorbare associate a ScalarMappables (come un AxesImagegenerato tramite imshow).

Per disegnare una barra dei colori non associata ad altri elementi nella figura, ad esempio quando si mostra una mappa dei colori da sola, si può creare una barra dei colori vuota ScalarMappableo passare direttamente cmap e norma invece di mappabile a Colorbar.

Metodi pubblici utili sono set_label()e add_lines().

Parametri :
asciaAxes

L' Axesistanza in cui viene disegnata la barra dei colori.

mappabileScalarMappable

Il mappabile di cui verranno utilizzati la mappa dei colori e la norma.

Per mostrare i colori sotto e sopravvalutati, la norma del mappabile deve essere specificata come

norm = colors.Normalize(clip=False)

Per mostrare i colori rispetto all'indice anziché su una scala 0-1, utilizzare:

norm=colors.NoNorm()
cmap Colormap, predefinito: rcParams["image.cmap"](predefinito: 'viridis')

La mappa dei colori da usare. Questo parametro viene ignorato, a meno che mappabile non sia impostato su Nessuno.

normaNormalize

La normalizzazione da utilizzare. Questo parametro viene ignorato, a meno che mappabile non sia impostato su Nessuno.

galleggiante alfa

La trasparenza della barra dei colori tra 0 (trasparente) e 1 (opaco).

orientamento {'verticale', 'orizzontale'}
ticklocation {'auto', 'left', 'right', 'top', 'bottom'}
bordi chiusi bool
bool pieno
estendere {'neither', 'entrambi', 'min', 'max'}

Crea una o più estremità appuntite per i valori fuori intervallo (a meno che "nessuno dei due"). Questi sono impostati per una data mappa di colori usando i metodi set_under e set_over della mappa di colori.

extendfrac { Nessuno , 'auto', lunghezza, lunghezze}

Se impostato su None , entrambe le estensioni della barra dei colori triangolare minima e massima avranno una lunghezza pari al 5% della lunghezza della barra dei colori interna (questa è l'impostazione predefinita).

Se impostato su 'auto', rende le estensioni della barra dei colori triangolari della stessa lunghezza dei riquadri interni (quando la spaziatura è impostata su 'uniforme') o della stessa lunghezza dei rispettivi riquadri interni adiacenti (quando la spaziatura è impostata su 'proporzionale').

Se è uno scalare, indica la lunghezza dell'estensione minima e massima della barra dei colori triangolare come frazione della lunghezza della barra dei colori interna. Si può anche fornire una sequenza di frazioni a due elementi, che indicano rispettivamente le lunghezze delle estensioni minima e massima della barra dei colori come frazione della lunghezza della barra dei colori interna.

extendrect bool

Se False le estensioni minima e massima della barra dei colori saranno triangolari (impostazione predefinita). Se True le estensioni saranno rettangolari.

spaziatura {'uniforme', 'proporzionale'}

Per barre di colore discrete ( BoundaryNormo contorni), 'uniforme' assegna a ciascun colore lo stesso spazio; 'proportional' rende lo spazio proporzionale all'intervallo di dati.

ticks Nessuno o lista di ticks o Locator

Se None, i tick vengono determinati automaticamente dall'input.

format None o str o Formatter

Se Nessuno, ScalarFormatterviene utilizzato. Le stringhe di formato, ad esempio, "%4.2e"o "{x:.2e}", sono supportate. FormatterAl suo posto può essere data un'alternativa .

bordi chiusi bool

Se disegnare linee ai limiti di colore.

etichetta str

L'etichetta sull'asse lungo della barra dei colori.

confini, valori Nessuno o una sequenza

Se non impostato, la mappa dei colori verrà visualizzata su una scala 0-1. Se le sequenze, i valori devono avere una lunghezza 1 inferiore ai limiti . Per ogni regione delimitata da voci adiacenti in boundary , verrà utilizzato il colore mappato al valore corrispondente in values. Normalmente utile solo per i colori indicizzati (es. norm=NoNorm()) o altre circostanze insolite.

Attributi :
asciaAxes

L' Axesistanza in cui viene disegnata la barra dei colori.

elenco righe

Un elenco di LineCollection(vuoto se non sono state tracciate righe).

divisoriLineCollection

Oggetto LineCollection (vuoto se drawedges è False).

add_lines ( * args , ** kwargs ) [fonte] #

Disegna linee sulla barra dei colori.

Le righe vengono aggiunte all'elenco lines.

Parametri :
livelli come un array

Le posizioni delle linee.

colori colore o elenco di colori

O un singolo colore applicato a tutte le linee o un valore di colore per ogni linea.

linewidths float o simile ad un array

O una singola larghezza di riga applicata a tutte le righe o una larghezza di riga per ogni riga.

erase bool, default: True

Se rimuovere eventuali righe aggiunte in precedenza.

Appunti

In alternativa, questo metodo può anche essere chiamato con la firma , nel qual caso i livelli , i colori e le larghezze di riga vengono presi da contour_set .colorbar.add_lines(contour_set, erase=True)

drag_pan ( pulsante , tasto , x , y ) [fonte] #
draw_all ( ) [fonte] #

[ Deprecato ] Calcola tutti i parametri liberi in base alla cmap e alla norma correnti e fai tutto il disegno.

Appunti

Deprecato dalla versione 3.6: usa invece fig.draw_without_rendering().

proprietà riempita [fonte] #
formattatore di proprietà #

Etichetta di segno di spunta principale Formatterper la barra dei colori.

get_ticks ( minor = False ) [fonte] #

Restituisci i segni di spunta come un elenco di posizioni.

Parametri :
minore booleano, predefinito: falso

se True restituisce i tick minori.

localizzatore di proprietà #

Segno di spunta importante Locatorper la barra dei colori.

proprietà minorformatter #

Segno di spunta minore Formatterper la barra dei colori.

localizzatore minore proprietà #

Segno di spunta minore Locatorper la barra dei colori.

minorticks_off ( ) [fonte] #

Disattiva i segni di spunta minori della barra dei colori.

minorticks_on ( ) [fonte] #

Attiva i segni di spunta minori della barra dei colori.

n_rasterizza = 50 #
patch proprietà [fonte] #
rimuovi ( ) [fonte] #

Rimuovi questa barra dei colori dalla figura.

Se la barra dei colori è stata creata con use_gridspec=Trueil gridspec precedente viene ripristinata.

set_alpha ( alpha ) [fonte] #

Impostare la trasparenza tra 0 (trasparente) e 1 (opaco).

Se viene fornito un array, alpha verrà impostato su None per utilizzare i valori di trasparenza associati alla mappa dei colori.

set_label ( etichetta , * , loc = None , ** kwargs ) [fonte] #

Aggiungi un'etichetta all'asse lungo della barra dei colori.

Parametri :
etichetta str

Il testo dell'etichetta.

loc str, facoltativo

La posizione dell'etichetta.

  • Per l'orientamento orizzontale uno tra {'left', 'center', 'right'}

  • Per l'orientamento verticale uno tra {'bottom', 'center', 'top'}

Il valore predefinito è rcParams["xaxis.labellocation"](predefinito: 'center') o rcParams["yaxis.labellocation"](predefinito: 'center') a seconda dell'orientamento.

**kwargs

Gli argomenti delle parole chiave vengono passati a set_xlabel/ set_ylabel. Le parole chiave supportate sono labelpad e Textproperties.

set_ticklabels ( ticklabels , update_ticks=< parametro deprecato> , * , minor=False , **kwargs ) [fonte] #

[ Sconsigliato ] Imposta etichette di spunta.

Scoraggiato

L'uso di questo metodo è sconsigliato, a causa della dipendenza dalle posizioni del tick. Nella maggior parte dei casi, ti consigliamo di utilizzare invece.set_ticks(positions, labels=labels)

Se stai usando questo metodo, dovresti sempre fissare prima le posizioni dei tick, ad esempio usando Colorbar.set_tickso impostando esplicitamente a FixedLocatorsull'asse lungo della barra dei colori. In caso contrario, le zecche sono libere di muoversi e le etichette potrebbero finire in posizioni impreviste.

Parametri :
ticklabels sequenza di str o ofText

Testi per etichettare ogni posizione del segno di spunta nella sequenza impostata da Colorbar.set_ticks; il numero di etichette deve corrispondere al numero di posizioni.

update_ticks bool, predefinito: vero

Questo argomento della parola chiave viene ignorato e verrà rimosso. Deprecato

bool minore

Se True, imposta i tick minori invece dei tick principali.

**kwargs

Textproprietà per le etichette.

set_ticks ( ticks , update_ticks=< parametro deprecato> , labels=None , * , minor=False , **kwargs ) [fonte] #

Imposta le posizioni delle zecche.

Parametri :
spunta l' elenco dei float

Elenco delle posizioni delle zecche.

etichette elenco di str, facoltativo

Elenco delle etichette di spunta. Se non impostato, le etichette mostrano il valore dei dati.

minor bool, default: False

If False, imposta i tick principali; if True, i tick minori.

**kwargs

Textproprietà per le etichette. Questi hanno effetto solo se passi le etichette . Negli altri casi, utilizzare tick_params.

update_normal ( mappabile ) [fonte] #

Aggiorna patch solide, linee, ecc.

Questo dovrebbe essere chiamato quando la norma dell'immagine o del grafico di contorno a cui appartiene questa barra di colore cambia.

Se la norma sul mappabile è diversa da prima, questo ripristina il locatore e il formattatore per l'asse, quindi se questi sono stati personalizzati, dovranno essere personalizzati di nuovo. Tuttavia, se la norma modifica solo i valori di vmin , vmax o cmap , il vecchio formattatore e locatore verranno preservati.

update_ticks ( ) [fonte] #

Imposta i segni di spunta e le etichette di spunta. Questo non dovrebbe essere necessario per gli utenti.

matplotlib.colorbar. ColorbarBase [fonte] #

alias diColorbar

matplotlib.colorbar. make_axes ( genitori , posizione = Nessuno , orientamento = Nessuno , frazione = 0.15 , restringimento = 1.0 , aspetto = 20 , ** kwargs ) [fonte] #

Crea un Axesadatto per una barra dei colori.

Gli assi vengono posizionati nella figura degli assi genitori , ridimensionando e riposizionando i genitori .

Parametri :
genitori Axeso elenco diAxes

Gli assi da utilizzare come genitori per posizionare la barra dei colori.

posizione Nessuno o {'left', 'right', 'top', 'bottom'}

La posizione, relativa agli assi principali, in cui vengono creati gli assi della barra dei colori. Determina anche l' orientamento della barra dei colori (le barre dei colori a sinistra ea destra sono verticali, le barre dei colori in alto e in basso sono orizzontali). Se None, la posizione verrà dall'orientamento se è impostato (barre dei colori verticali a destra, orizzontali in basso), o predefinita a 'destra' se l' orientamento non è impostato.

orientamento Nessuno o {'verticale', 'orizzontale'}

L'orientamento della barra dei colori. È preferibile impostare la posizione della barra dei colori, in quanto determina anche l' orientamento ; il passaggio di valori incompatibili per la posizione e l' orientamento solleva un'eccezione.

frazione float, default: 0.15

Frazione degli assi originali da utilizzare per la barra dei colori.

restringi float, predefinito: 1.0

Frazione per cui moltiplicare la dimensione della barra dei colori.

aspetto float, predefinito: 20

Rapporto tra dimensioni lunghe e corte.

pad float, default: 0.05 se verticale, 0.15 se orizzontale

Frazione degli assi originali tra la barra dei colori e gli assi della nuova immagine.

ancoraggio (galleggiante, galleggiante), opzionale

Il punto di ancoraggio degli assi della barra dei colori. Il valore predefinito è (0.0, 0.5) se verticale; (0.5, 1.0) se orizzontale.

panchor (float, float) o False , facoltativo

Il punto di ancoraggio degli assi padre della barra dei colori. Se False , l'ancora degli assi padre rimarrà invariata. Il valore predefinito è (1.0, 0.5) se verticale; (0.5, 0.0) se orizzontale.

Resi :
caxAxes

Gli assi figli.

kwargs dict

Il dizionario di parole chiave ridotto da passare durante la creazione dell'istanza colorbar.

matplotlib.colorbar. make_axes_gridspec ( genitore , * , posizione = Nessuno , orientamento = Nessuno , frazione = 0.15 , restringimento = 1.0 , aspetto = 20 , ** kwargs ) [fonte] #

Crea un SubplotBaseadatto per una barra dei colori.

Gli assi vengono posizionati nella figura degli assi padre , ridimensionando e riposizionando parent .

Questa funzione è simile a make_axes. Le differenze principali sono

Sebbene questa funzione sia compatibile con make_axes, potrebbero esserci alcune piccole differenze.

Parametri :
genitoreAxes

Gli assi da utilizzare come genitore per posizionare la barra dei colori.

posizione Nessuno o {'left', 'right', 'top', 'bottom'}

La posizione, relativa agli assi principali, in cui vengono creati gli assi della barra dei colori. Determina anche l' orientamento della barra dei colori (le barre dei colori a sinistra ea destra sono verticali, le barre dei colori in alto e in basso sono orizzontali). Se None, la posizione verrà dall'orientamento se è impostato (barre dei colori verticali a destra, orizzontali in basso), o predefinita a 'destra' se l' orientamento non è impostato.

orientamento Nessuno o {'verticale', 'orizzontale'}

L'orientamento della barra dei colori. È preferibile impostare la posizione della barra dei colori, in quanto determina anche l' orientamento ; il passaggio di valori incompatibili per la posizione e l' orientamento solleva un'eccezione.

frazione float, default: 0.15

Frazione degli assi originali da utilizzare per la barra dei colori.

restringi float, predefinito: 1.0

Frazione per cui moltiplicare la dimensione della barra dei colori.

aspetto float, predefinito: 20

Rapporto tra dimensioni lunghe e corte.

pad float, default: 0.05 se verticale, 0.15 se orizzontale

Frazione degli assi originali tra la barra dei colori e gli assi della nuova immagine.

ancoraggio (galleggiante, galleggiante), opzionale

Il punto di ancoraggio degli assi della barra dei colori. Il valore predefinito è (0.0, 0.5) se verticale; (0.5, 1.0) se orizzontale.

panchor (float, float) o False , facoltativo

Il punto di ancoraggio degli assi padre della barra dei colori. Se False , l'ancora degli assi padre rimarrà invariata. Il valore predefinito è (1.0, 0.5) se verticale; (0.5, 0.0) se orizzontale.

Resi :
caxSubplotBase

Gli assi figli.

kwargs dict

Il dizionario di parole chiave ridotto da passare durante la creazione dell'istanza colorbar.