mpl_toolkits.axes_grid1.colorbar

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

ColorbarBase

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

Colorbar

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

make_axes()

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

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

class mpl_toolkits.axes_grid1.colorbar.CbarAxesLocator(locator=None, extend='neither', orientation='vertical') [source]

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

locatorthe bbox returned from the locator is used as a

начальное положение осей. Если None, используется axes.bbox.

extend : аналогично ColorbarBase orientation : аналогично ColorbarBase

get_end_vertices(self) [source]

возвращает кортеж из двух вершин для расширенных концов цветовой шкалы. Первая вершина — для минимального конца, а вторая — для максимального.

get_original_position(self, axes, renderer) [source]

получает исходное положение осей.

get_path_ends(self) [source]

получает пути для расширенных концов

get_path_patch(self) [source]

получает путь для области осей

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

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

add_lines(self, CS) [source]

Добавляет линии из не заполненного ContourSet на цветовой бар.

update_bruteforce(self, mappable) [source]

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

class mpl_toolkits.axes_grid1.colorbar.ColorbarBase(ax, cmap=None, norm=None, alpha=1.0, values=None, boundaries=None, orientation='vertical', extend='neither', spacing='uniform', ticks=None, format=None, drawedges=False, filled=True) [source]

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

Это базовый класс для класса Colorbar, который является основой метода colorbar() и функции pyplot.

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

colors.Normalize(clip=False)

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

norm=colors.NoNorm.

Полезные атрибуты:

ax

объект Axes, на котором отображается цветовая шкала

lines

LineCollection, если линии были нарисованы, иначе None

dividers

LineCollection, если drawedges True, иначе None

Полезные общедоступные методы — set_label() и add_lines().

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

add_lines(self, levels, colors, linewidths) [source]

Рисует линии на цветовой шкале. Удаляет существующие линии.

set_alpha(self, alpha) [source]

Устанавливает значение альфа.

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

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

update_artists(self) [source]

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

mpl_toolkits.axes_grid1.colorbar.colorbar(mappable, cax=None, ax=None, **kw) [source]

Создать шкалу цветовых значений для объекта ScalarMappable.

Документация для тонкого обертки pyplot:

Добавить шкалу цветовых значений к графику.

Функции для интерфейса pyplot; все, кроме первой, также являются сигнатурами методов для метода colorbar():

colorbar(**kwargs)
colorbar(mappable, **kwargs)
colorbar(mappable, cax=cax, **kwargs)
colorbar(mappable, ax=ax, **kwargs)

аргументы:

mappable

Image, ContourSet и т. д., к которым применяется шкала цветовых значений; этот аргумент является обязательным для метода colorbar(), но необязательным для функции colorbar(), которая устанавливает значение по умолчанию на текущем изображении.

ключевые аргументы:

cax

None | объект осей, в котором будет отображаться шкала цветовых значений

ax

None | родительский объект осей, из которого будет взято место для новых осей шкалы цветовых значений

Дополнительные ключевые аргументы относятся к двум типам:

свойства осей:

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

свойства шкалы цветовых значений:

Свойство	Описание
extend	[ 'neither' | 'both' | 'min' | 'max' ] Если не 'neither', создаются заострённые концы для значений, выходящих за пределы диапазона. Эти значения устанавливаются для заданной цветовой карты с использованием методов colormap set_under и set_over.
spacing	[ 'uniform' | 'proportional' ] Равномерное распределение отводит каждому дискретному цвету одинаковое пространство; пропорциональное распределение делает пространство пропорциональным интервалу данных.
ticks	[ None | список тиков | объект Locator ] Если None, тики определяются автоматически из входных данных.
format	[ None | строка формата | объект Formatter ] Если None, используется ScalarFormatter. Если задана строка формата, например, '%.3f', она используется. Вместо этого можно указать альтернативный объект Formatter.
drawedges	bool. Рисовать ли линии на границах цветов.

Следующее, вероятно, будет полезно только в контексте индексированных цветов (то есть, когда у mappable есть norm=NoNorm()) или в других необычных ситуациях.

Свойство	Описание
boundaries	None или последовательность
values	None или последовательность, которая должна быть на 1 меньше, чем последовательность boundaries. Для каждого региона, ограниченного смежными элементами в boundaries, будет использоваться цвет, сопоставленный соответствующему значению в значениях.

Если mappable является ContourSet, его ключевой аргумент extend включается автоматически.

Обратите внимание, что ключевой аргумент shrink обеспечивает простой способ предотвращения того, чтобы вертикальная шкала цветовых значений, например, была выше осей объекта mappable, к которому прикреплена шкала цветовых значений; но это ручной метод, требующий некоторых проб и ошибок. Если шкала цветовых значений слишком большая (или горизонтальная шкала цветовых значений слишком широкая), используйте меньшее значение shrink.

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

Известно, что некоторые просмотрщики векторной графики (svg и pdf) отображают белые зазоры между сегментами шкалы цветовых значений. Это связано с ошибками в просмотрщиках, а не в matplotlib. В качестве обходного решения шкала цветовых значений может быть отображена с перекрывающимися сегментами:

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

Однако это имеет негативные последствия в других обстоятельствах. В частности, с полупрозрачными изображениями (alpha < 1) и расширениями шкалы цветовых значений, и по умолчанию это не включено (см. выпуск #1188).

возвращает:

Colorbar экземпляр; см. также его базовый класс ColorbarBase. Вызовите метод set_label(), чтобы добавить метку к шкале цветовых значений.

transData осей cax корректируется таким образом, что пределы в самой длинной оси фактически соответствуют пределам в диапазоне шкалы цветовых значений. С другой стороны, у самой короткой оси есть пределы данных [1,2], чьё необычное значение служит для предотвращения переполнения при использовании логарифмической шкалы.

mpl_toolkits.axes_grid1.colorbar.make_axes(parent, *, fraction=0.15, shrink=1.0, aspect=20, **kw) [source]

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

cax, kw = make_axes(parent, **kw)

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

orientation

'vertical' или 'horizontal'

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

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

Возвращает (cax, kw), дочерние оси и измененный словарь kw.