Barra de colores matplotlib

Las barras de colores son una visualización del mapeo de valores escalares a colores. En Matplotlib se los atrae a un dedicado Axes.

Nota

Las barras de colores se crean normalmente a través de Figure.colorbar o su envoltorio de pyplot pyplot.colorbar, que uso make_axes y Colorbar internamente.

Como usuario final, lo más probable es que no tenga que llamar a los métodos o crear una instancia de las clases en este módulo de forma explícita.

ColorbarBase

La clase base con funcionalidad de dibujo de barra de colores completa. Puede usarse tal cual para hacer una barra de colores para un mapa de colores dado; no se necesita un objeto mapeable (por ejemplo, una imagen).

Colorbar

Encima de ColorbarBase esto conecta la barra de colores con un ScalarMappable como una imagen o un gráfico de contorno.

make_axes()

Crear un Axes adecuado para una barra de colores. Esta función se puede utilizar con figuras que contienen un solo eje o con ejes colocados libremente.

make_axes_gridspec()

Crear un SubplotBase adecuado para una barra de colores. Esta función debe usarse para agregar una barra de color a un GridSpec.

class matplotlib.colorbar.Colorbar(ax, mappable, **kwargs)[source]

Bases: matplotlib.colorbar.ColorbarBase

Esta clase conecta un ColorbarBase a un ScalarMappable como un AxesImage generado a través de imshow.

Nota

Esta clase no está pensada para instanciarse directamente; en su lugar, usa Figure.colorbar o pyplot.colorbar para crear una barra de colores.

add_lines(self, CS, erase=True)[source]

Agregue las líneas de un no relleno ContourSet a la barra de colores.

Parámetros:	CSContourSet Las posiciones de las líneas se toman de los niveles de ContourSet. El ContourSet no debe llenarse. erasebool, default: True Ya sea para eliminar las líneas agregadas anteriormente.

on_mappable_changed(self, mappable)[source]

[Deprecated] Actualice esta barra de colores para que coincida con las propiedades del mapa.

Normalmente, esto se registra automáticamente como un controlador de eventos por colorbar_factory() y no debe llamarse manualmente.

Notas

En desuso desde la versión 3.3.

remove(self)[source]

Elimina esta barra de colores de la figura.

Si la barra de colores se creó con use_gridspec=True se restaura la gridspec anterior.

update_bruteforce(self, mappable)[source]

[Deprecated] Destruye y reconstruye la barra de colores. Esto está destinado a volverse obsoleto, y probablemente se desaprobará y luego se eliminará. No se llama cuando se utilizan la función pyplot.colorbar o el método Figure.colorbar para crear la barra de colores.

Notas

En desuso desde la versión 3.3.

update_normal(self, mappable)[source]

Actualice parches sólidos, líneas, etc.

Esto debe llamarse cuando cambia la norma de la imagen o el gráfico de contorno al que pertenece esta barra de colores.

Si la norma en el mapeable es diferente a la anterior, esto restablece el localizador y el formateador para el eje, por lo que si estos se han personalizado, deberán personalizarse nuevamente. Sin embargo, si la norma solo cambia los valores de vmin, vmax o cmap entonces se conservarán el antiguo formateador y localizador.

class matplotlib.colorbar.ColorbarBase(ax, *, cmap=None, norm=None, alpha=None, values=None, boundaries=None, orientation='vertical', ticklocation='auto', extend=None, spacing='uniform', ticks=None, format=None, drawedges=False, filled=True, extendfrac=None, extendrect=False, label='')[source]

Bases: object

Dibuja una barra de colores en un eje existente.

Solo hay algunos casos raros en los que trabajaría directamente con un ColorbarBase como usuario final. Normalmente, las barras de color se utilizan con ScalarMappables como un AxesImage generado a través de imshow. Para estos casos utilizará Colorbar y probablemente crearlo a través de pyplot.colorbar o Figure.colorbar.

La principal aplicación de usar un ColorbarBase explícitamente está dibujando barras de colores que no están asociadas con otros elementos de la figura, por ejemplo, cuando se muestra un mapa de colores por sí mismo.

Si el cmap se da kwarg pero límites y valores se dejan como Ninguno, entonces el mapa de colores se mostrará en una escala de 0-1. Para mostrar los colores por debajo y por encima del valor, especifique el norma como:

norm=colors.Normalize(clip=False)

Para mostrar los colores frente al índice en lugar de en la escala 0-1, use:

norm=colors.NoNorm()

Los métodos públicos útiles son set_label() y add_lines().

Parámetros:

axAxes los Axes instancia en la que se dibuja la barra de colores. cmapColormap, default: rcParams["image.cmap"] (default: 'viridis') El mapa de colores que se utilizará. normNormalize alphafloat La transparencia de la barra de colores entre 0 (transparente) y 1 (opaco). valores límites orientation'vertical', 'horizontal' ticklocation'auto', 'left', 'right', 'top', 'bottom' extend'neither', 'both', 'min', 'max' spacing'uniform', 'proportional' ticksLocator or array-like of float formatstr or Formatter drawedgesbool filledbool extenderfrac extendrec labelstr

Atributos:

axAxes los Axes instancia en la que se dibuja la barra de colores. lineslist Una lista de LineCollection (vacío si no se trazaron líneas). dividersLineCollection Un LineCollection (vacío si cantos es False).

add_lines(self, levels, colors, linewidths, erase=True)[source]

Dibuja líneas en la barra de colores.

Las líneas se adjuntan a la lista. lines.

Parámetros:	levelsarray-like Las posiciones de las líneas. colorscolor or list of colors Se aplica un solo color a todas las líneas o un valor de color para cada línea. linewidthsfloat or array-like O un solo ancho de línea que se aplica a todas las líneas o un ancho de línea para cada línea. erasebool, default: True Ya sea para eliminar las líneas agregadas anteriormente.

config_axis(self)[source]

[Deprecated]

Notas

En desuso desde la versión 3.3:

draw_all(self)[source]

Calcule los parámetros libres basados ​​en el cmap y la norma actuales, y haga todo el dibujo.

get_ticks(self, minor=False)[source]

Devuelve las marcas x como una lista de ubicaciones.

minorticks_off(self)[source]

Desactive las marcas menores de la barra de colores.

minorticks_on(self)[source]

Active los tics menores de la barra de colores sin extruir en las “regiones extendidas”.

n_rasterize = 50

remove(self)[source]

Elimina esta barra de colores de la figura.

set_alpha(self, alpha)[source]

Establezca la transparencia entre 0 (transparente) y 1 (opaco).

set_label(self, label, *, loc=None, **kwargs)[source]

Agregue una etiqueta al eje largo de la barra de colores.

Parámetros:

labelstr El texto de la etiqueta. locstr, optional La ubicación de la etiqueta. Para orientación horizontal, uno de ‘izquierda’, ‘centro’, ‘derecha’ Para orientación vertical, uno de ‘bottom’, ‘center’, ‘top’ Predeterminado a rcParams["xaxis.labellocation"] (defecto: 'center') o rcParams["yaxis.labellocation"] (defecto: 'center') dependiendo de la orientación. ** kwargs Los argumentos de palabras clave se pasan a set_xlabel / set_ylabel. Las palabras clave admitidas son etiqueta y Text propiedades.

set_ticklabels(self, ticklabels, update_ticks=True)[source]

Establecer etiquetas de marca.

Las etiquetas de marca se actualizan inmediatamente a menos que update_ticks es Falso, en cuyo caso uno debe llamar update_ticks explícitamente.

set_ticks(self, ticks, update_ticks=True)[source]

Establecer ubicaciones de garrapatas.

Parámetros:

ticksarray-like or Locator or None Las posiciones de las marcas se pueden codificar mediante una matriz de valores; o pueden ser definidos por un Locator. Ajuste a Ninguno vuelve a utilizar un localizador predeterminado. update_ticksbool, default: True Si es Verdadero, las ubicaciones de las marcas se actualizan inmediatamente. Si es falso, el usuario debe llamar update_ticks más tarde para actualizar las garrapatas.

update_ticks(self)[source]

Forzar la actualización de los ticks y ticklabels. Esto se debe llamar siempre que cambie el localizador de ticks y / o el formateador de ticks.

class matplotlib.colorbar.ColorbarPatch(**kwargs)[source]

Bases: matplotlib.colorbar.Colorbar

[Deprecated]

Notas

En desuso desde la versión 3.4:

matplotlib.colorbar.colorbar_factory(cax, mappable, **kwargs)[source]

[Deprecated] Cree una barra de colores en los ejes dados para el mapeado dado.

Nota

Esta es una función de bajo nivel para convertir un eje existente en un eje de barra de colores. Por lo general, querrá usar colorbar en su lugar, que también maneja automáticamente la creación y colocación de ejes adecuados.

Parámetros:	caxAxes los Axes para convertirlo en una barra de colores. mappableScalarMappable El mapeable que se describirá mediante la barra de colores. ** kwargs Los argumentos de palabras clave se pasan a la clase de barra de colores correspondiente.
Devoluciones:	Colorbar La instancia de barra de colores creada.

Notas

En desuso desde la versión 3.4.

matplotlib.colorbar.make_axes(parents, location=None, orientation=None, fraction=0.15, shrink=1.0, aspect=20, **kw)[source]

