matplotlib.cm

Eingebaute Colormaps, Dienstprogramme zur Handhabung von Colormaps und das ScalarMappableMixin.

Siehe auch

Colormap-Referenz für eine Liste eingebauter Colormaps.

Erstellen von Colormaps in Matplotlib für Beispiele zum Erstellen von Colormaps.

Auswahl von Farbtabellen in Matplotlib eine ausführliche Diskussion über die Auswahl von Farbtabellen.

Colormap-Normalisierung für weitere Details zur Datennormalisierung.

Klasse matplotlib.cm. ColormapRegistry ( cmaps )

Basen:Mapping

Container für Colormaps, die Matplotlib namentlich bekannt sind.

Experimental

Obwohl wir davon ausgehen, dass die API endgültig ist, markieren wir sie formell als experimentell für 3.5, weil wir uns die Option behalten wollen, die API für 3.6 bei Bedarf noch anzupassen.

Die universelle Registrierungsinstanz ist matplotlib.colormaps. Benutzer sollten sich nicht selbst instanziieren ColormapRegistrymüssen.

Der Lesezugriff verwendet eine dict-ähnliche Schnittstelle, die Namen auf Colormaps abbildet:

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

Zurückgegebene Colormaps sind Kopien, sodass ihre Änderung die globale Definition der Farbtabelle nicht ändert.

Zusätzliche Farbkarten können hinzugefügt werden über ColormapRegistry.register:

mpl.colormaps.register(my_colormap)

register ( cmap , * , name = None , force = False )

Registrieren Sie eine neue Farbtabelle.

Der Colormap-Name kann dann als String-Argument für jeden cmap Parameter in Matplotlib verwendet werden. Es ist auch erhältlich in pyplot.get_cmap.

Die Farbzuordnungsregistrierung speichert eine Kopie der gegebenen Farbzuordnung, sodass zukünftige Änderungen an der ursprünglichen Farbzuordnungsinstanz die registrierte Farbzuordnung nicht beeinflussen. Stellen Sie sich das so vor, als würde die Registrierung bei der Registrierung einen Schnappschuss der Farbtabelle erstellen.

Parameter :

cmap matplotlib.colors.Colormap

Die zu registrierende Colormap.

Namensstr , optional

Der Name für die Farbtabelle. Wenn nicht angegeben, cmap.namewird verwendet.

bool erzwingen , Standard: False

Bei False wird ein ValueError ausgelöst, wenn versucht wird, einen bereits registrierten Namen zu überschreiben. True unterstützt das Überschreiben registrierter Farbtabellen außer den integrierten Farbtabellen.

Registrierung aufheben ( Name )

Entfernen Sie eine Colormap aus der Registrierung.

Sie können integrierte Farbkarten nicht entfernen.

Wenn die benannte Farbtabelle nicht registriert ist, wird sie ohne Fehler zurückgegeben und ausgelöst, wenn Sie versuchen, eine Standardfarbtabelle abzumelden.

Warnung

Colormap-Namen sind derzeit ein gemeinsam genutzter Namensraum, der von mehreren Paketen verwendet werden kann. Nur verwenden unregister, wenn Sie wissen, dass Sie diesen Namen schon einmal registriert haben. Heben Sie die Registrierung insbesondere nicht auf, nur um den Namen zu löschen, bevor Sie eine neue Farbtabelle registrieren.

Parameter :

Namensstr _

Der Name der zu entfernenden Farbtabelle.

Erhöhungen :

WertFehler

Wenn Sie versuchen, eine standardmäßig integrierte Colormap zu entfernen.

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

Basen:object

Eine Mixin-Klasse zum Zuordnen von Skalardaten zu RGBA.

Das ScalarMappable wendet die Datennormalisierung an, bevor RGBA-Farben aus der angegebenen Farbtabelle zurückgegeben werden.

Parameter :

norm Normalize(oder Unterklasse davon) oder str oder None

