matplotlib.colorbar

Палитры цветов — это визуализация сопоставления скалярных значений с цветами. В Matplotlib они выводятся в отдельной Axes.

ColorbarBase

Базовый класс с полным функционалом отрисовки палитры. Его можно использовать напрямую для создания палитры для заданной цветовой карты; объект mappable (например, изображение) не нужен.

Colorbar

Помимо ColorbarBase это подключает палитру к ScalarMappable, например, к изображению или диаграмме контуров.

make_axes()

Создает Axes, подходящий для палитры. Этот метод можно использовать с фигурами, содержащими одну ось, или с независимо размещёнными осями.

make_axes_gridspec()

Создаёт SubplotBase, подходящий для палитры. Этот метод следует использовать для добавления палитры к GridSpec.

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

Bases: matplotlib.colorbar.ColorbarBase

Этот класс связывает ColorbarBase с ScalarMappable, таким как AxesImage, сгенерированный с помощью imshow.

Примечание

Этот класс не предназначен для прямого создания экземпляров; вместо этого используйте Figure.colorbar или pyplot.colorbar для создания палитры.

add_lines(CS, erase=True)[source]

Добавляет линии из ContourSet без заливки в палитру.

Параметры:	CSContourSet Позиции линий берутся из уровней ContourSet. ContourSet не должен быть заполнен. erasebool, по умолчанию: True Удалять ли ранее добавленные линии.

on_mappable_changed(mappable)[source]

[Устаревший] Обновляет палитру в соответствии с свойствами объекта mappable.

Обычно это автоматически регистрируется как обработчик событий colorbar_factory() и не должен вызываться вручную.

Примечания

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

remove()[source]

Удаляет палитру из фигуры.

Если палитра была создана с помощью use_gridspec=True , предыдущий gridspec восстанавливается.

update_bruteforce(mappable)[source]

[Устаревший] Уничтожает и перестраивает палитру. Это предназначено для устаревания, вероятно, будет устаревшим, а затем удалённым. Не вызывается при создании палитры с помощью функции pyplot.colorbar или метода Figure.colorbar.

Примечания

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

update_normal(mappable)[source]

Обновляет твёрдые области, линии и т. д.

Это должно вызываться, когда изменяется норма изображения или диаграммы контуров, к которым принадлежит эта палитра.

Если норма объекта mappable отличается от предыдущей, это сбрасывает локатор и форматер для оси, поэтому, если они были настроены, их нужно настроить снова. Однако, если норма изменяет только значения vmin, vmax или cmap, то старый форматер и локатор сохранятся.

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

Отобразить полосу цвета в существующей оси.

Существуют лишь редкие случаи, когда вы будете работать непосредственно с ColorbarBase как конечный пользователь. Как правило, полосы цвета используются с ScalarMappable, такими как AxesImage, созданный с помощью imshow. В этих случаях вы будете использовать Colorbar и, скорее всего, создадите его с помощью pyplot.colorbar или Figure.colorbar.

Основное применение явного использования ColorbarBase — рисование полос цвета, которые не связаны с другими элементами на рисунке, например, при отображении цветовой карты без других элементов.

Если аргумент cmap указан, но boundaries и values оставлены как None, то цветовая карта будет отображаться в масштабе 0-1. Чтобы отобразить цвета для значений ниже и выше, укажите norm как:

norm=colors.Normalize(clip=False)

Чтобы отобразить цвета по отношению к индексу вместо масштаба 0-1, используйте:

norm=colors.NoNorm()

Полезными публичными методами являются set_label() и add_lines().

Параметры:

axAxes Экземпляр Axes, на котором отображается полоса цвета. cmapColormap, по умолчанию: rcParams["image.cmap"] (по умолчанию: 'viridis') Цветовая карта для использования. normNormalize alphafloat Прозрачность полосы цвета от 0 (прозрачный) до 1 (непрозрачный). values boundaries orientation{'vertical', 'horizontal'} ticklocation{'auto', 'left', 'right', 'top', 'bottom'} extend{'neither', 'both', 'min', 'max'} spacing{'uniform', 'proportional'} ticksLocator или массив float formatстрока или Formatter drawedgesbool filledbool extendfrac extendrec labelstr