Crear un Axes adecuado para una barra de colores.

Los ejes se colocan en la figura del padres ejes, cambiando el tamaño y reposicionando padres.

Parámetros:	parentsAxes or list of Axes Los ejes para usar como padres para colocar la barra de colores. locationNone or 'left', 'right', 'top', 'bottom' La ubicación, relativa a los ejes principales, donde se crean los ejes de la barra de colores. También determina la orientación de la barra de colores (las barras de colores de la izquierda y la derecha son verticales, las barras de colores de la parte superior e inferior son horizontales). Si es Ninguno, la ubicación provendrá del orientación si está configurado (barras de colores verticales a la derecha, horizontales en la parte inferior), o por defecto a ‘derecha’ si orientación está desarmado. orientationNone or 'vertical', 'horizontal' La orientación de la barra de colores. Es preferible configurar el localización de la barra de color, ya que eso también determina la orientación; pasando valores incompatibles para localización y orientación plantea una excepción. fractionfloat, default: 0.15 Fracción de los ejes originales que se utilizarán para la barra de colores. shrinkfloat, default: 1.0 Fracción por la que multiplicar el tamaño de la barra de colores. aspectfloat, default: 20 Relación de dimensiones largas a cortas.
Devoluciones:	caxAxes El niño hacha. kwdict El diccionario de palabras clave reducido que se pasará al crear la instancia de la barra de colores.
Otros parámetros:	padfloat, default: 0.05 if vertical, 0.15 if horizontal Fracción de los ejes originales entre la barra de colores y los ejes de la nueva imagen. anchor(float, float), optional El punto de anclaje de los ejes de la barra de colores. El valor predeterminado es (0.0, 0.5) si es vertical; (0.5, 1.0) si es horizontal. panchor(float, float), or False, optional El punto de anclaje de los ejes principales de la barra de colores. Si Falso, el ancla de los ejes principales no se modificará. El valor predeterminado es (1.0, 0.5) si es vertical; (0.5, 0.0) si es horizontal.

matplotlib.colorbar.make_axes_gridspec(parent, *, location=None, orientation=None, fraction=0.15, shrink=1.0, aspect=20, **kw)[source]

Crear un SubplotBase adecuado para una barra de colores.

Los ejes se colocan en la figura del padre ejes, cambiando el tamaño y reposicionando padre.

Esta función es similar a make_axes. Las principales diferencias son

• make_axes_gridspec solo debe usarse con un SubplotBase padre.
• make_axes crea un Axes; make_axes_gridspec crea un SubplotBase.
• make_axes actualiza la posición del padre. make_axes_gridspec reemplaza el grid_spec atributo del padre con uno nuevo.

Si bien esta función está destinada a ser compatible con make_axes, podría haber algunas diferencias menores.

Parámetros:	parentAxes Los ejes que se utilizarán como padre para colocar la barra de colores. locationNone or 'left', 'right', 'top', 'bottom' La ubicación, relativa a los ejes principales, donde se crean los ejes de la barra de colores. También determina la orientación de la barra de colores (las barras de colores de la izquierda y la derecha son verticales, las barras de colores de la parte superior e inferior son horizontales). Si Ninguno, la ubicación provendrá del orientación si está configurado (barras de colores verticales a la derecha, horizontales en la parte inferior), o por defecto a ‘derecha’ si orientación está desarmado. orientationNone or 'vertical', 'horizontal' La orientación de la barra de colores. Es preferible configurar el localización de la barra de color, ya que eso también determina la orientación; pasando valores incompatibles para localización y orientación plantea una excepción. fractionfloat, default: 0.15 Fracción de los ejes originales que se utilizarán para la barra de colores. shrinkfloat, default: 1.0 Fracción por la que multiplicar el tamaño de la barra de colores. aspectfloat, default: 20 Relación de dimensiones largas a cortas.
Devoluciones:	caxSubplotBase El niño hacha. kwdict El diccionario de palabras clave reducido que se pasará al crear la instancia de la barra de colores.
Otros parámetros:	padfloat, default: 0.05 if vertical, 0.15 if horizontal Fracción de los ejes originales entre la barra de colores y los ejes de la nueva imagen. anchor(float, float), optional El punto de anclaje de los ejes de la barra de colores. El valor predeterminado es (0.0, 0.5) si es vertical; (0.5, 1.0) si es horizontal. panchor(float, float), or False, optional El punto de anclaje de los ejes principales de la barra de colores. Si Falso, el ancla de los ejes principales no se modificará. El valor predeterminado es (1.0, 0.5) si es vertical; (0.5, 0.0) si es horizontal.