`matplotlib.colorbar`#

Las barras de colores son una visualización de la asignación de valores escalares a colores. En Matplotlib, se dibujan en un archivo Axes.

Nota

Las barras de colores generalmente se crean a través Figure.colorbarde su envoltura de pyplot pyplot.colorbar, que se usa internamente Colorbarjunto con make_axes_gridspec(para GridSpecejes posicionados) o make_axes(para GridSpecejes no posicionados).

Lo más probable es que los usuarios finales no necesiten usar directamente la API de este módulo.

clase matplotlib.colorbar. Colorbar ( ax , mapeable=Ninguno , * , cmap=Ninguno , norma=Ninguno , alfa=Ninguno , valores=Ninguno , límites=Ninguno , orientación='vertical' , tickubicación='auto' , extender=Ninguno , espaciado='uniforme ' , ticks=Ninguno , formato=Ninguno , drawedges=False , relleno=< parámetro en desuso> , extendfrac=Ninguno , extendrect=False , label='') [fuente] #

Bases:object

Dibuja una barra de colores en un eje existente.

Por lo general, las barras de colores se crean usando Figure.colorbaro pyplot.colorbary se asocian con ScalarMappables (como un AxesImagegenerado a través de imshow).

Para dibujar una barra de colores no asociada con otros elementos en la figura, por ejemplo, cuando se muestra un mapa de colores por sí mismo, uno puede crear un vacío ScalarMappableo pasar directamente cmap y norm en lugar de mapeable a Colorbar.

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

Parámetros :

hachaAxes

La Axesinstancia en la que se dibuja la barra de colores.

mapeableScalarMappable

El mapeable cuyo mapa de colores y norma se usarán.

Para mostrar los colores de sub y sobre valor, la norma del mapeable debe especificarse como

norm = colors.Normalize(clip=False)

Para mostrar los colores en función del índice en lugar de en una escala de 0 a 1, utilice:

norm=colors.NoNorm()

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

El mapa de colores a utilizar. Este parámetro se ignora, a menos que asignable sea Ninguno.

normaNormalize

La normalización a utilizar. Este parámetro se ignora, a menos que asignable sea Ninguno.

flotador alfa

La transparencia de la barra de colores entre 0 (transparente) y 1 (opaco).

orientación {'vertical', 'horizontal'}

ubicación de la marca {'auto', 'izquierda', 'derecha', 'arriba', 'abajo'}

Bordes dibujados bool

bool lleno

extender {'ninguno', 'ambos', 'min', 'max'}

Haga extremos puntiagudos para valores fuera de rango (a menos que sea 'ninguno'). Estos se configuran para un mapa de colores dado usando los métodos de mapa de colores set_under y set_over.

extendfrac { Ninguno , 'auto', longitud, longitudes}

Si se establece en Ninguno , las extensiones de la barra de colores triangulares mínima y máxima tendrán una longitud del 5 % de la longitud de la barra de colores interior (esta es la configuración predeterminada).

Si se establece en 'auto', hace que las extensiones de la barra de colores triangulares tengan la misma longitud que los cuadros interiores (cuando el espaciado se establece en 'uniforme') o la misma longitud que los respectivos cuadros interiores adyacentes (cuando el espaciado se establece en 'proporcional').

Si es un escalar, indica la longitud de las extensiones de barra de colores triangulares mínima y máxima como una fracción de la longitud de la barra de colores interior. También se puede dar una secuencia de fracciones de dos elementos, indicando las longitudes de las extensiones mínima y máxima de la barra de colores, respectivamente, como una fracción de la longitud de la barra de colores interior.

extender el bool

Si es False , las extensiones mínima y máxima de la barra de colores serán triangulares (el valor predeterminado). Si es Verdadero , las extensiones serán rectangulares.

espaciado {'uniforme', 'proporcional'}

Para barras de colores discretas ( BoundaryNormo contornos), 'uniforme' le da a cada color el mismo espacio; 'proporcional' hace que el espacio sea proporcional al intervalo de datos.

ticks Ninguno o lista de ticks o localizador

Si es Ninguno, los ticks se determinan automáticamente a partir de la entrada.

formato Ninguno o str o Formateador

Si Ninguno, ScalarFormatterse utiliza. Se admiten cadenas de formato, por ejemplo, "%4.2e"o "{x:.2e}". FormatterEn su lugar, se puede dar una alternativa .

Bordes dibujados bool

Ya sea para dibujar líneas en los límites de color.

cadena de etiquetas

La etiqueta en el eje largo de la barra de colores.

límites, valores Ninguno o una secuencia

Si no está configurado, el mapa de colores se mostrará en una escala de 0-1. Si son secuencias, los valores deben tener una longitud 1 menor que los límites . Para cada región delimitada por entradas adyacentes en los límites , se utilizará el color asignado al valor correspondiente en valores. Normalmente solo es útil para colores indexados (es decir, norm=NoNorm()) u otras circunstancias inusuales.

