matplotlib.colorbar

Farbbalken sind eine Visualisierung der Zuordnung von Skalarwerten zu Farben. In Matplotlib werden sie in eine dedizierte Axes.

Notiz

Farbbalken werden normalerweise durch Figure.colorbaroder ihren Pyplot-Wrapper erstellt pyplot.colorbar, die intern Colorbarzusammen mit make_axes_gridspec(für GridSpec-positionierte Achsen) oder make_axes(für nicht- GridSpec-positionierte Achsen) verwendet werden.

Endbenutzer müssen die API dieses Moduls höchstwahrscheinlich nicht direkt verwenden.

Klasse matplotlib.colorbar. Colorbar ( ax , mappable =None , * , cmap=None , norm=None , alpha=None , values=None ,, direction ='vertical' , ticklocation='auto' , extend=None , spaced = 'uniform ' , ticks =None , format=None , drawedges=False , Filled =<veralteter Parameter> , extendfrac=None , extendrect=False , label='' )

Basen:object

Zeichnen Sie einen Farbbalken in eine vorhandene Achse.

Typischerweise werden Farbbalken mit Figure.colorbaroder erstellt pyplot.colorbarund mit ScalarMappables verknüpft (z. B. ein AxesImagegeneriertes via imshow).

Um einen Farbbalken zu zeichnen, der nicht mit anderen Elementen in der Figur verbunden ist, zB wenn eine Farbtabelle allein angezeigt wird, kann man eine leere erstellen ScalarMappableoder direkt cmap und norm anstelle von mappable to übergeben Colorbar.

Nützliche öffentliche Methoden sind set_label()und add_lines().

Parameter :

AxtAxes

Die AxesInstanz, in der der Farbbalken gezeichnet wird.

abbildbarScalarMappable

Das Mappable, dessen Colormap und Norm verwendet werden.

Um die Unter- und Überwertfarben anzuzeigen, sollte die Norm des Mappable als angegeben werden

norm = colors.Normalize(clip=False)

Um die Farben im Vergleich zum Index statt auf einer Skala von 0-1 anzuzeigen, verwenden Sie:

norm=colors.NoNorm()

cmap Colormap, Standard: rcParams["image.cmap"](Standard: 'viridis')

Die zu verwendende Farbtabelle. Dieser Parameter wird ignoriert, es sei denn, mappable ist None.

NormNormalize

Die zu verwendende Normalisierung. Dieser Parameter wird ignoriert, es sei denn, mappable ist None.

Alpha -Float

Die Farbbalkentransparenz zwischen 0 (transparent) und 1 (deckend).

Ausrichtung {'vertikal', 'horizontal'}

ticklocation {'auto', 'links', 'rechts', 'oben', 'unten'}

Ziehkanten bool

gefüllter bool

verlängern {'weder', 'beide', 'min', 'max'}

Machen Sie spitze(s) Ende(n) für Werte außerhalb des zulässigen Bereichs (außer „weder noch“). Diese werden für eine gegebene Colormap mit den Methoden colormap set_under und set_over gesetzt.

extendfrac { None , 'auto', length, lengths}

Wenn „ Keine “ eingestellt ist, haben sowohl die minimale als auch die maximale dreieckige Farbbalkenerweiterung eine Länge von 5 % der inneren Farbbalkenlänge (dies ist die Standardeinstellung).

Bei Einstellung auf „Auto“ werden die dreieckigen Farbbalkenerweiterungen auf die gleiche Länge wie die Innenboxen (wenn der Abstand auf „Uniform“ eingestellt ist) oder auf die gleiche Länge wie die entsprechenden angrenzenden Innenboxen (wenn der Abstand auf „Proportional“ eingestellt ist) eingestellt.

Wenn es sich um einen Skalar handelt, gibt es die Länge sowohl der minimalen als auch der maximalen dreieckigen Farbbalkenerweiterung als Bruchteil der inneren Farbbalkenlänge an. Es kann auch eine aus zwei Elementen bestehende Folge von Brüchen angegeben werden, die die Längen der minimalen und maximalen Farbbalkenerweiterungen jeweils als Bruchteil der inneren Farbbalkenlänge angibt.

Extender bool

Bei False sind die minimalen und maximalen Farbbalkenerweiterungen dreieckig (Standardeinstellung). Bei True sind die Erweiterungen rechteckig.

Abstand {'einheitlich', 'proportional'}

Bei diskreten Farbbalken ( BoundaryNormoder Konturen) gibt 'einheitlich' jeder Farbe den gleichen Raum; 'proportional' macht den Abstand proportional zum Datenintervall.

