matplotlib.colorbar

Инструментарий для создания цветовых баров с двумя классами и функцией:

ColorbarBase

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

Colorbar

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

make_axes()

функция для изменения размера области и добавления второй области, подходящей для цветовой шкалы

Метод colorbar() использует make_axes() и Colorbar; функция colorbar() является тонким оболочкой над colorbar().

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

Наследует от: matplotlib.colorbar.ColorbarBase

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

Не предназначен для непосредственного создания экземпляров; вместо этого используйте colorbar() или colorbar() для создания цветовой шкалы.

add_lines(self, CS, erase=True) [source]

Добавляет линии из не заполненного ContourSet в цветовую шкалу.

Установите erase в False, если эти линии должны быть добавлены к любым существующим линиям.

on_mappable_changed(self, mappable) [source]

Обновляет цветовую шкалу для соответствия свойствам объекта mappable.

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

remove(self) [source]

Удаляет эту цветовую шкалу из графика. Если цветовая шкала была создана с помощью use_gridspec=True, восстановите значение gridspec к его предыдущему значению.

update_bruteforce(self, mappable) [source]

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

update_normal(self, mappable) [source]

Обновить сплошные области, линии и т. д.

В отличие от update_bruteforce, это не очищает область. Это предназначено для вызова, когда изменяется норма изображения или контурного графика, к которому принадлежит эта цветовая шкала.

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

class matplotlib.colorbar.ColorbarBase(ax, cmap=None, norm=None, alpha=None, values=None, boundaries=None, orientation='vertical', ticklocation='auto', extend='neither', spacing='uniform', ticks=None, format=None, drawedges=False, filled=True, extendfrac=None, extendrect=False, label='') [source]

Bases: matplotlib.colorbar._ColorbarMappableDummy

Отобразить цветковую шкалу в существующих осях.

В редких случаях пользователь будет работать непосредственно с 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 or None Используемая цветовая карта. Если None, используется rcParams["image.cmap"] (по умолчанию: 'viridis'). normNormalize alphafloat values boundaries orientation{'vertical', 'horizontal'} ticklocation{'auto', 'left', 'right', 'top', 'bottom'} extend{'neither', 'both', 'min', 'max'} spacing{'uniform', 'proportional'} ticksLocator or array-like of float formatstr or Formatter drawedgesbool filledbool extendfrac extendrec labelstr

Атрибуты:

axAxes Экземпляр Axes, в котором отображается цветковая шкала. lineslist Список LineCollection, если линии были нарисованы, в противном случае пустой список. dividersLineCollection LineCollection, если drawedges — True, иначе — None.

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

Отрисовка линий на цветковой шкале.

colors и linewidths должны быть скалярами или последовательностями такой же длины, что и levels.

Установите erase в False, чтобы добавить линии без предварительного удаления ранее добавленных линий.

config_axis(self) [source]

draw_all(self) [source]

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

get_ticks(self, minor=False) [source]

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

minorticks_off(self) [source]

Отключает малые метки на цветковой шкале.

minorticks_on(self) [source]

Включает малые метки на цветковой шкале без вывода в области "расширения".

n_rasterize = 50

remove(self) [source]

Удаляет эту цветковую шкалу с рисунка

set_alpha(self, alpha) [source]

set_label(self, label, **kw) [source]

Подписывает длинную ось цветковой шкалы.

set_ticklabels(self, ticklabels, update_ticks=True) [source]

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

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

set_ticks(self, ticks, update_ticks=True) [source]

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

Параметры:	ticks{None, sequence, Locator instance} Если None, используется локатор по умолчанию. update_ticks{True, False}, optional Если True, расположение делений обновляется немедленно. Если False, используйте update_ticks() для ручного обновления делений.

update_ticks(self) [source]

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

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

Bases: matplotlib.colorbar.Colorbar

Цветковая шкала, созданная с помощью Patch, а не по умолчанию pcolor().

Она использует список экземпляров Patch вместо PatchCollection, так как последний не позволяет изменять узор штриховки среди элементов коллекции.

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

Создаёт цветковую шкалу на заданных осях для заданного объекта отображения.

Обычно для автоматического размещения цветковой шкалы только для объекта отображения используйте colorbar().

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

Изменение размера и расположения родительских осей и возвращение дочерних осей, подходящих для цветовой шкалы.

Ключевые аргументы могут включать следующие (с значениями по умолчанию):

location[None|'left'|'right'|'top'|'bottom']

Положение, относительно родительских осей, где должны быть созданы оси цветовой шкалы. Если None, значение будет взято из заданного orientation, в противном случае по умолчанию будет 'right'.

orientation[None|'vertical'|'horizontal']

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

Свойство	Описание
orientation	вертикальная или горизонтальная
fraction	0.15; доля исходных осей, используемая для цветовой шкалы
pad	0.05 при вертикальной, 0.15 при горизонтальной; доля исходных осей между цветовой шкалой и новыми осями изображения
shrink	1.0; доля, на которую нужно умножить размер цветовой шкалы
aspect	20; отношение длинной стороны к короткой
anchor	(0.0, 0.5) при вертикальной; (0.5, 1.0) при горизонтальной; точка привязки осей цветовой шкалы
panchor	(1.0, 0.5) при вертикальной; (0.5, 0.0) при горизонтальной; точка привязки родительских осей цветовой шкалы. Если False, точка привязки родительских осей останется без изменений

Возвращает (cax, kw), дочерние оси и уменьшенный словарь kw, который должен быть передан при создании экземпляра цветовой шкалы.

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

Изменение размера и расположения родительских осей и возвращение дочерних осей, подходящих для цветовой шкалы. Эта функция похожа на make_axes. Основные различия:

• make_axes_gridspec обрабатывает только ключевой аргумент orientation и не может обрабатывать ключевой аргумент "location".
• make_axes_gridspec следует использовать только с родительскими осями subplot.

• make_axes создает экземпляр Axes. make_axes_gridspec

  создает экземпляр Subplot.

• make_axes обновляет положение

  родителя. make_axes_gridspec заменяет атрибут grid_spec родителя новым.

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

Ключевые аргументы могут включать следующие (с значениями по умолчанию):

orientation

'вертикальная' или 'горизонтальная'

Свойство	Описание
orientation	вертикальная или горизонтальная
fraction	0.15; доля исходных осей, используемая для цветовой шкалы
pad	0.05 при вертикальной, 0.15 при горизонтальной; доля исходных осей между цветовой шкалой и новыми осями изображения
shrink	1.0; доля, на которую нужно умножить размер цветовой шкалы
aspect	20; отношение длинной стороны к короткой
anchor	(0.0, 0.5) при вертикальной; (0.5, 1.0) при горизонтальной; точка привязки осей цветовой шкалы
panchor	(1.0, 0.5) при вертикальной; (0.5, 0.0) при горизонтальной; точка привязки родительских осей цветовой шкалы. Если False, точка привязки родительских осей останется без изменений

Все, кроме первого из них, удаляются из входного набора kw.

Возвращает (cax, kw), дочерние оси и уменьшенный словарь kw, который должен быть передан при создании экземпляра цветовой шкалы.