matplotlib.cm

Mapas de cores integrados, utilitários de manipulação de mapas de cores e o ScalarMappablemixin.

Veja também

Referência de mapa de cores para uma lista de mapas de cores integrados.

Criando mapas de cores no Matplotlib para exemplos de como criar mapas de cores.

Escolhendo mapas de cores no Matplotlib uma discussão aprofundada sobre a escolha de mapas de cores.

Normalização de mapa de cores para obter mais detalhes sobre normalização de dados.

classe matplotlib.cm. ColormapRegistry ( cmaps )

Bases:Mapping

Contêiner para mapas de cores que são conhecidos pelo nome do Matplotlib.

Experimental

Embora esperemos que a API seja final, nós a marcamos formalmente como experimental para 3.5 porque queremos manter a opção de ainda adaptar a API para 3.6 caso seja necessário.

A instância do registro universal é matplotlib.colormaps. Não deve haver necessidade de os usuários instanciarem a ColormapRegistrysi mesmos.

O acesso de leitura usa uma interface semelhante a dict mapeando nomes para Colormaps:

import matplotlib as mpl
cmap = mpl.colormaps['viridis']

Os s retornados Colormapsão cópias, para que sua modificação não altere a definição global do mapa de cores.

Mapas de cores adicionais podem ser adicionados via ColormapRegistry.register:

mpl.colormaps.register(my_colormap)

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

Registre um novo mapa de cores.

O nome do mapa de cores pode então ser usado como um argumento de string para qualquer cmap parâmetro no Matplotlib. Também está disponível em pyplot.get_cmap.

O registro do mapa de cores armazena uma cópia do mapa de cores fornecido, para que alterações futuras na instância do mapa de cores original não afetem o mapa de cores registrado. Pense nisso como o registro tirando um instantâneo do mapa de cores no registro.

Parâmetros :

cmap matplotlib.colors.Colormap

O mapa de cores a ser registrado.

nome str, opcional

O nome do mapa de cores. Se não for dado, cmap.nameé usado.

force bool, padrão: False

Se False, um ValueError é levantado se tentar sobrescrever um nome já registrado. True suporta a substituição de mapas de cores registrados diferentes dos mapas de cores integrados.

cancelar registro ( nome )

Remova um mapa de cores do registro.

Você não pode remover mapas de cores integrados.

Se o mapa de cores nomeado não estiver registrado, retorna sem erro, aumenta se você tentar cancelar o registro de um mapa de cores padrão.

Aviso

Os nomes do mapa de cores são atualmente um namespace compartilhado que pode ser usado por vários pacotes. Use unregistersomente se você souber que já registrou esse nome antes. Em particular, não cancele o registro apenas para limpar o nome antes de registrar um novo mapa de cores.

Parâmetros :

nome str

O nome do mapa de cores a ser removido.

Aumentos :

ValueError

Se você tentar remover um mapa de cores integrado padrão.

classe matplotlib.cm. ScalarMappable ( norm = None , cmap = None )

Bases:object

Uma classe mixin para mapear dados escalares para RGBA.

O ScalarMappable aplica a normalização de dados antes de retornar as cores RGBA do mapa de cores fornecido.

Parâmetros :

norma Normalize(ou subclasse dela) ou str ou Nenhum

O objeto de normalização que dimensiona os dados, normalmente no intervalo . Se a , uma subclasse é gerada dinamicamente com base na escala com o nome correspondente. Se None , o padrão da norma é um objeto colors.Normalize que inicializa sua escala com base nos primeiros dados processados.[0, 1]strNormalize

cmap str ouColormap

O mapa de cores usado para mapear valores de dados normalizados para cores RGBA.

escala automática ( )

Escale automaticamente os limites escalares na instância da norma usando a matriz atual

autoscale_None ( )

Escale automaticamente os limites escalares na instância da norma usando a matriz atual, alterando apenas os limites que são Nenhum

propriedade callbacksSM

mudou ( )

Chame isso sempre que o mapeável for alterado para notificar todos os ouvintes de callbackSM sobre o sinal 'alterado'.

barra de cores

A última barra de cores associada a este ScalarMappable. Pode ser Nenhum.

get_alpha ( )

Devoluções :

flutuador

Sempre retorna 1.

get_array ( )

Retorna a matriz de valores, que são mapeados para cores.

A classe base ScalarMappablenão faz nenhuma suposição sobre a dimensionalidade e a forma da matriz.

get_clim ( )

Retorne os valores (min, max) que são mapeados para os limites do mapa de cores.

get_cmap ( )

Retorne a Colormapinstância.

norma de propriedade

set_array ( A )

Defina a matriz de valor de A semelhante a uma matriz .

Parâmetros :

Um array-like ou None

Os valores que são mapeados para cores.

A classe base ScalarMappablenão faz nenhuma suposição sobre a dimensionalidade e a forma da matriz de valores A .

set_clim ( vmin = Nenhum , vmax = Nenhum )

