Spec-Zone.ru › Matplotlib 1.5

Панель управления цветом

matplotlib.colorbar

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

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

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

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

Базы: matplotlib.colorbar.ColorbarBase

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

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

add_lines(CS, erase=True)

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

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

on_mappable_changed(mappable)

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

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

remove()

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

update_bruteforce(mappable)

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

update_normal(mappable)

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

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='')

Базы: matplotlib.cm.ScalarMappable

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

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

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

colors.Normalize(clip=False)

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

norm=colors.NoNorm.

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

ax
экземпляр Axes, на котором отображается палитра
lines
список LineCollection, если были нарисованы линии, в противном случае пустой список
dividers
LineCollection, если drawedges равен True, в противном случае None

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

add_lines(levels, colors, linewidths, erase=True)

Отобразить линии на палитре.

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

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

ax = None

Ось, в которой находится эта палитра.

config_axis()
draw_all()

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

n_rasterize = 50
remove()

Удалить эту палитру с рисунка

set_alpha(alpha)
set_label(label, **kw)

Подписать ось палитры

set_ticklabels(ticklabels, update_ticks=True)

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

set_ticks(ticks, update_ticks=True)

Установить положения делений. Положения делений обновляются немедленно, если update_ticks не равно False. Для ручного обновления делений вызовите метод update_ticks явно.

update_ticks()

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

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

Базы: matplotlib.colorbar.Colorbar

Палитра цветов, которая создается с помощью Patch вместо стандартного pcolor().

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

matplotlib.colorbar.colorbar_factory(cax, mappable, **kwargs)

Создает палитру цветов на заданной оси для заданного объекта mappable.

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

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

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

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

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

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, **kw)

Изменение размера и перепозиционирование родительских осей и возврат дочерних осей, подходящих для цветовой шкалы. Эта функция похожа на 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, могут быть небольшие различия:

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

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

orientation
‘vertical’ или ‘horizontal’
Свойство Описание
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, который будет передан при создании экземпляра цветовой шкалы.

© 2012–2016 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
http://matplotlib.org/1.5.3/api/colorbar_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API