cmocean Paket

Unterpakete

cmocean.cmocean Modul

cmocean.plots Modul

Diagramme mit Farbpaletten.

Erstellt ein Diagramm von Farbpaletten und Beschriftungen, ähnlich wie in der Matplotlib-Galerie.

Parametersaveplot=False – Ob das Diagramm gespeichert werden soll oder nicht.
cmocean.plots.plot_lightness(saveplot=False)

Zeigt die Helligkeit von Farbpaletten zusammen an.

cmocean.plots.quick_plot(cmap, fname=None, fig=None, ax=None, N=10)

Zeigt eine schnelle Testgrafik einer Farbpalette.

cmocean.plots.test(cmap, fig=None, ax=None)

Testet eine Farbpalette durch Zeichnen.

Parametercmap – Eine Farbpaletten-Instanz. Verwenden Sie eine benannte mit cm.get_cmap(colormap)
cmocean.plots.wrap_viscm(cmap, dpi=100, saveplot=False)

Bewertet die Güte einer Farbpalette anhand perzeptueller Differenzen.

Parameter
  • cmap – Farbpaletten-Instanz.
  • dpi=100 – dpi für das gespeicherte Bild.
  • saveplot=False – Ob das Diagramm gespeichert werden soll oder nicht.

cmocean.tools Modul

Zeichnet Dinge mit Farbpaletten.

cmocean.tools.cmap(rgbin, N=256)

Gibt eine Farbpalette aus einem Array von RGB-Werten aus.

Parameter
  • rgbin – Ein [mx3]-Array, wobei m die Anzahl der eingegebenen Farb-Tripel ist, zwischen denen interpoliert wird, um die zurückgegebene Farbpalette zu erstellen. Hex-Werte können stattdessen als [mx1] in einfachen Anführungszeichen mit einem # eingegeben werden.
  • N=10 – Die Anzahl der zu interpolierenden Stufen.
cmocean.tools.crop(cmapin, vmin, vmax, pivot, N=None, dmax=None)

Schneidet das oder die Enden einer divergierenden Farbpalette anhand von vmin/vmax-Werten ab.

Parameter
  • cmap – Ein Farbpaletten-Objekt, wie z. B. cmocean.cm.matter.
  • vmin/vmax – vmin/vmax für die Verwendung in Diagrammen mit Farbpaletten.
  • pivot – Mittelpunkt für die Verwendung in Diagrammen mit divergierenden Farbpaletten.
  • N=None – Der Benutzer kann die Anzahl der Zeilen für die ausgegebene Farbpalette angeben. Wenn nicht angegeben, wird N aus der eingehenden Farbpalette verwendet und die Werte werden bei Bedarf interpoliert, um Zeilen aufzufüllen.
  • dmax=None – dmax ist die höchste Zahl, die in einem Diagramm mit der Farbpalette enthalten sein soll; Werte mit größerem Betrag als dmax werden von beiden Enden der Farbpalette entfernt. Er sollte kleiner sein als abs(vmin) und abs(vmax), die für die Verwendung dieses Parameters gleich sein sollten.

Gibt das resultierende Farbpaletten-Objekt aus.

Diese Funktion kann für sequentielle und andere nicht-divergierende Farbpaletten verwendet werden
aber es ist einfacher, sie über crop_by_percent() zu verwenden.
Dies sollte nützlich sein für die Darstellung von Bathymetrie- und Topographiedaten mit der
Topo-Farbpalette, wenn der maximale Bathymetrie-Wert vom maximalen Topographiewert abweicht.
Beispielverwendung

# Beispiel für crop am unteren Ende einer divergierenden Farbpalette vmin = -2; vmax = 5; pivot = 0 newcmap = crop(cmocean.cm.curl, vmin, vmax, pivot) A = np.random.randint(vmin, vmax, (5,5)) plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap) plt.colorbar()

# Beispiel für crop am oberen Ende einer divergierenden Farbpalette vmin = -10; vmax = 8; pivot = 0 newcmap = crop(cmocean.cm.delta, vmin, vmax, pivot) A = np.random.randint(vmin, vmax, (5,5)) plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap) plt.colorbar()

cmocean.tools.crop_by_percent(cmap, per, which='both', N=None)

Schneidet das oder die Enden einer Farbpalette um einen bestimmten Prozentsatz ab.