Das normalisierende Objekt, das Daten skaliert, typischerweise in das Intervall . Wenn a , wird eine Unterklasse basierend auf der Skala mit dem entsprechenden Namen dynamisch generiert. Bei None wird norm standardmäßig auf ein colors.Normalize- Objekt gesetzt, das seine Skalierung basierend auf den ersten verarbeiteten Daten initialisiert.[0, 1]strNormalize

cmapstr oderColormap

Die Colormap, die verwendet wird, um normalisierte Datenwerte RGBA-Farben zuzuordnen.

Autoskalierung ( )

Skalieren Sie die skalaren Grenzwerte für die Norminstanz mithilfe des aktuellen Arrays automatisch

autoscale_None ( )

Skalieren Sie die skalaren Grenzwerte für die Norminstanz mithilfe des aktuellen Arrays automatisch und ändern Sie nur die Grenzwerte, die „None“ sind

Eigenschaft CallbacksSM

geändert ( )

Rufen Sie dies immer dann auf, wenn das Mappable geändert wird, um alle callbackSM-Listener über das „geänderte“ Signal zu informieren.

Farbbalken

Der letzte diesem ScalarMappable zugeordnete Farbbalken. Kann Keine sein.

get_alpha ( )

Rückgaben :

schweben

Gibt immer 1 zurück.

get_array ( )

Gibt das Array von Werten zurück, die Farben zugeordnet sind.

Die Basisklasse ScalarMappablemacht keine Annahmen über die Dimensionalität und Form des Arrays.

get_clim ( )

Gibt die Werte (Min, Max) zurück, die den Farbzuordnungsgrenzen zugeordnet sind.

get_cmap ( )

Geben Sie die ColormapInstanz zurück.

Eigenschaftsnorm #

set_array ( A )

Legen Sie das Wert-Array von array-like A fest .

Parameter :

Ein Array-ähnliches oder None

Die Werte, die Farben zugeordnet sind.

Die Basisklasse ScalarMappablemacht keine Annahmen über die Dimensionalität und Form des Wertearrays A .

set_clim ( vmin = None , vmax = None )

Stellen Sie die Normgrenzen für die Bildskalierung ein.

Parameter :

vmin, vmax Float

Die Grenzen.

Die Grenzen können auch als Tupel ( vmin , vmax ) als einzelnes Positionsargument übergeben werden.

set_cmap ( cmap )

Legen Sie die Colormap für Luminanzdaten fest.

Parameter :

cmap Colormapoder str oder None

set_norm ( norm )

Legen Sie die Normalisierungsinstanz fest.

Parameter :

norm Normalizeoder str oder None

Anmerkungen

Wenn es Farbbalken gibt, die das Mappable für diese Norm verwenden, werden durch Festlegen der Norm des Mappables die Norm, der Locator und die Formatierer auf dem Farbbalken auf die Standardeinstellungen zurückgesetzt.

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

Gibt ein normalisiertes rgba-Array zurück, das x entspricht .

Im Normalfall ist x eine 1D- oder 2D-Folge von Skalaren, und das entsprechende ndarray von rgba-Werten wird zurückgegeben, basierend auf der für dieses ScalarMappable festgelegten Norm und Colormap.

Es gibt einen Sonderfall für die Handhabung von Bildern, die bereits rgb oder rgba sind, wie sie beispielsweise aus einer Bilddatei gelesen wurden. Wenn x ein ndarray mit 3 Dimensionen ist und die letzte Dimension entweder 3 oder 4 ist, wird es als rgb- oder rgba-Array behandelt, und es wird keine Zuordnung durchgeführt. Das Array kann uint8 sein, oder es kann ein Gleitkommawert mit Werten im Bereich 0-1 sein; andernfalls wird ein ValueError ausgelöst. Wenn es sich um ein maskiertes Array handelt, wird die Maske ignoriert. Wenn die letzte Dimension 3 ist, wird das Alpha -Kwarg (standardmäßig 1) verwendet, um die Transparenz auszufüllen. Wenn die letzte Dimension 4 ist, wird das Alpha -Kwarg ignoriert; es ersetzt nicht das bereits vorhandene Alpha. Ein ValueError wird ausgelöst, wenn die dritte Dimension nicht 3 oder 4 ist.

