matplotlib.cm

Integrierte Colormaps, Dienstprogramme zur Colormap-Verwaltung und die ScalarMappable Mixin.

Siehe auch

Colormap-Referenz für eine Liste integrierter Colormaps.

Erstellen von Colormaps in Matplotlib für Beispiele, wie Colormaps erstellt werden.

Auswahl von Colormaps in Matplotlib eine eingehende Diskussion zur Auswahl von Colormaps.

Colormap-Normalisierung für weitere Details zur Daten-Normalisierung.

class matplotlib.cm.ColormapRegistry(cmaps)

Bases: Mapping

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

Die universelle Registry-Instanz ist matplotlib.colormaps. Benutzer müssen ColormapRegistry nicht selbst instanziieren.

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, damit ihre Modifikation die globale Definition der Colormap nicht verändert.

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

mpl.colormaps.register(my_colormap)

Um eine Liste aller registrierten Colormaps zu erhalten, können Sie

from matplotlib import colormaps
list(colormaps)

get_cmap(cmap)

Gibt eine durch cmap spezifizierte Colormap zurück.

Parameter:

cmapstr oder Colormap oder None

• Wenn eine Colormap, gib sie zurück.

• Wenn ein String, suche ihn in mpl.colormaps.

• Wenn None, gib die in rcParams["image.cmap"] definierte Colormap zurück (Standard: 'viridis').

Gibt zurück:

Colormap

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

Registriert eine neue Colormap.

Der Colormap-Name kann dann als String-Argument für jeden cmap-Parameter in Matplotlib verwendet werden. Er ist auch in pyplot.get_cmap verfügbar.

Die Colormap-Registry speichert eine Kopie der gegebenen Colormap, sodass zukünftige Änderungen an der ursprünglichen Colormap-Instanz die registrierte Colormap nicht beeinflussen. Betrachten Sie dies als Schnappschuss der Colormap bei der Registrierung durch die Registry.

Parameter:

cmapmatplotlib.colors.Colormap

Die zu registrierende Colormap.

namestr, optional

Der Name für die Colormap. Wenn nicht angegeben, wird cmap.name verwendet.

forcebool, Standard: False

Wenn False, wird ein ValueError ausgelöst, wenn versucht wird, einen bereits registrierten Namen zu überschreiben. True erlaubt das Überschreiben registrierter Colormaps außer den integrierten Colormaps.

unregister(name)

Entfernt eine Colormap aus der Registry.

Integrierte Colormaps können nicht entfernt werden.

Wenn die benannte Colormap nicht registriert ist, wird die Funktion ohne Fehler beendet. Es wird ein Fehler ausgelöst, wenn versucht wird, eine Standard-Colormap zu deregistrieren.

Warnung

Colormap-Namen sind derzeit ein gemeinsam genutzter Namensraum, der von mehreren Paketen verwendet werden kann. Verwenden Sie unregister nur, wenn Sie wissen, dass Sie diesen Namen zuvor registriert haben. Registrieren Sie insbesondere nicht nur zur Sicherheit, um den Namen vor der Registrierung einer neuen Colormap zu bereinigen.

Parameter:

namestr

Der Name der zu entfernenden Colormap.

Löst aus:

ValueError

Wenn versucht wird, eine integrierte Standard-Colormap zu entfernen.

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

[Veraltet] Ruft eine Colormap-Instanz ab, die bei name = None auf RC-Werte zurückfällt.

Parameter:

nameColormap oder str oder None, Standard: None

Wenn eine Colormap-Instanz, wird diese zurückgegeben. Andernfalls wird der Name einer Matplotlib bekannten Colormap zurückgegeben, die durch lut neu abgetastet wird. Der Standardwert None bedeutet rcParams["image.cmap"] (Standard: 'viridis').

lutint oder None, Standard: None

Wenn name keine Colormap-Instanz ist und lut nicht None ist, wird die Colormap so neu abgetastet, dass sie lut Einträge in der Lookup-Tabelle hat.

Gibt zurück:

Colormap

Anmerkungen

Veraltet seit Version 3.7: Verwenden Sie stattdessen matplotlib.colormaps[name] oder matplotlib.colormaps.get_cmap() oder pyplot.get_cmap().

class matplotlib.cm.ScalarMappable(colorizer, **kwargs)

autoscale(self)

Automatische Skalierung der Skalarwerte auf der Norm-Instanz unter Verwendung des aktuellen Arrays.

autoscale_None(self)

Automatische Skalierung der Skalarwerte auf der Norm-Instanz unter Verwendung des aktuellen Arrays, wobei nur Limits geändert werden, die None sind.

changed(self)

Rufen Sie dies auf, wenn sich die Mappable geändert hat, um alle Callback-Listener für das Signal 'changed' zu benachrichtigen.

colorbar

Die letzte diesem ScalarMappable zugeordnete Farbleiste. Kann None sein.

get_alpha(self)

get_array(self)

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

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

get_clim(self)

Gibt die Werte (min, max) zurück, die den Colormap-Grenzen zugeordnet sind.

get_cmap(self)

Gibt die Colormap-Instanz zurück.

property norm

set_array(self, A)

Legt das Werte-Array aus einem Array-ähnlichen Objekt A fest.

Parameter:

Aarray-like oder None

Die Werte, die Farben zugeordnet werden.

Die Basisklasse ScalarMappable trifft keine Annahmen über die Dimensionalität und Form des Werte-Arrays A.

set_clim(self, vmin=None, vmax=None)

Legt die Norm-Grenzen für die Bildskalierung fest.

Parameter:

vmin, vmaxfloat

Die Grenzen.

Für Skalardaten können die Grenzen auch als Tupel (vmin, vmax) als einzelnes positionsgebundenes Argument übergeben werden.

set_cmap(self, cmap)

Legt die Colormap für Luminanzdaten fest.

Parameter:

cmapColormap oder str oder None

set_norm(self, norm)

Legt die Normalisierungsinstanz fest.

Parameter:

normNormalize oder str oder None

Anmerkungen

Wenn es Farbleisten gibt, die die Mappable für diese Norm verwenden, wird durch das Festlegen der Norm der Mappable die Norm, der Locator und die Formatierer auf der Farbleiste auf Standardwerte zurückgesetzt.

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

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

Im normalen Fall ist x eine 1D- oder 2D-Sequenz von Skalaren, und das entsprechende ndarray von RGBA-Werten wird basierend auf der für diesen Colorizer eingestellten Norm und Colormap zurückgegeben.

Es gibt einen Sonderfall zur Behandlung von Bildern, die bereits RGB oder RGBA sind, wie sie z. B. aus einer Bilddatei gelesen wurden. Wenn x ein ndarray mit 3 Dimensionen ist und die letzte Dimension entweder 3 oder 4 ist, wird sie als RGB- oder RGBA-Array behandelt und es wird keine Zuordnung vorgenommen. Das Array kann uint8 sein, oder es kann aus Floats mit Werten im Bereich 0-1 bestehen; andernfalls wird ein ValueError ausgelöst. Alle NaNs oder maskierten Elemente werden auf einen Alpha-Wert von 0 gesetzt. Wenn die letzte Dimension 3 ist, wird das alpha-Schlüsselwortargument (standardmäßig 1) zur Füllung der Transparenz verwendet. Wenn die letzte Dimension 4 ist, wird das alpha-Schlüsselwortargument ignoriert; es ersetzt nicht das vorhandene Alpha. Wenn die dritte Dimension ungleich 3 oder 4 ist, wird ein ValueError ausgelöst.

In beiden Fällen, wenn bytes False (Standard) ist, ist das RGBA-Array ein Float im Bereich 0-1; wenn es True ist, ist das zurückgegebene RGBA-Array uint8 im Bereich 0 bis 255.

Wenn norm False ist, erfolgt keine Normalisierung der Eingabedaten, und es wird angenommen, dass sie im Bereich (0-1) liegen.