matplotlib.colorbar

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

ColorbarBase

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

Colorbar

На основе ColorbarBase он подключает цветную шкалу к ScalarMappable, например, к изображению или контурному графику.

ColorbarPatch

Специализированная Colorbar для поддержки контурных графиков с штриховкой.

make_axes()

Создаёт Axes, подходящий для цветной шкалы. Эта функция может использоваться с фигурами, содержащими один осевой график, или с произвольно размещёнными осями.

make_axes_gridspec()

Создаёт SubplotBase, подходящий для цветной шкалы. Эта функция должна использоваться для добавления цветной шкалы к GridSpec.

class matplotlib.colorbar.Colorbar(ax, mappable, **kwargs) [source]

Базируется на matplotlib.colorbar.ColorbarBase

Этот класс подключает ColorbarBase к ScalarMappable, например, к AxesImage, сгенерированному через imshow.

Примечание

Этот класс не предназначен для прямого создания экземпляра; вместо этого используйте Figure.colorbar или pyplot.colorbar для создания цветной шкалы.

add_lines(self, CS, erase=True) [source]

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

Параметры:	CSContourSet Позиции линий берутся из уровней ContourSet. ContourSet не должен быть заполнен. erasebool, default: True Удалить линий, добавленных ранее.

on_mappable_changed(self, mappable) [source]

[Устарело] Обновление цветной шкалы для соответствия свойствам объекта отображения.

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

Примечания

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

remove(self) [source]

Удаление цветной шкалы из фигуры.

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

update_bruteforce(self, mappable) [source]

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

Примечания

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

update_normal(self, mappable) [source]

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

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

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

class matplotlib.colorbar.ColorbarBase(ax, *, 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]

Bases: object

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

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

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

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

norm=colors.Normalize(clip=False)

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

norm=colors.NoNorm()

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

Параметры:

axAxes Экземпляр Axes, в котором отображается цветковая шкала. cmapColormap, default: rcParams["image.cmap"] (default: 'viridis') Используемая цветовая карта. normNormalize alphafloat Прозрачность цветковой шкалы в диапазоне от 0 (прозрачная) до 1 (непрозрачная). values boundaries orientation{'vertical', 'horizontal'} ticklocation{'auto', 'left', 'right', 'top', 'bottom'} extend{'neither', 'both', 'min', 'max'} spacing{'uniform', 'proportional'} ticksLocator or array-like of float formatstr or Formatter drawedgesbool filledbool extendfrac extendrec labelstr

Атрибуты:

axAxes Экземпляр Axes, в котором отображается цветковая шкала. lineslist Список LineCollection, если линии были нарисованы, в противном случае пустой список. dividersLineCollection Объект LineCollection, если drawedges равняется True, в противном случае None.

add_lines(self, levels, colors, linewidths, erase=True) [source]

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

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

Параметры:	levelsarray-like Позиции линий. colorscolor or list of colors Цвет, либо единый цвет для всех линий, либо отдельный цвет для каждой линии. linewidthsfloat or array-like Толщина линий, либо единая толщина для всех линий, либо отдельные толщины для каждой линии. erasebool, default: True Удалить линий, добавленные ранее.

config_axis(self) [source]

[Устарело]

Примечания

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

draw_all(self) [source]

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

get_ticks(self, minor=False) [source]

Возвращает список меток по оси x.

minorticks_off(self) [source]

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

minorticks_on(self) [source]

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

n_rasterize = 50

remove(self) [source]

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

set_alpha(self, alpha) [source]

Задает прозрачность в диапазоне от 0 (прозрачная) до 1 (непрозрачная).

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

Добавляет подпись к длинной оси цветковой шкалы.

set_ticklabels(self, ticklabels, update_ticks=True) [source]

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

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

set_ticks(self, ticks, update_ticks=True) [source]

Устанавливает позиции делений.

Параметры:	ticksarray-like or Locator or None Позиции делений могут быть заданы массивом значений; или они могут быть определены с помощью Locator. Установка в None возвращает использование стандартного локатора. update_ticksbool, default: True Если True, позиции делений обновляются немедленно. Если False, пользователю нужно вызвать update_ticks позже, чтобы обновить деления.

update_ticks(self) [source]

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

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

Наследуется от matplotlib.colorbar.Colorbar

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

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

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

Примечание

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

Параметры:	caxAxes Axes, которые преобразуются в оси цветковой шкалы. mappableScalarMappable Объект отображения, описываемый цветковой шкалой. **kwargs Ключевые аргументы передаются соответствующему классу цветковой шкалы.
Возвращает:	Colorbar or ColorbarPatch Созданный экземпляр цветковой шкалы. ColorbarPatch используется только если mappable является ContourSet с штриховкой.

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

Создаёт Axes, подходящую для цветковой шкалы.

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

Параметры:	parentsAxes or list of Axes Оси, используемые как родительские для размещения цветковой шкалы. locationNone or {'left', 'right', 'top', 'bottom'} Положение, относительно родительских осей, где должны быть созданы оси цветковой шкалы. Если None, значение будет взято из orientation, иначе по умолчанию будет 'right'. orientationNone or {'vertical', 'horizontal'} Ориентация цветковой шкалы. Обычно этот ключевой параметр не используется, так как может быть определён из ключевого параметра location. fractionfloat, default: 0.15 Доля исходных осей, используемых для цветковой шкалы. shrinkfloat, default: 1.0 Коэффициент, на который умножается размер цветковой шкалы. aspectfloat, default: 20 Соотношение длинных и коротких размеров.
Возвращает:	caxAxes Дочерние оси. kwdict Уменьшенный словарь ключевых параметров, который передаётся при создании экземпляра цветковой шкалы.
Другие параметры:	padfloat, default: 0.05 if vertical, 0.15 if horizontal Доля исходных осей между цветковой шкалой и новыми осями изображения. anchor(float, float), optional Точка привязки осей цветковой шкалы. По умолчанию (0.0, 0.5) для вертикальной; (0.5, 1.0) для горизонтальной. panchor(float, float), or False, optional Точка привязки родительских осей цветковой шкалы. Если False, точка привязки родительских осей остаётся неизменной. По умолчанию (1.0, 0.5) для вертикальной; (0.5, 0.0) для горизонтальной.

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

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

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

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

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

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

Параметры:	parentAxes Оси, используемые как родительские для размещения цветковой шкалы. fractionfloat, default: 0.15 Доля исходных осей, используемых для цветковой шкалы. shrinkfloat, default: 1.0 Коэффициент, на который умножается размер цветковой шкалы. aspectfloat, default: 20 Соотношение длинных и коротких размеров.
Возвращает:	caxSubplotBase Дочерние оси. kwdict Уменьшенный словарь ключевых параметров, который передаётся при создании экземпляра цветковой шкалы.
Другие параметры:	orientation{'vertical', 'horizontal'}, default: 'vertical' Ориентация цветковой шкалы. padfloat, default: 0.05 if vertical, 0.15 if horizontal Доля исходных осей между цветковой шкалой и новыми осями изображения. anchor(float, float), optional Точка привязки осей цветковой шкалы. По умолчанию (0.0, 0.5) для вертикальной; (0.5, 1.0) для горизонтальной. panchor(float, float), or False, optional Точка привязки родительских осей цветковой шкалы. Если False, точка привязки родительских осей остаётся неизменной. По умолчанию (1.0, 0.5) для вертикальной; (0.5, 0.0) для горизонтальной.