mpl_toolkits.axes_grid1.colorbar

Инструментарий для создания цветовой шкалы (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 : the bbox returned from the locator is used as a

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

extend : такое же, как в ColorbarBase orientation : такое же, как в ColorbarBase

get_end_vertices() [source]

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

get_original_position(axes, renderer) [source]

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

get_path_ends() [source]

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

get_path_patch() [source]

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

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

add_lines(CS) [source]

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

update_bruteforce(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().

add_lines(levels, colors, linewidths) [source]

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

set_alpha(alpha) [source]

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

set_label_text(label, **kw) [source]

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

update_artists() [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	булево значение, указывает, следует ли рисовать линии на границах цветов.

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

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

Если 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.