Ticks Keine oder Liste von Ticks oder Locator

Bei None werden Ticks automatisch aus der Eingabe ermittelt.

format None oder str oder Formatter

Wenn keine, ScalarFormatterwird verwendet. Formatzeichenfolgen, zB "%4.2e"oder "{x:.2e}", werden unterstützt. Stattdessen kann eine Alternative Formatterangegeben werden.

Ziehkanten bool

Ob Linien an Farbgrenzen gezeichnet werden sollen.

Etikettenstr _

Die Beschriftung auf der Längsachse des Farbbalkens.

Grenzen, Werte Keine oder eine Sequenz

Wenn nicht gesetzt, wird die Farbkarte auf einer Skala von 0-1 angezeigt. Bei Sequenzen müssen die Werte eine Länge haben, die um 1 kleiner ist als die Grenzen . Für jede Region, die durch benachbarte Einträge in den Grenzen begrenzt ist, wird die Farbe verwendet, die dem entsprechenden Wert in den Werten zugeordnet ist. Normalerweise nur nützlich für indizierte Farben (dh norm=NoNorm()) oder andere ungewöhnliche Umstände.

Attribute :

AxtAxes

Die AxesInstanz, in der der Farbbalken gezeichnet wird.

Linien Liste

Eine Liste von LineCollection(leer, wenn keine Linien gezeichnet wurden).

TeilerLineCollection

Eine LineCollection (leer, wenn drawedges ) False.

add_lines ( * args , ** kwargs )

Zeichnen Sie Linien auf dem Farbbalken.

Die Zeilen werden an die Liste angehängt lines.

Parameter :

Ebenen Array-artig

Die Positionen der Linien.

Farben Farbe oder Liste von Farben

Entweder eine einzige Farbe für alle Linien oder ein Farbwert für jede Linie.

Linienbreiten schweben oder Array-artig

Entweder eine einzige Linienbreite, die für alle Linien gilt, oder eine Linienbreite für jede Linie.

erase bool, Standard: True

Ob zuvor hinzugefügte Zeilen entfernt werden sollen.

Anmerkungen

Alternativ kann diese Methode auch mit der Signatur aufgerufen werden , wobei Levels , Farben und Linienbreiten aus contour_set übernommen werden .colorbar.add_lines(contour_set, erase=True)

drag_pan ( Taste , Taste , x , y )

draw_all ( )

[ Veraltet ] Berechnen Sie alle freien Parameter basierend auf der aktuellen Cmap und Norm und führen Sie die gesamte Zeichnung durch.

Anmerkungen

Veraltet seit Version 3.6: Verwenden Sie stattdessen fig.draw_without_rendering().

Eigenschaft gefüllt

Eigenschaftsformatierer #

Hauptteilstrichbeschriftung für den Farbbalken Formatter.

get_ticks ( minor = False )

Geben Sie die Häkchen als Liste von Orten zurück.

Parameter :

kleiner boolescher Wert, Standard: False

wenn True die kleinen Ticks zurückgibt.

Immobilienfinder #

Großes Häkchen Locatorfür den Farbbalken.

Eigenschaft Minorformatter

Kleines Häkchen Formatterfür den Farbbalken.

Eigenschaft Minorlocator

Kleines Häkchen Locatorfür den Farbbalken.

minorticks_off ( )

Deaktivieren Sie die kleinen Häkchen des Farbbalkens.

minorticks_on ( )

Aktivieren Sie die kleinen Ticks der Farbleiste.

n_rasterize = 50