Parameter
  • cmap – Ein Farbpaletten-Objekt, wie z. B. cmocean.cm.matter.
  • per – Prozentsatz der zu entfernenden Farbpalette. Wenn which==’both’, wird dieser Prozentsatz von beiden Enden der Farbpalette entfernt. Wenn which==’min’ oder which==’max’, wird der Prozentsatz nur vom angegebenen Ende der Farbpalette entfernt.
  • which='both' – welches Ende oder welche Enden der Farbpalette abgeschnitten werden sollen. which=’both’ schneidet von beiden Enden ab, which=’min’ vom unteren Ende und which=’max’ vom oberen Ende.
  • N=None – Der Benutzer kann die Anzahl der Zeilen für die ausgegebene Farbpalette angeben. Wenn nicht angegeben, wird N aus der eingehenden Farbpalette verwendet und die Werte werden bei Bedarf interpoliert, um Zeilen aufzufüllen.

Gibt das resultierende Farbpaletten-Objekt aus.

Dies ist ein Wrapper um crop(), um die Verwendung für das Zuschneiden zu erleichtern
basierend auf Prozent.
Beispiele

# Beispiel mit Oxy-Karte: oberen 20% des gelben Teils abschneiden # Vergleich mit voller Farbpalette vmin = 0; vmax = 10; pivot = 5 A = np.random.randint(vmin, vmax, (5,5)) fig, axes = plt.subplots(1, 2) mappable = axes[0].pcolormesh(A, vmin=vmin, vmax=vmax, cmap=cmocean.cm.oxy) fig.colorbar(mappable, ax=axes[0]) vmin = 0; vmax = 8; pivot = 5 newcmap = crop_by_percent(cmocean.cm.oxy, 20, which=’max’, N=None) plt.figure() plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap) plt.colorbar()

# Beispiel mit Oxy-Karte: roten Teil, der die unteren 20% ausmacht, abschneiden # Vergleich mit voller Farbpalette vmin = 0; vmax = 10; pivot = 5 A = np.random.randint(vmin, vmax, (5,5)) fig, axes = plt.subplots(1, 2) mappable = axes[0].pcolormesh(A, vmin=vmin, vmax=vmax, cmap=cmocean.cm.oxy) fig.colorbar(mappable, ax=axes[0]) vmin = 2; vmax = 10; pivot = 5 A = np.random.randint(vmin, vmax, (5,5)) newcmap = crop_by_percent(cmocean.cm.oxy, 20, which=’min’, N=None) plt.figure() plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap) plt.colorbar()

# Beide dunklen Enden der Farbpalette abschneiden, um den Bereich zu reduzieren newcmap = crop_by_percent(cmocean.cm.balance, 10, which=’both’, N=None) plt.figure() A = np.random.randint(-5, 5, (5,5)) plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap) plt.colorbar()

cmocean.tools.get_dict(cmap, N=256)

Konvertiert RGB in ein Wörterbuch, das LinearSegmentedColormap erwartet. Code von https://mycarta.wordpress.com/2014/04/25/convert-color-palettes-to-python-matplotlib-colormaps/ und http://nbviewer.ipython.org/github/kwinkunks/notebooks/blob/master/Matteo_colourmaps.ipynb

cmocean.tools.lighten(cmapin, alpha)

Hellt eine Farbpalette auf, indem Alpha < 1 hinzugefügt wird.

Parameter
  • cmap – Ein Farbpaletten-Objekt, wie z. B. cmocean.cm.matter.
  • alpha – Ein Alpha- oder Transparenzwert, der der Farbpalette zugewiesen wird. Alpha von 1 ist opak und von 1 ist vollständig transparent.

Gibt das resultierende Farbpaletten-Objekt aus.

Dadurch wird das Erscheinungsbild eines Diagramms, das Sie mit der ausgegebenen
Farbpaletten-Objekt erstellen, aufgehellt. Es ist auch möglich, viele Diagramme direkt in der Zeichenfunktion aufzuhellen (z.B. pcolormesh oder contourf).
cmocean.tools.print_colormaps(cmaps, N=256, returnrgb=True, savefiles=False)

Druckt Farbpaletten in 256 RGB-Farben in Textdateien.

Parameterreturnrgb=False – Ob das RGB-Array zurückgegeben werden soll oder nicht. Nur sinnvoll, wenn das RGB einer einzigen Farbpalette ausgegeben wird.

Modulinhalt

cmocean ist ein Paket, das dazu dient, Farbpaletten für häufig geplottete ozeanographische Eigenschaften zu standardisieren.

Siehe README.md für eine Übersicht und Anweisungen.