In beiden Fällen, wenn bytes False ist (Standard), wird das rgba-Array Floats im Bereich 0-1 sein; Wenn es True ist , ist das zurückgegebene rgba-Array uint8 im Bereich von 0 bis 255.

Wenn norm False ist, wird keine Normalisierung der Eingabedaten durchgeführt und es wird angenommen, dass sie im Bereich (0–1) liegen.

matplotlib.cm. get_cmap ( name = None , lut = None )

[ Veraltet ] Ruft eine Colormap-Instanz ab und verwendet standardmäßig rc-Werte, wenn Name None ist.

Parameter :

name matplotlib.colors.Colormapoder str oder None, Standard: None

Wenn es sich um eine ColormapInstanz handelt, wird sie zurückgegeben. Andernfalls der Name einer Matplotlib bekannten Colormap, die von lut neu gesampelt wird . Der Standardwert „None“ bedeutet rcParams["image.cmap"](Standardwert: 'viridis').

lut int oder None, Standard: None

Wenn name nicht bereits eine Colormap-Instanz ist und lut nicht None ist, wird die Colormap neu abgetastet, um lut - Einträge in der Nachschlagetabelle zu haben.

Rückgaben :

Farbkarte

Anmerkungen

Veraltet seit Version 3.6: Verwenden Sie matplotlib.colormaps[name]stattdessen.

matplotlib.cm. register_cmap ( name = None , cmap = None , * , override_builtin = False )

[ Veraltet ] Fügt eine Colormap zu dem von erkannten Set hinzu get_cmap().

Registrieren Sie eine neue Farbkarte, auf die über den Namen zugegriffen werden soll

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

Parameter :

Namensstr , optional

Der Name, der in get_cmap()oder verwendet werden kann rcParams["image.cmap"](Standard: 'viridis')

Wenn nicht vorhanden, ist der Name das name Attribut von cmap .

cmap matplotlib.colors.Colormap

Obwohl es das zweite Argument ist und einen Standardwert hat, ist dies ein erforderliches Argument.

override_builtin bool

Ermöglicht das Überschreiben integrierter Farbtabellen durch eine vom Benutzer bereitgestellte Farbtabelle.

Bitte verwenden Sie dies nur, wenn Sie sicher sind, dass Sie es benötigen.

Anmerkungen

Veraltet seit Version 3.6: Verwenden Sie matplotlib.colormaps.register(name)stattdessen.

matplotlib.cm. unregister_cmap ( name )

[ Veraltet ] Entfernt eine von erkannte Farbtabelle get_cmap().

Sie dürfen integrierte Farbkarten nicht entfernen.

Wenn die benannte Farbtabelle nicht registriert ist, wird sie ohne Fehler zurückgegeben und ausgelöst, wenn Sie versuchen, eine Standardfarbtabelle abzumelden.

Warnung

Colormap-Namen sind derzeit ein gemeinsam genutzter Namensraum, der von mehreren Paketen verwendet werden kann. Nur verwenden unregister_cmap, wenn Sie wissen, dass Sie diesen Namen schon einmal registriert haben. Heben Sie die Registrierung insbesondere nicht auf, nur um den Namen zu löschen, bevor Sie eine neue Farbtabelle registrieren.

Parameter :

Namensstr _

Der Name der Farbtabelle, deren Registrierung aufgehoben werden soll

Rückgaben :

ColorMap oder Keine

Wenn die Farbtabelle registriert wurde, geben Sie sie zurück, wenn nicht, geben Sie sie zurückNone

Erhöhungen :

WertFehler

Wenn Sie versuchen, eine standardmäßig integrierte Farbzuordnung abzumelden.

Anmerkungen

Veraltet seit Version 3.6: Verwenden Sie matplotlib.colormaps.unregister(name)stattdessen.