Eigenschaftspatch [

entfernen ( )

Entfernen Sie diesen Farbbalken aus der Abbildung.

Wenn der Farbbalken mit use_gridspec=Trueder vorherigen Rasterspezifikation erstellt wurde, wird er wiederhergestellt.

set_alpha ( alpha )

Stellen Sie die Transparenz zwischen 0 (transparent) und 1 (deckend) ein.

Wenn ein Array bereitgestellt wird, wird alpha auf „None“ gesetzt, um die Transparenzwerte zu verwenden, die der Colormap zugeordnet sind.

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

Fügen Sie der Längsachse des Farbbalkens eine Beschriftung hinzu.

Parameter :

Etikettenstr _

Der Beschriftungstext.

loc str, optional

Die Position des Etiketts.

• Für horizontale Ausrichtung entweder {'left', 'center', 'right'}

• Für die vertikale Ausrichtung entweder {'bottom', 'center', 'top'}

Standardmäßig rcParams["xaxis.labellocation"](Standard: 'center') oder rcParams["yaxis.labellocation"](Standard: 'center') je nach Ausrichtung.

**Kwarg

Schlüsselwortargumente werden an set_xlabel/ übergeben set_ylabel. Unterstützte Schlüsselwörter sind labelpad und Textproperties.

set_ticklabels ( ticklabels , update_ticks=<veralteter Parameter> , * , minor=False , **kwargs )

[ Entmutigt ] Tick-Labels setzen.

Entmutigt

Wegen der Abhängigkeit von Tick-Positionen wird von der Verwendung dieser Methode abgeraten. In den meisten Fällen werden Sie stattdessen verwenden wollen.set_ticks(positions, labels=labels)

Wenn Sie diese Methode anwenden, sollten Sie die Tick-Positionen vorher immer fixieren, zB durch Verwendung Colorbar.set_ticksoder durch explizites Setzen von a FixedLocatorauf der Längsachse des Farbbalkens. Andernfalls können sich die Häkchen frei bewegen und die Beschriftungen können an unerwarteten Positionen landen.

Parameter :

ticklabels Sequenz von str oder ofText

Texte zur Beschriftung jeder Tick-Position in der durch Colorbar.set_ticks; Die Anzahl der Etiketten muss der Anzahl der Standorte entsprechen.

update_ticks bool, Standard: True

Dieses Schlüsselwortargument wird ignoriert und entfernt. Veraltet

kleiner bool

Wenn True, setze kleinere Ticks anstelle von großen Ticks.

**Kwarg

TextEigenschaften für die Etiketten.

set_ticks ( ticks , update_ticks=<veralteter Parameter> , label=None , * , minor=False , **kwargs )

Tick-Positionen festlegen.

Parameter :

Ticks Liste von Floats

Liste der Zeckenstandorte.

Etikettenliste von str, optional

Liste der Tick-Labels. Wenn nicht festgelegt, zeigen die Beschriftungen den Datenwert.

Minor Bool, Standard: False

Wenn False, setze die großen Häkchen; wenn True, tickt der Moll.

**Kwarg

TextEigenschaften für die Etiketten. Diese werden nur wirksam, wenn Sie Labels übergeben . In anderen Fällen verwenden Sie bitte tick_params.

update_normal ( abbildbar )

Aktualisieren Sie durchgehende Patches, Linien usw.

Dies soll aufgerufen werden, wenn sich die Norm des Bildes oder des Konturdiagramms, zu dem dieser Farbbalken gehört, ändert.

Wenn die Norm auf dem Mappable anders ist als zuvor, werden der Locator und der Formatierer für die Achse zurückgesetzt. Wenn diese also angepasst wurden, müssen sie erneut angepasst werden. Wenn die Norm jedoch nur die Werte von vmin , vmax oder cmap ändert, bleiben der alte Formatierer und Locator erhalten.

update_ticks ( )

Richten Sie die Ticks und Ticklabels ein. Dies sollte von Benutzern nicht benötigt werden.

matplotlib.colorbar. ColorbarBase

Pseudonym vonColorbar

matplotlib.colorbar. make_axes ( Eltern , Ort = None , Orientierung = None , Bruch = 0,15 , Schrumpfen = 1,0 , Aspekt = 20 , ** kwargs )

Erstellen Sie eine Axesfür einen Farbbalken geeignete.

Die Achsen werden in der Figur der Elternachsen platziert, indem die Eltern in der Größe geändert und neu positioniert werden .

Parameter :

Eltern Axesoder Liste vonAxes

Die Achsen, die als Eltern zum Platzieren des Farbbalkens verwendet werden sollen.

Ort Keine oder {'links', 'rechts', 'oben', 'unten'}

Die Position relativ zu den übergeordneten Achsen, an der die Farbbalkenachsen erstellt werden. Es bestimmt auch die Ausrichtung des Farbbalkens (Farbbalken links und rechts sind vertikal, Farbbalken oben und unten sind horizontal). Wenn None, wird die Position von der Ausrichtung kommen, wenn sie eingestellt ist (vertikale Farbbalken rechts, horizontale unten), oder standardmäßig „rechts“, wenn die Ausrichtung nicht eingestellt ist.

Ausrichtung Keine oder {'vertikal', 'horizontal'}

Die Ausrichtung des Farbbalkens. Es ist vorzuziehen, die Position des Farbbalkens festzulegen, da dies auch die Ausrichtung bestimmt ; Das Übergeben inkompatibler Werte für Standort und Ausrichtung löst eine Ausnahme aus.

Bruchfloat , Standard: 0,15

Bruchteil der Originalachsen, der für den Farbbalken verwendet werden soll.

Schwimmer schrumpfen , Standard: 1,0

Bruchteil, mit dem die Größe des Farbbalkens multipliziert werden soll.

Aspekt Float, Standard: 20

Verhältnis von langen zu kurzen Abmessungen.

Pad Float, Standard: 0,05 wenn vertikal, 0,15 wenn horizontal

Bruchteil der Originalachsen zwischen Farbbalken und neuen Bildachsen.

Anker (Schwimmer, Schwimmer), optional

Der Ankerpunkt der Farbbalkenachsen. Standardeinstellung (0,0, 0,5), wenn vertikal; (0,5, 1,0) wenn horizontal.

panchor (float, float) oder False , optional

Der Ankerpunkt der übergeordneten Farbbalkenachsen. Bei False bleibt der Anker der übergeordneten Achsen unverändert. Standardeinstellung (1,0, 0,5), wenn vertikal; (0,5, 0,0) wenn horizontal.

Rückgaben :

caxAxes

Die Kinderäxte.

kwargs dict

Das reduzierte Schlüsselwörterverzeichnis, das beim Erstellen der Farbbalkeninstanz übergeben werden soll.

matplotlib.colorbar. make_axes_gridspec ( Elternteil , * , Ort = None , Ausrichtung = None , Bruch = 0,15 , Schrumpfen = 1,0 , Aspekt = 20 , ** Kwargs )

Erstellen Sie eine SubplotBasefür einen Farbbalken geeignete.

Die Achsen werden in der Abbildung der übergeordneten Achsen platziert, indem die Größe geändert und die übergeordnete Achse neu positioniert wird .

Diese Funktion ähnelt make_axes. Primäre Unterschiede sind

• make_axes_gridspecsollte nur mit einem SubplotBaseElternteil verwendet werden.

• make_axeserstellt ein Axes; make_axes_gridspecerstellt eine SubplotBase.

• make_axesaktualisiert die Position des Elternteils. make_axes_gridspec ersetzt das grid_specAttribut des Elternteils durch ein neues.

Obwohl diese Funktion mit kompatibel sein soll make_axes, kann es einige geringfügige Unterschiede geben.

Parameter :

ElternteilAxes

Die Achsen, die als übergeordnetes Element zum Platzieren des Farbbalkens verwendet werden sollen.

Ort Keine oder {'links', 'rechts', 'oben', 'unten'}

Die Position relativ zu den übergeordneten Achsen, an der die Farbbalkenachsen erstellt werden. Es bestimmt auch die Ausrichtung des Farbbalkens (Farbbalken links und rechts sind vertikal, Farbbalken oben und unten sind horizontal). Wenn None, wird die Position von der Ausrichtung kommen, wenn sie eingestellt ist (vertikale Farbbalken rechts, horizontale unten), oder standardmäßig „rechts“, wenn die Ausrichtung nicht eingestellt ist.

Ausrichtung Keine oder {'vertikal', 'horizontal'}

Die Ausrichtung des Farbbalkens. Es ist vorzuziehen, die Position des Farbbalkens festzulegen, da dies auch die Ausrichtung bestimmt ; Das Übergeben inkompatibler Werte für Standort und Ausrichtung löst eine Ausnahme aus.

Bruchfloat , Standard: 0,15

Bruchteil der Originalachsen, der für den Farbbalken verwendet werden soll.

Schwimmer schrumpfen , Standard: 1,0

Bruchteil, mit dem die Größe des Farbbalkens multipliziert werden soll.

Aspekt Float, Standard: 20

Verhältnis von langen zu kurzen Abmessungen.

Pad Float, Standard: 0,05 wenn vertikal, 0,15 wenn horizontal

Bruchteil der Originalachsen zwischen Farbbalken und neuen Bildachsen.

Anker (Schwimmer, Schwimmer), optional

Der Ankerpunkt der Farbbalkenachsen. Standardeinstellung (0,0, 0,5), wenn vertikal; (0,5, 1,0) wenn horizontal.

panchor (float, float) oder False , optional

Der Ankerpunkt der übergeordneten Farbbalkenachsen. Bei False bleibt der Anker der übergeordneten Achsen unverändert. Standardeinstellung (1,0, 0,5), wenn vertikal; (0,5, 0,0) wenn horizontal.

Rückgaben :

caxSubplotBase

Die Kinderäxte.

kwargs dict

Das reduzierte Schlüsselwörterverzeichnis, das beim Erstellen der Farbbalkeninstanz übergeben werden soll.