matplotlib.colorbar

Colorbars são uma visualização do mapeamento de valores escalares para cores. No Matplotlib, eles são desenhados em um arquivo Axes.

Observação

Barras de cores são normalmente criadas por meio de Figure.colorbarou seu wrapper pyplot pyplot.colorbar, que usa internamente Colorbarjunto com make_axes_gridspec(para GridSpeceixos posicionados) ou make_axes(para GridSpeceixos não posicionados).

Os usuários finais provavelmente não precisarão usar diretamente a API deste módulo.

classe matplotlib.colorbar. Colorbar ( ax , mappable=None , * , cmap=None , norm=None , alpha=None , values=None , limites=None , orientação='vertical' , ticklocation='auto' , extend=None , spacing='uniforme ' , ticks=None , format=None , drawedges=False , fill =< parâmetro obsoleto> , extendfrac=None , extendrect=False , label='')

Bases:object

Desenhe uma barra de cores em um eixo existente.

Normalmente, as barras de cores são criadas usando Figure.colorbarou pyplot.colorbare associadas a ScalarMappables (como um AxesImagegerado via imshow).

Para desenhar uma barra de cores não associada a outros elementos na figura, por exemplo, ao mostrar um mapa de cores por si só, pode-se criar um vazio ScalarMappable, ou passar diretamente cmap e norm em vez de mapeável para Colorbar.

Métodos públicos úteis são set_label()e add_lines().

Parâmetros :

machadoAxes

A Axesinstância na qual a barra de cores é desenhada.

mapeávelScalarMappable

O mapeável cujo mapa de cores e norma serão usados.

Para mostrar as cores sub e supervalorizadas, a norma mapeável deve ser especificada como

norm = colors.Normalize(clip=False)

Para mostrar as cores versus o índice em vez de uma escala de 0 a 1, use:

norm=colors.NoNorm()

cmap Colormap, padrão: rcParams["image.cmap"](padrão: 'viridis')

O mapa de cores a ser usado. Este parâmetro é ignorado, a menos que mappable seja None.

normaNormalize

A normalização a ser usada. Este parâmetro é ignorado, a menos que mappable seja None.

flutuador alfa

A transparência da barra de cores entre 0 (transparente) e 1 (opaco).

orientação {'vertical', 'horizontal'}

ticklocation {'auto', 'esquerda', 'direita', 'superior', 'inferior'}

drawedges bool

bool preenchido

estender {'nem', 'ambos', 'min', 'max'}

Faça extremidade(s) pontiaguda(s) para valores fora da faixa (a menos que 'nenhuma'). Eles são definidos para um determinado mapa de cores usando os métodos set_under e set_over do mapa de cores.

extendfrac { Nenhum , 'auto', comprimento, comprimentos}

Se definido como Nenhum , as extensões mínima e máxima da barra de cores triangular terão um comprimento de 5% do comprimento da barra de cores interna (essa é a configuração padrão).

Se definido como 'auto', faz com que as extensões da barra de cores triangular tenham os mesmos comprimentos das caixas internas (quando o espaçamento é definido como 'uniforme') ou os mesmos comprimentos das respectivas caixas internas adjacentes (quando o espaçamento é definido como 'proporcional').

Se for escalar, indica o comprimento mínimo e máximo das extensões triangulares da barra de cores como uma fração do comprimento interno da barra de cores. Uma sequência de frações de dois elementos também pode ser fornecida, indicando os comprimentos mínimo e máximo das extensões da barra de cores, respectivamente, como uma fração do comprimento da barra de cores interior.

extendrect bool

Se False , as extensões mínima e máxima da barra de cores serão triangulares (o padrão). Se True , as extensões serão retangulares.

espaçamento {'uniforme', 'proporcional'}

Para barras de cores discretas ( BoundaryNormou contornos), 'uniforme' dá a cada cor o mesmo espaço; 'proporcional' torna o espaço proporcional ao intervalo de dados.

carrapatos Nenhum ou lista de carrapatos ou Localizador

Se Nenhum, os ticks são determinados automaticamente a partir da entrada.

format Nenhum ou str ou Formatador

Se Nenhum, ScalarFormatteré usado. Strings de formato, por exemplo, "%4.2e"ou "{x:.2e}", são suportadas. Uma alternativa Formatterpode ser dada em seu lugar.

drawedges bool

Se deseja desenhar linhas nos limites de cores.

rótulo str

O rótulo no eixo longo da barra de cores.

limites, valores Nenhum ou uma sequência

Se não for definido, o mapa de cores será exibido em uma escala de 0-1. Se forem sequências, os valores devem ter um comprimento 1 menor que os limites . Para cada região delimitada por entradas adjacentes nos limites , será utilizada a cor mapeada para o valor correspondente em values. Normalmente útil apenas para cores indexadas (ou seja, norm=NoNorm()) ou outras circunstâncias incomuns.

Atributos :

machadoAxes

A Axesinstância na qual a barra de cores é desenhada.

lista de linhas

Uma lista de LineCollection(vazia se nenhuma linha foi desenhada).

