mpl_toolkits.axes_grid1.colorbar

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

ColorbarBase

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

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]

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

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() и функции pylab.

Он также полезен сам по себе для отображения цветовой карты. Если аргумент 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]

устанавливает значение alpha.

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.

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

Добавить цветовой бар к графику.

Подписи функций для интерфейса 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, будет использоваться цвет, сопоставленный соответствующему значению в 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, **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.