matplotlib.cm

Встроенные цветовые карты, утилиты обработки цветовых карт и миксин ScalarMappable.

class matplotlib.cm.ScalarMappable(norm=None, cmap=None)[source]

Базы: object

Класс-миксин для сопоставления скалярных данных с RGBA.

ScalarMappable применяет нормализацию данных перед возвращением RGBA-цветов из заданной цветовой карты.

Параметры:	normmatplotlib.colors.Normalize (или подкласс) Объект нормализации, который масштабирует данные, обычно в интервал [0, 1]. Если None, norm по умолчанию является объектом colors.Normalize, который инициализирует свой масштаб на основе первых обработанных данных. cmapстрока или Colormap Цветовая карта, используемая для сопоставления нормализованных значений данных с RGBA-цветами.

add_checker(checker)[source]

[Устарело]

Замечания

Устарело начиная с версии 3.3:

autoscale()[source]

Автоматическое масштабирование пределов скаляров в объекте norm с использованием текущего массива.

autoscale_None()[source]

Автоматическое масштабирование пределов скаляров в объекте norm с использованием текущего массива, изменяя только пределы, которые равны None.

changed()[source]

Вызывайте этот метод всякий раз, когда изменяется mappable, чтобы уведомить все слушатели callbackSM о сигнале 'changed'.

check_update(checker)[source]

[Устарело]

Замечания

Устарело начиная с версии 3.3:

colorbar

Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

get_alpha()[source]

Возвращает:	float Всегда возвращает 1.

get_array()[source]

Возвращает массив данных.

get_clim()[source]

Возвращает значения (min, max), которые сопоставляются с пределами цветовой карты.

get_cmap()[source]

Возвращает экземпляр Colormap.

set_array(A)[source]

Устанавливает массив изображения из массива numpy A.

Параметры:	Andarray или None

set_clim(vmin=None, vmax=None)[source]

Устанавливает пределы нормализации для масштабирования изображения.

Параметры:	vmin, vmaxfloat Пределы. Пределы также могут быть переданы как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_cmap(cmap)[source]

Устанавливает цветовую карту для данных яркости.

Параметры:	cmapColormap или строка или None

set_norm(norm)[source]

Устанавливает экземпляр нормализации.

Параметры:	normNormalize или None

Замечания

Если цветовые шкалы используют mappable для этой нормализации, установка norm mappable сбросит norm, локатор и форматировщики цветовой шкалы на значения по умолчанию.

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

Возвращает массив rgba, соответствующий значению x.

В обычном случае x является одномерным или двумерным массивом чисел, и соответствующий массив значений rgba будет возвращён на основе установленного для этого объекта отображения значений и цветовой карты.

Есть один особый случай, для обработки изображений, которые уже представлены в формате rgb или rgba, например, считанных из файла изображения. Если x является массивом с тремя измерениями, и последнее измерение равно 3 или 4, то он будет обработан как массив rgb или rgba, и никакого отображения не будет произведено. Массив может быть uint8 или плавающей точкой с значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, значение alpha игнорируется; оно не заменяет уже существующее значение альфа. Будет поднято исключение ValueError, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать числа с плавающей точкой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет содержать значения uint8 в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не производится, и предполагается, что они находятся в диапазоне (0-1).

свойство update_dict

matplotlib.cm.get_cmap(name=None, lut=None)[source]

Получение экземпляра цветовой карты, по умолчанию используя значения из rc параметров, если name равно None.

Цветовые карты, добавленные с помощью register_cmap(), имеют приоритет над встроенными цветовыми картами.

Параметры:

namematplotlib.colors.Colormap или str или None, по умолчанию: None Если это экземпляр Colormap, он будет возвращён. В противном случае, имя цветовой карты, известное Matplotlib, которое будет пересчитано с помощью lut. Значение по умолчанию, None, означает rcParams["image.cmap"] (по умолчанию: 'viridis'). lutint или None, по умолчанию: None Если name не является экземпляром Colormap и lut не равно None, цветовая карта будет пересчитана, чтобы иметь lut элементов в таблице поиска.

Примечания

В настоящее время это возвращает глобальный объект цветовой карты, что устарело. В Matplotlib 3.5 вы больше не сможете изменять глобальные цветовые карты на месте.

matplotlib.cm.register_cmap(name=None, cmap=None, *, override_builtin=False)[source]

Добавление цветовой карты в набор, распознаваемый get_cmap().

Регистрация новой цветовой карты для доступа по имени

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

Параметры:

namestr, необязательно Имя, которое может использоваться в get_cmap() или rcParams["image.cmap"] (по умолчанию: 'viridis') Если отсутствует, имя будет name атрибутом cmap. cmapmatplotlib.colors.Colormap Несмотря на то, что это второй аргумент и имеет значение по умолчанию, это обязательный аргумент. override_builtinbool Разрешить переопределение встроенных цветовых карт пользовательской цветовой картой. Пожалуйста, не используйте это, если вы не уверены, что вам это нужно.

Примечания

Регистрация цветовой карты хранит ссылку на объект цветовой карты, который в настоящее время может быть изменён, и это может непреднамеренно изменить состояние глобальной цветовой карты. Это поведение устарело, и в Matplotlib 3.5 зарегистрированная цветовая карта будет неизменяемой.

matplotlib.cm.unregister_cmap(name)[source]

Удаление цветовой карты, распознаваемой get_cmap().

Вы не можете удалить встроенные цветовые карты.

Если зарегистрированная цветовая карта с указанным именем не найдена, возвращается без ошибок; вызов с именем встроенной цветовой карты вызывает исключение.

Предупреждение

Имена цветовых карт в настоящее время представляют собой общий пространство имён, которое может использоваться несколькими пакетами. Используйте unregister_cmap только если вы знаете, что вы зарегистрировали это имя ранее. В частности, не отменяйте регистрацию просто на случай, чтобы очистить имя перед регистрацией новой цветовой карты.

Параметры:	namestr Имя цветовой карты, которая должна быть удалена из списка
Возвращает:	ColorMap или None Если цветовая карта была зарегистрирована, верните её, в противном случае верните None
Исключения:	ValueError Если вы попытаетесь удалить регистрацию встроенной цветовой карты по умолчанию.