divisoresLineCollection

Uma LineCollection (vazia se drawedges for False).

add_lines ( * args , ** kwargs )

Desenhe linhas na barra de cores.

As linhas são anexadas à lista lines.

Parâmetros :

níveis semelhantes a matriz

As posições das linhas.

cores cor ou lista de cores

Uma única cor aplicada a todas as linhas ou um valor de cor para cada linha.

larguras de linha float ou array-like

Uma única largura de linha aplicada a todas as linhas ou uma largura de linha para cada linha.

apagar bool, padrão: True

Se todas as linhas adicionadas anteriormente devem ser removidas.

Notas

Como alternativa, esse método também pode ser chamado com a assinatura , caso em que níveis , cores e larguras de linha são obtidos de contorno_conjunto .colorbar.add_lines(contour_set, erase=True)

drag_pan ( botão , chave , x , y )

draw_all ( )

[ Obsoleto ] Calcule quaisquer parâmetros livres com base no cmap e na norma atuais e faça todo o desenho.

Notas

Obsoleto desde a versão 3.6: Em vez disso, use fig.draw_without_rendering().

propriedade preenchida

formatador de propriedade

Rótulo de escala principal Formatterpara a barra de cores.

get_ticks ( menor = Falso )

Retorne os ticks como uma lista de locais.

Parâmetros :

booleano menor , padrão: Falso

se True retornar os ticks menores.

localizador de propriedade

Carrapato principal Locatorpara a barra de cores.

propriedade minorformatter

Carrapato menor Formatterpara a barra de cores.

propriedade minorlocator

Carrapato menor Locatorpara a barra de cores.

minorticks_off ( )

Desative as marcações secundárias da barra de cores.

minorticks_on ( )

Ative os carrapatos secundários da barra de cores.

n_rasterize = 50

patch de propriedade

remover ( )

Remova esta barra de cores da figura.

Se a barra de cores foi criada com use_gridspec=Trueo gridspec anterior é restaurado.

set_alpha ( alpha )

Defina a transparência entre 0 (transparente) e 1 (opaco).

Se uma matriz for fornecida, alfa será definido como Nenhum para usar os valores de transparência associados ao mapa de cores.

set_label ( label , * , loc = None , ** kwargs )

Adicione um rótulo ao longo eixo da barra de cores.

Parâmetros :

rótulo str

O texto do rótulo.

loc str, opcional

A localização da etiqueta.

• Para orientação horizontal, um dos {'esquerda', 'centro', 'direita'}

• Para orientação vertical, um dos {'bottom', 'center', 'top'}

O padrão é rcParams["xaxis.labellocation"](padrão: 'center') ou rcParams["yaxis.labellocation"](padrão: 'center') dependendo da orientação.

** kwargs

Os argumentos de palavras-chave são passados ​​para set_xlabel/ set_ylabel. As palavras-chave suportadas são labelpad e Textproperties.

set_ticklabels ( ticklabels , update_ticks=< parâmetro obsoleto> , * , minor=False , **kwargs )

[ Desanimado ] Definir rótulos de escala.

Desanimado

O uso desse método é desencorajado, devido à dependência das posições dos ticks. Na maioria dos casos, você vai querer usar em seu lugar.set_ticks(positions, labels=labels)

Se estiver usando este método, você deve sempre corrigir as posições dos marcadores antes, por exemplo, usando Colorbar.set_ticksou definindo explicitamente um FixedLocatorno eixo longo da barra de cores. Caso contrário, os ticks podem se mover livremente e os rótulos podem ficar em posições inesperadas.

Parâmetros :

sequência de ticklabels de str ou deText

Textos para rotular cada local de marcação na sequência definida por Colorbar.set_ticks; o número de rótulos deve corresponder ao número de locais.

update_ticks bool, padrão: True

Este argumento de palavra-chave é ignorado e será removido. Descontinuada

bool menor

Se for True, defina marcas secundárias em vez de marcas principais.

** kwargs

Textpropriedades para os rótulos.

set_ticks ( ticks , update_ticks=< parâmetro obsoleto> , labels=None , * , minor=False , **kwargs )

Defina os locais dos ticks.

Parâmetros :

lista de carrapatos de carros alegóricos

Lista de locais de marcação.

lista de rótulos de str, opcional

Lista de rótulos de escala. Se não for definido, os rótulos mostrarão o valor dos dados.

bool menor , padrão: False

Se False, defina os ticks principais; se True, o menor marca.

** kwargs

Textpropriedades para os rótulos. Eles terão efeito somente se você passar rótulos . Em outros casos, use tick_params.

update_normal ( mapeável )

Atualize patches sólidos, linhas, etc.

Isso deve ser chamado quando a norma da imagem ou plotagem de contorno à qual esta barra de cores pertence muda.

Se a norma no mapeável for diferente da anterior, isso zera o localizador e o formatador do eixo, portanto, se eles foram personalizados, eles precisarão ser personalizados novamente. No entanto, se a norma alterar apenas os valores de vmin , vmax ou cmap , o formatador e o localizador antigos serão preservados.

update_ticks ( )

