matplotlib.colorbar

Цветные шкалы — это визуализация сопоставления скалярных значений с цветами. В Matplotlib они выводятся в специальную Axes.

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

Базы: object

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

Обычно цветковые шкалы создаются с помощью Figure.colorbar или pyplot.colorbar и ассоциируются с ScalarMappable (такими как AxesImage, сгенерированный с помощью imshow).

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

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

Параметры

axAxes

Экземпляр Axes, на котором отображается цветковая шкала.

mappableScalarMappable

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

Для отображения цветов под и над значениями нормализация объекта должна быть указана как

norm = colors.Normalize(clip=False)

Для отображения цветов по отношению к индексу, а не по шкале 0-1, используйте:

norm=colors.NoNorm()

cmapColormap, по умолчанию: rcParams["image.cmap"] (по умолчанию: 'viridis')

Цветовая карта для использования. Этот параметр игнорируется, если mappable равно None.

normNormalize

Нормализация для использования. Этот параметр игнорируется, если mappable равно None.

alphafloat

Прозрачность цветковой шкалы от 0 (прозрачная) до 1 (непрозрачная).

values, boundaries

Если не задано, цветовая карта будет отображаться по шкале 0-1.

orientation{'вертикальная', 'горизонтальная'}

ticklocation{'авто', 'слева', 'справа', 'верх', 'низ'}

extend{'ничего', 'обе', 'мин', 'макс'}

spacing{'равномерный', 'пропорциональный'}

ticksLocator или массив-подобный тип float

formatстрока или Formatter

drawedgesbool

filledbool

extendfrac

extendrec

labelстрока

Атрибуты

axAxes

Экземпляр Axes, на котором отображается цветковая шкала.

linesсписок

Список LineCollection (пустой, если линии не были нарисованы).

dividersLineCollection

Объект LineCollection (пустой, если drawedges равно False).

add_lines(*args, **kwargs)[source]

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

Линии добавляются в список lines.

Параметры

levelsмассив-подобный тип

Позиции линий.

colorsцвет или список цветов

Один цвет для всех линий или цвет для каждой линии.

linewidthsfloat или массив-подобный тип

Один толщина линии для всех линий или толщина линии для каждой линии.

erasebool, по умолчанию: True

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

Примечания

Этот метод также может быть вызван с сигнатурой colorbar.add_lines(contour_set, erase=True), в этом случае levels, colors и linewidths берутся из contour_set.

drag_pan(button, key, x, y)[source]

draw_all()[source]

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

get_ticks(minor=False)[source]

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

Параметры

minorboolean, по умолчанию: False

Если True, возвращает мелкие метки.

minorticks_off()[source]

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

minorticks_on()[source]

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

n_rasterize=50

propertypatch[source]

remove()[source]

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

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

set_alpha(alpha)[source]

Установите прозрачность в диапазоне от 0 (прозрачный) до 1 (непрозрачный).

Если передан массив, alpha будет установлено в значение None для использования значений прозрачности, связанных с цветовой схемой.

set_label(label, *, loc=None, **kwargs)[source]

Добавить метку к длинной оси колористической шкалы.

Параметры

labelstr

Текст метки.

locstr, необязательно

Положение метки.

• Для горизонтальной ориентации одно из {'слева', 'по центру', 'справа'}
• Для вертикальной ориентации одно из {'снизу', 'по центру', 'сверху'}

По умолчанию rcParams["xaxis.labellocation"] (значение по умолчанию: 'center') или rcParams["yaxis.labellocation"] (значение по умолчанию: 'center') в зависимости от ориентации.

**kwargs

Параметры ключевых слов передаются в set_xlabel / set_ylabel. Поддерживаемые ключевые слова — labelpad и Text свойства.

set_ticklabels(ticklabels, update_ticks=<deprecated parameter>, *, minor=False, **kwargs)[source]

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

Отказано от использования

Использование этого метода не рекомендуется из-за зависимости от положений делений. В большинстве случаев вы хотите использовать set_ticks(positions, labels=labels) вместо этого.

Если вы используете этот метод, вы всегда должны предварительно установить положения делений, например, с помощью Colorbar.set_ticks или явного задания FixedLocator на длинной оси колористической шкалы. Иначе деления могут свободно перемещаться, и метки могут оказаться в неожиданных положениях.

Параметры

ticklabelsпоследовательность str или Text

Тексты для метки каждого местоположения деления в последовательности, установленной с помощью Colorbar.set_ticks; количество меток должно соответствовать количеству местоположений.