Defina os limites de norma para dimensionamento de imagem.

Parâmetros :

vmin, vmax flutuante

Os limites.

Os limites também podem ser passados ​​como uma tupla ( vmin , vmax ) como um único argumento posicional.

set_cmap ( cmap )

Defina o mapa de cores para dados de luminância.

Parâmetros :

cmap Colormapou str ou Nenhum

set_norm ( norma )

Defina a instância de normalização.

Parâmetros :

norma Normalizeou str ou Nenhum

Notas

Se houver alguma barra de cores usando o mapeável para esta norma, definir a norma do mapeável redefinirá a norma, o localizador e os formatadores na barra de cores para o padrão.

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

Retorne uma matriz rgba normalizada correspondente a x .

No caso normal, x é uma sequência 1D ou 2D de escalares, e o ndarray correspondente de valores rgba será retornado, com base na norma e no mapa de cores definido para este ScalarMappable.

Há um caso especial para lidar com imagens que já são rgb ou rgba, como as que podem ter sido lidas de um arquivo de imagem. Se x for um ndarray com 3 dimensões e a última dimensão for 3 ou 4, ele será tratado como um array rgb ou rgba e nenhum mapeamento será feito. A matriz pode ser uint8 ou ponto flutuante com valores na faixa de 0-1; caso contrário, um ValueError será levantado. Se for um array mascarado, a máscara será ignorada. Se a última dimensão for 3, o alpha kwarg (padrão 1) será usado para preencher a transparência. Se a última dimensão for 4, o alfa kwarg é ignorado; ele não substitui o alfa preexistente. Um ValueError será levantado se a terceira dimensão for diferente de 3 ou 4.

Em ambos os casos, se bytes for False (padrão), a matriz rgba será flutuante no intervalo 0-1; se for True , o array rgba retornado será uint8 no intervalo de 0 a 255.

Se a norma for False, nenhuma normalização dos dados de entrada é executada e assume-se que está no intervalo (0-1).

matplotlib.cm. get_cmap ( nome = Nenhum , lut = Nenhum )

[ Obsoleto ] Obtenha uma instância de mapa de cores, padronizando os valores rc se o nome for Nenhum.

Parâmetros :

nome matplotlib.colors.Colormapou str ou Nenhum, padrão: Nenhum

Se for uma Colormapinstância, ela será retornada. Caso contrário, o nome de um mapa de cores conhecido pelo Matplotlib, que será reamostrado por lut . O padrão, Nenhum, significa rcParams["image.cmap"](padrão: 'viridis').

lut int ou Nenhum, padrão: Nenhum

Se name ainda não for uma instância do Colormap e lut não for None, o mapa de cores será reamostrado para ter entradas lut na tabela de pesquisa.

Devoluções :

Mapa de cores

Notas

Obsoleto desde a versão 3.6: Use matplotlib.colormaps[name]em seu lugar.

matplotlib.cm. register_cmap ( nome = Nenhum , cmap = Nenhum , * , override_builtin = Falso )

[ Descontinuado ] Adicione um mapa de cores ao conjunto reconhecido por get_cmap().

Cadastre um novo mapa de cores para ser acessado pelo nome

LinearSegmentedColormap('swirly', data, lut)
register_cmap(cmap=swirly_cmap)

Parâmetros :

nome str, opcional

O nome que pode ser usado em get_cmap()ou rcParams["image.cmap"](padrão: 'viridis')

Se ausente, o nome será o name atributo do cmap .

cmap matplotlib.colors.Colormap

Apesar de ser o segundo argumento e ter um valor padrão, este é um argumento obrigatório.

bool override_builtin

Permite que os mapas de cores integrados sejam substituídos por um mapa de cores fornecido pelo usuário.

Por favor, não use isso a menos que tenha certeza de que precisa.

Notas

Obsoleto desde a versão 3.6: Use matplotlib.colormaps.register(name)em seu lugar.

matplotlib.cm. cancela o registro_cmap ( nome )

[ Descontinuado ] Remova um mapa de cores reconhecido por get_cmap().

Você não pode remover mapas de cores integrados.

Se o mapa de cores nomeado não estiver registrado, retorna sem erro, aumenta se você tentar cancelar o registro de um mapa de cores padrão.

Aviso

Os nomes do mapa de cores são atualmente um namespace compartilhado que pode ser usado por vários pacotes. Use unregister_cmapsomente se você souber que já registrou esse nome antes. Em particular, não cancele o registro apenas para limpar o nome antes de registrar um novo mapa de cores.

Parâmetros :

nome str

O nome do mapa de cores a ser cancelado

Devoluções :

ColorMap ou Nenhum

Se o mapa de cores foi registrado, retorne-o, caso não retorneNone

Aumentos :

ValueError

Se você tentar cancelar o registro de um mapa de cores integrado padrão.

Notas

Obsoleto desde a versão 3.6: Use matplotlib.colormaps.unregister(name)em seu lugar.