Configure os ticks e os ticklabels. Isso não deve ser necessário para os usuários.

matplotlib.colorbar. ColorbarBase

pseudônimo deColorbar

matplotlib.colorbar. make_axes ( pais , localização = Nenhum , orientação = Nenhum , fração = 0,15 , redução = 1,0 , aspecto = 20 , ** kwargs )

Crie um Axesadequado para uma barra de cores.

Os eixos são colocados na figura dos eixos pais , redimensionando e reposicionando os pais .

Parâmetros :

pais Axesou lista deAxes

Os eixos a serem usados ​​como pais para colocar a barra de cores.

localização Nenhuma ou {'esquerda', 'direita', 'superior', 'inferior'}

O local, relativo aos eixos pais, onde os eixos da barra de cores são criados. Ele também determina a orientação da barra de cores (as barras de cores à esquerda e à direita são verticais, as barras de cores na parte superior e inferior são horizontais). Se Nenhum, o local virá da orientação se estiver definida (barras de cores verticais à direita, horizontais na parte inferior) ou padrão para 'direita' se a orientação não estiver definida.

orientação Nenhuma ou {'vertical', 'horizontal'}

A orientação da barra de cores. É preferível definir a localização da barra de cores, pois isso também determina a orientação ; passar valores incompatíveis para localização e orientação gera uma exceção.

flutuação da fração , padrão: 0,15

Fração dos eixos originais a serem usados ​​para a barra de cores.

encolher flutuante, padrão: 1.0

Fração pela qual multiplicar o tamanho da barra de cores.

flutuação de aspecto , padrão: 20

Relação entre dimensões longas e curtas.

pad float, padrão: 0,05 se vertical, 0,15 se horizontal

Fração dos eixos originais entre a barra de cores e os novos eixos da imagem.

âncora (flutuar, flutuar), opcional

O ponto de ancoragem dos eixos da barra de cores. O padrão é (0,0, 0,5) se vertical; (0,5, 1,0) se horizontal.

panchor (float, float) ou False , opcional

O ponto de ancoragem dos eixos pais da barra de cores. Se False , a âncora dos eixos pais permanecerá inalterada. O padrão é (1,0, 0,5) se vertical; (0,5, 0,0) se horizontal.

Devoluções :

caixaAxes

A criança macha.

ditado kwarg

O dicionário de palavras-chave reduzido a ser passado ao criar a instância da barra de cores.

matplotlib.colorbar. make_axes_gridspec ( pai , * , localização = Nenhum , orientação = Nenhum , fração = 0,15 , redução = 1,0 , aspecto = 20 , ** kwargs )

Crie um SubplotBaseadequado para uma barra de cores.

Os eixos são colocados na figura dos eixos pais , redimensionando e reposicionando os pais .

Esta função é semelhante a make_axes. As diferenças primárias são

• make_axes_gridspecsó deve ser usado com um SubplotBasedos pais.

• make_axescria um Axes; make_axes_gridspeccria um SubplotBase.

• make_axesatualiza a posição do pai. make_axes_gridspec substitui o grid_specatributo do pai por um novo.

Embora esta função seja compatível com make_axes, pode haver algumas pequenas diferenças.

Parâmetros :

paiAxes

Os eixos a serem usados ​​como pai para colocar a barra de cores.

localização Nenhuma ou {'esquerda', 'direita', 'superior', 'inferior'}

O local, relativo aos eixos pais, onde os eixos da barra de cores são criados. Ele também determina a orientação da barra de cores (as barras de cores à esquerda e à direita são verticais, as barras de cores na parte superior e inferior são horizontais). Se Nenhum, o local virá da orientação se estiver definida (barras de cores verticais à direita, horizontais na parte inferior) ou padrão para 'direita' se a orientação não estiver definida.

orientação Nenhuma ou {'vertical', 'horizontal'}

A orientação da barra de cores. É preferível definir a localização da barra de cores, pois isso também determina a orientação ; passar valores incompatíveis para localização e orientação gera uma exceção.

flutuação da fração , padrão: 0,15

Fração dos eixos originais a serem usados ​​para a barra de cores.

encolher flutuante, padrão: 1.0

Fração pela qual multiplicar o tamanho da barra de cores.

flutuação de aspecto , padrão: 20

Relação entre dimensões longas e curtas.

pad float, padrão: 0,05 se vertical, 0,15 se horizontal

Fração dos eixos originais entre a barra de cores e os novos eixos da imagem.

âncora (flutuar, flutuar), opcional

O ponto de ancoragem dos eixos da barra de cores. O padrão é (0,0, 0,5) se vertical; (0,5, 1,0) se horizontal.

panchor (float, float) ou False , opcional

O ponto de ancoragem dos eixos pais da barra de cores. Se False , a âncora dos eixos pais permanecerá inalterada. O padrão é (1,0, 0,5) se vertical; (0,5, 0,0) se horizontal.

Devoluções :

caixaSubplotBase

A criança macha.

ditado kwarg

O dicionário de palavras-chave reduzido a ser passado ao criar a instância da barra de cores.