Атрибуты:

axAxes Экземпляр Axes, на котором отображается полоса цвета. linesсписок Список LineCollection (пустой, если не было нарисовано линий). dividersLineCollection LineCollection (пустой, если drawedges равен False).

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

Отрисовать линии на полосе цвета.

Линии добавляются в список lines.

Параметры:	levelsarray-like Позиции линий. colorsцвет или список цветов Один цвет, применяемый ко всем линиям, или значение цвета для каждой линии. linewidthsfloat или array-like Один толщина линии, применяемая ко всем линиям, или толщина линии для каждой линии. erasebool, по умолчанию: True Удалить ранее добавленные линии.

config_axis()[source]

[Устарело]

Примечания

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

draw_all()[source]

Вычислить свободные параметры на основе текущей цветовой карты и нормы, и выполнить всю отрисовку.

get_ticks(minor=False)[source]

Возвращает метки оси x как список положений.

minorticks_off()[source]

Отключить мелкие метки на полосе цвета.

minorticks_on()[source]

Включить мелкие метки на полосе цвета, не выходя за пределы областей «расширения».

n_rasterize = 50

remove()[source]

Удалить эту полосу цвета с рисунка.

set_alpha(alpha)[source]

Установить прозрачность в диапазоне от 0 (прозрачный) до 1 (непрозрачный).

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

Добавить метку к длинной оси цветовой шкалы.

Параметры:

labelstr Текст метки. locstr, необязательно Расположение метки. Для горизонтальной ориентации одно из {'слева', 'по центру', 'справа'} Для вертикальной ориентации одно из {'внизу', 'по центру', 'вверху'} По умолчанию rcParams["xaxis.labellocation"] (по умолчанию: 'center') или rcParams["yaxis.labellocation"] (по умолчанию: 'center') в зависимости от ориентации. **kwargs Ключевые параметры передаются в set_xlabel / set_ylabel. Поддерживаемые ключевые слова: labelpad и свойства Text.

set_ticklabels(ticklabels, update_ticks=True)[source]

Установить метки делений.

Метки делений обновляются немедленно, если update_ticks не False, в противном случае необходимо явно вызвать update_ticks.

set_ticks(ticks, update_ticks=True)[source]

Установить расположение делений.

Параметры:	ticksмассив-подобный объект или Locator или None Позиции делений могут быть заданы массивом значений; или они могут быть определены Locator. Установка в None возвращает к использованию локатора по умолчанию. update_ticksbool, по умолчанию: True Если True, позиции делений обновляются немедленно. Если False, пользователь должен вызвать update_ticks позже для обновления делений.

update_ticks()[source]

Принудительно обновить деления и метки делений. Это необходимо вызывать всякий раз, когда меняется локатор делений и/или форматер меток делений.

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

Базовое классы: matplotlib.colorbar.Colorbar

[Устаревший]

Примечания

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

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

[Устаревший] Создать цветовую шкалу на заданных осях для заданного объекта.

Примечание

Это функция низкого уровня для преобразования существующих осей в оси цветовой шкалы. Обычно вы захотите использовать colorbar вместо нее, которая автоматически обрабатывает создание и размещение подходящих осей.

Параметры:	caxAxes Оси, которые нужно преобразовать в оси цветовой шкалы. mappableScalarMappable Объект, описываемый цветовой шкалой. **kwargs Ключевые параметры передаются соответствующему классу цветовой шкалы.
Возвращает:	Colorbar Созданный экземпляр цветовой шкалы.

Примечания

Устарело начиная с версии 3.4.

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

Создать Axes , подходящий для цветовой шкалы.

Ось помещается в фигуру оси parents, путем изменения размера и перепозиционирования parents.