update_ticksbool, по умолчанию: True

Этот параметр ключевого слова игнорируется и будет удален. Устарел

minorbool

Если True, устанавливаются вспомогательные деления, а не основные.

**kwargs

Text свойства для меток.

set_ticks(ticks, update_ticks=<deprecated parameter>, labels=None, *, minor=False, **kwargs)[source]

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

Параметры

ticksсписок чисел с плавающей точкой

Список положений делений.

labelsсписок str, необязательно

Список меток делений. Если не задано, метки показывают значение данных.

minorbool, по умолчанию: False

Если False, устанавливаются основные деления; если True, вспомогательные деления.

**kwargs

Text свойства для меток. Они действуют только если вы передаете labels. В остальных случаях, пожалуйста, используйте tick_params.

update_normal(mappable)[source]

Обновление твёрдых областей, линий и т. д.

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

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

update_ticks()[source]

Настройка делений и меток делений. Пользователям это не требуется.

matplotlib.colorbar.ColorbarBase[source]

псевдоним matplotlib.colorbar.Colorbar

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

Основывается на matplotlib.colorbar.Colorbar

[Устарело]

Примечания

Устарело начиная с версии 3.4:

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

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

Примечание

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

Параметры

caxAxes

Оси, которые нужно преобразовать в оси шкалы цвета.

mappableScalarMappable

Отображаемый объект, описываемый шкалой цвета.

**kwargs

Ключевые параметры передаются соответствующему классу шкалы цвета.

Возвращает

Colorbar

Созданный экземпляр шкалы цвета.

Примечания

Устарело начиная с версии 3.4.

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

Создаёт оси, подходящие для шкалы цвета.

Оси размещаются в графике осей parents, изменяя их размер и положение.

Параметры

parentsAxes или список Axes

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

locationNone или {'left', 'right', 'top', 'bottom'}

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

orientationNone или {'vertical', 'horizontal'}

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

fractionfloat, по умолчанию: 0.15

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

shrinkfloat, по умолчанию: 1.0

Доля, на которую умножается размер шкалы цвета.

aspectfloat, по умолчанию: 20

Соотношение длинных и коротких измерений.

Возвращает

caxAxes

Дочерние оси.

kwdict

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

Другие параметры

padfloat, по умолчанию: 0.05, если вертикально, 0.15, если горизонтально

Доля исходных осей между шкалой цвета и новыми осями изображения.

anchor(float, float), необязательно

Точка привязки осей шкалы цвета. По умолчанию (0.0, 0.5), если вертикально; (0.5, 1.0), если горизонтально.

panchor(float, float) или False, необязательно

Точка привязки осей родительских осей. Если False, точка привязки родительских осей не изменится. По умолчанию (1.0, 0.5), если вертикально; (0.5, 0.0), если горизонтально.

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

Создать SubplotBase, подходящий для цветовой шкалы.

Оси размещаются в графике родительских осей, изменяя их размер и положение.

Эта функция похожа на make_axes. Основные различия:

• make_axes_gridspec следует использовать только с родительскими осями типа SubplotBase.
• make_axes создаёт оси типа Axes; make_axes_gridspec создаёт оси типа SubplotBase.
• make_axes обновляет положение родительских осей. make_axes_gridspec заменяет атрибут grid_spec родительской оси на новый.

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

Parameters

parentAxes

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

locationNone или {'left', 'right', 'top', 'bottom'}

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

orientationNone или {'vertical', 'horizontal'}

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

fractionfloat, по умолчанию: 0.15

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

shrinkfloat, по умолчанию: 1.0

Доля, на которую нужно уменьшить размер цветовой шкалы.

aspectfloat, по умолчанию: 20

Соотношение длинных и коротких размеров.

Returns

caxSubplotBase

Дочерние оси.

kwdict

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

Other Parameters

padfloat, по умолчанию: 0.05 при вертикальной, 0.15 при горизонтальной ориентации

Доля исходных осей между цветовой шкалой и новыми осями изображения.

anchor(float, float), необязательно

Точка якорного привязывания осей цветовой шкалы. По умолчанию (0.0, 0.5) при вертикальной ориентации; (0.5, 1.0) при горизонтальной.

panchor(float, float) или False, необязательно

Точка якорного привязывания родительских осей цветовой шкалы. Если False, точка привязывания родительских осей не изменяется. По умолчанию (1.0, 0.5) при вертикальной; (0.5, 0.0) при горизонтальной ориентации.