Atributos :

hachaAxes: La Axesinstancia en la que se dibuja la barra de colores.
lista de lineas: Una lista de LineCollection(vacío si no se dibujaron líneas).
divisoresLineCollection: Una LineCollection (vacía si drawedges es False).

add_lines ( * argumentos , ** kwargs ) [fuente] #

Dibuja líneas en la barra de colores.

Las líneas se añaden a la lista lines.

Parámetros :

niveles en forma de matriz: Las posiciones de las líneas.
colores color o lista de colores: Ya sea un solo color que se aplica a todas las líneas o un valor de color para cada línea.
anchos de línea flotantes o tipo matriz: Ya sea un ancho de línea único que se aplica a todas las líneas o un ancho de línea para cada línea.
borrar bool, por defecto: Verdadero: Ya sea para eliminar cualquier línea agregada anteriormente.

notas

Alternativamente, este método también se puede llamar con la firma , en cuyo caso los niveles , colores y anchos de línea se toman de contour_set .colorbar.add_lines(contour_set, erase=True)

drag_pan ( botón , tecla , x , y ) [fuente] #

dibujar_todos ( ) [fuente] #

[ Obsoleto ] Calcule cualquier parámetro libre basado en el cmap y la norma actuales, y haga todo el dibujo.

notas

En desuso desde la versión 3.6: use fig.draw_without_rendering() en su lugar.

propiedad llena [fuente] #

formateador de propiedades #: Etiqueta de marca principal Formatterpara la barra de colores.

get_ticks ( menor = Falso ) [fuente] #

Devuelve las marcas como una lista de ubicaciones.

Parámetros :

booleano menor , predeterminado: falso: si es Verdadero, devuelve los ticks menores.

localizador de propiedades #: Marca principal Locatorpara la barra de colores.

propiedad menor formateador #: Marca menor Formatterpara la barra de colores.

localizador de propiedad menor #: Marca menor Locatorpara la barra de colores.

minorticks_off ( ) [fuente] #: Desactive las marcas menores de la barra de colores.

minorticks_on ( ) [fuente] #: Active las marcas menores de la barra de colores.

n_rasterizar = 50 #

parche de propiedad [fuente] #

eliminar ( ) [fuente] #

Elimina esta barra de colores de la figura.

Si la barra de colores se creó con use_gridspec=Truela especificación de cuadrícula anterior, se restaura.

set_alpha ( alfa ) [fuente] #

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

Si se proporciona una matriz, alfa se establecerá en Ninguno para usar los valores de transparencia asociados con el mapa de colores.

set_label ( etiqueta , * , loc = Ninguno , ** kwargs ) [fuente] #

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

Parámetros :

cadena de etiquetas

El texto de la etiqueta.

calle loc , opcional

La ubicación de la etiqueta.

Para orientación horizontal uno de {'izquierda', 'centro', 'derecha'}
Para orientación vertical uno de {'bottom', 'center', 'top'}

El valor predeterminado es rcParams["xaxis.labellocation"](predeterminado: 'center') o rcParams["yaxis.labellocation"](predeterminado: 'center') según la orientación.

**kwargs

Los argumentos de palabras clave se pasan a set_xlabel/ set_ylabel. Las palabras clave admitidas son labelpad y Textpropiedades.

set_ticklabels ( ticklabels , update_ticks=< parámetro obsoleto> , * , minor=False , **kwargs ) [fuente] #

[ Desaconsejado ] Establecer etiquetas de marca.

Desanimado

Se desaconseja el uso de este método debido a la dependencia de las posiciones de los ticks. En la mayoría de los casos, querrá usar en su lugar.set_ticks(positions, labels=labels)

Si está utilizando este método, siempre debe fijar las posiciones de marca antes, por ejemplo, utilizando Colorbar.set_tickso configurando explícitamente a FixedLocatoren el eje largo de la barra de colores. De lo contrario, las marcas pueden moverse libremente y las etiquetas pueden terminar en posiciones inesperadas.

Parámetros :

ticklabels secuencia de str o deText

Textos para etiquetar cada ubicación de tick en la secuencia establecida por Colorbar.set_ticks; el número de etiquetas debe coincidir con el número de ubicaciones.

update_ticks booleano , predeterminado: Verdadero

Este argumento de palabra clave se ignora y se eliminará. Obsoleto

bool menor: Si es Verdadero, establezca marcas menores en lugar de marcas mayores.

**kwargs

Textpropiedades de las etiquetas.

set_ticks ( ticks , update_ticks=< parámetro obsoleto> , etiquetas=Ninguno , * , menor=Falso , **kwargs ) [fuente] #

Establecer ubicaciones de marca.

Parámetros :

lista de ticks de flotadores: Lista de ubicaciones de garrapatas.
lista de etiquetas de str, opcional: Lista de etiquetas de ticks. Si no se establece, las etiquetas muestran el valor de los datos.
bool menor , predeterminado: falso: Si False, establece los ticks principales; si True, las garrapatas menores.
**kwargs: Textpropiedades de las etiquetas. Estos surten efecto solo si pasa etiquetas . En otros casos, utilice tick_params.