Параметры:	parentsAxes или список Axes Ось, используемая в качестве родительской для размещения цветовой шкалы. locationNone или {'left', 'right', 'top', 'bottom'} Расположение относительно родительской оси, где создается ось цветовой шкалы. Оно также определяет ориентацию цветовой шкалы (цветовые шкалы слева и справа вертикальные, сверху и снизу — горизонтальные). Если None, расположение будет взято из orientation, если оно задано (вертикальные цветовые шкалы справа, горизонтальные — снизу), или по умолчанию будет 'right', если orientation не задано. orientationNone или {'vertical', 'horizontal'} Ориентация цветовой шкалы. Предпочтительнее задать location цветовой шкалы, так как это также определяет orientation; передача несовместимых значений для location и orientation вызывает исключение. fractionfloat, по умолчанию: 0.15 Доля исходной оси, используемая для цветовой шкалы. shrinkfloat, по умолчанию: 1.0 Доля, на которую умножается размер цветовой шкалы. aspectfloat, по умолчанию: 20 Соотношение длинных и коротких размеров.
Возвращает:	caxAxes Дочерняя ось. kwdict Уменьшенный словарь ключевых слов, передаваемый при создании экземпляра цветовой шкалы.
Другие параметры:	padfloat, по умолчанию: 0.05 если вертикальная, 0.15 если горизонтальная Доля исходной оси между цветовой шкалой и новой осью изображения. anchor(float, float), необязательно Точка привязки оси цветовой шкалы. По умолчанию (0.0, 0.5) если вертикальная; (0.5, 1.0) если горизонтальная. panchor(float, float), или False, необязательно Точка привязки родительской оси цветовой шкалы. Если False, точка привязки родительской оси останется неизменной. По умолчанию (1.0, 0.5) если вертикальная; (0.5, 0.0) если горизонтальная.

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

Создать SubplotBase , подходящий для цветовой шкалы.

Ось помещается в фигуру оси parent, путем изменения размера и перепозиционирования parent.

Эта функция похожа на make_axes. Основные различия:

• make_axes_gridspec следует использовать только с родительской SubplotBase.
• make_axes создаёт Axes; make_axes_gridspec создаёт SubplotBase.
• make_axes обновляет позицию родительской оси. make_axes_gridspec заменяет атрибут grid_spec родительской оси новым.

Хотя эта функция предназначена для совместимости с make_axes, могут быть незначительные различия.

Параметры:	parentAxes Ось, используемая в качестве родительской для размещения цветовой шкалы. locationNone или {'left', 'right', 'top', 'bottom'} Расположение относительно родительской оси, где создается ось цветовой шкалы. Оно также определяет ориентацию цветовой шкалы (цветовые шкалы слева и справа вертикальные, сверху и снизу — горизонтальные). Если None, расположение будет взято из orientation, если оно задано (вертикальные цветовые шкалы справа, горизонтальные — снизу), или по умолчанию будет 'right', если orientation не задано. orientationNone или {'vertical', 'horizontal'} Ориентация цветовой шкалы. Предпочтительнее задать location цветовой шкалы, так как это также определяет orientation; передача несовместимых значений для location и orientation вызывает исключение. fractionfloat, по умолчанию: 0.15 Доля исходной оси, используемая для цветовой шкалы. shrinkfloat, по умолчанию: 1.0 Доля, на которую умножается размер цветовой шкалы. aspectfloat, по умолчанию: 20 Соотношение длинных и коротких размеров.
Возвращает:	caxSubplotBase Дочерняя ось. kwdict Уменьшенный словарь ключевых слов, передаваемый при создании экземпляра цветовой шкалы.
Другие параметры:	padfloat, по умолчанию: 0.05 если вертикальная, 0.15 если горизонтальная Доля исходной оси между цветовой шкалой и новой осью изображения. anchor(float, float), необязательно Точка привязки оси цветовой шкалы. По умолчанию (0.0, 0.5) если вертикальная; (0.5, 1.0) если горизонтальная. panchor(float, float), или False, необязательно Точка привязки родительской оси цветовой шкалы. Если False, точка привязки родительской оси останется неизменной. По умолчанию (1.0, 0.5) если вертикальная; (0.5, 0.0) если горизонтальная.