update_normal ( asignable ) [fuente] #

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

Esto está destinado a ser llamado cuando cambia la norma de la imagen o 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 se han personalizado, deberán personalizarse nuevamente. Sin embargo, si la norma solo cambia los valores de vmin , vmax o cmap , se conservarán el formateador y el localizador antiguos.

update_ticks ( ) [fuente] #: Configure los ticks y ticklabels. Esto no debería ser necesario para los usuarios.

matplotlib.colorbar. ColorbarBase [fuente] #: alias deColorbar

matplotlib.colorbar. make_axes ( padres , ubicación = Ninguno , orientación = Ninguno , fracción = 0.15 , reducción = 1.0 , aspecto = 20 , ** kwargs ) [fuente] #

Cree un Axesadecuado para una barra de colores.

Los ejes se colocan en la figura de los ejes padres , redimensionando y reposicionando los padres .

Parámetros :

padres Axeso lista deAxes: Los ejes que se utilizarán como padres para colocar la barra de colores.
ubicación Ninguno o {'izquierda', 'derecha', 'superior', 'inferior'}: 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á de la orientación si está configurada (barras de colores verticales a la derecha, horizontales en la parte inferior), o por defecto a 'derecha' si la orientación no está configurada.
orientación Ninguna o {'vertical', 'horizontal'}: La orientación de la barra de colores. Es preferible establecer la ubicación de la barra de colores, ya que eso también determina la orientación ; pasar valores incompatibles para la ubicación y la orientación genera una excepción.
fracción flotante, por defecto: 0.15: Fracción de ejes originales que se usarán para la barra de colores.
retráctil flotante, por defecto: 1.0: Fracción por la que se multiplica el tamaño de la barra de colores.
flotante de aspecto , predeterminado: 20: Relación de dimensiones largas a cortas.
pad float, predeterminado: 0,05 si es vertical, 0,15 si es horizontal: Fracción de ejes originales entre la barra de colores y los ejes de la nueva imagen.
ancla (flotador, flotador), opcional: 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), o False , opcional: El punto de anclaje de los ejes principales de la barra de colores. Si es False , el ancla de los ejes principales no cambiará. El valor predeterminado es (1,0, 0,5) si es vertical; (0.5, 0.0) si es horizontal.

Devoluciones :

caxAxes: El niño hachas.
dictado de los kwargs: El diccionario de palabras clave reducido que se pasará al crear la instancia de la barra de colores.

matplotlib.colorbar. make_axes_gridspec ( padre , * , ubicación = Ninguno , orientación = Ninguno , fracción = 0.15 , reducción = 1.0 , aspecto = 20 , ** kwargs ) [fuente] #

Cree un SubplotBaseadecuado para una barra de colores.

Los ejes se colocan en la figura de los ejes principales , redimensionando y reposicionando parent .

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

make_axes_gridspecsolo debe usarse con un SubplotBasepadre.
make_axescrea un Axes; make_axes_gridspeccrea un SubplotBase.
make_axesactualiza la posición del padre. make_axes_gridspec reemplaza el grid_specatributo del padre por uno nuevo.

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

Parámetros :

padreAxes: Los ejes que se utilizarán como elementos principales para colocar la barra de colores.
ubicación Ninguno o {'izquierda', 'derecha', 'superior', 'inferior'}: 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á de la orientación si está configurada (barras de colores verticales a la derecha, horizontales en la parte inferior), o por defecto a 'derecha' si la orientación no está configurada.
orientación Ninguna o {'vertical', 'horizontal'}: La orientación de la barra de colores. Es preferible establecer la ubicación de la barra de colores, ya que eso también determina la orientación ; pasar valores incompatibles para la ubicación y la orientación genera una excepción.
fracción flotante, por defecto: 0.15: Fracción de ejes originales que se usarán para la barra de colores.
retráctil flotante, por defecto: 1.0: Fracción por la que se multiplica el tamaño de la barra de colores.
flotante de aspecto , predeterminado: 20: Relación de dimensiones largas a cortas.
pad float, predeterminado: 0,05 si es vertical, 0,15 si es horizontal: Fracción de ejes originales entre la barra de colores y los ejes de la nueva imagen.
ancla (flotador, flotador), opcional: 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), o False , opcional: El punto de anclaje de los ejes principales de la barra de colores. Si es False , el ancla de los ejes principales no cambiará. El valor predeterminado es (1,0, 0,5) si es vertical; (0.5, 0.0) si es horizontal.

Devoluciones :

caxSubplotBase: El niño hachas.
dictado de los kwargs: El diccionario de palabras clave reducido que se pasará al crear la instancia de la barra de colores.

matplotlib.colorbar#

`matplotlib.colorbar`#