matplotlib.figure.Figure.colorbar

Figure.colorbar(mappable, cax=None, ax=None, use_gridspec=True, **kwargs)[source]

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

Параметры:

mappable

Объект matplotlib.cm.ScalarMappable (например, AxesImage, ContourSet и т.д.) описываемый этой шкалой цвета. Этот аргумент обязателен для метода Figure.colorbar, но необязателен для функции pyplot.colorbar, которая устанавливает значение по умолчанию на текущее изображение.

Обратите внимание, что можно создать ScalarMappable "на лету", чтобы создать шкалу цвета, не привязанную к ранее нарисованному объекту, например:

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)

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

Система координат, в которую будет нарисована шкала цвета. Если None, тогда создаётся новая система координат, и пространство для неё будет взято из системы координат(ы) указанной в ax.

axAxes или итерируемый объект или numpy.ndarray из систем координат, необязательно

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

По умолчанию используется система координат, содержащая используемый для создания шкалы цвета объект mappable.

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

Если cax None, новая cax создаётся как экземпляр Axes. Если ax расположен с помощью subplotspec и use_gridspec True, тогда cax также расположен с помощью subplotspec.

Возвращает:

colorbarColorbar

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

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

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

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

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

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

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

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

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

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

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

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) для горизонтальной.

extend{'neither', 'both', 'min', 'max'}

Создать стрелки для значений вне диапазона (если 'neither' не используется). Эти значения устанавливаются для заданной цветовой карты с помощью методов colormap set_under и set_over.

extendfrac{None, 'auto', length, lengths}

Если установлено в None, оба треугольных расширения шкалы цвета будут иметь длину 5% длины внутренней шкалы цвета (это значение по умолчанию).

Если установлено в 'auto', делает треугольные расширения шкалы цвета такими же, как внутренние прямоугольники (когда spacing установлен в 'uniform') или такие же, как соответствующие смежные внутренние прямоугольники (когда spacing установлен в 'proportional').

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

extendrectbool

Если False, минимальное и максимальное расширения шкалы цвета будут треугольными (значение по умолчанию). Если True, расширения будут прямоугольными.

spacing{'uniform', 'proportional'}

Для дискретных шкал цвета (BoundaryNorm или контуров), 'uniform' даёт каждому цвету одинаковое пространство; 'proportional' делает пространство пропорциональным интервалу данных.

ticksNone или список меток или Locator

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

formatNone или строка или Formatter

Если None, используется ScalarFormatter. Поддерживаются строковые форматы, например, "%4.2e" или "{x:.2e}". Вместо этого можно указать альтернативный Formatter.

drawedgesbool

Рисовать ли линии на границах цветов.

labelstr

Метка по длинной оси шкалы цвета.

boundaries, valuesNone или последовательность

Если не заданы, цветовая карта будет отображаться в масштабе 0-1. Если заданы последовательности, values должны иметь длину на 1 меньше, чем boundaries. Для каждого интервала, ограниченного соседними элементами в boundaries, используется цвет, сопоставленный соответствующему значению в values. Обычно это полезно только для индексированных цветов (например, norm=NoNorm()) или других необычных случаев.

Примечания

Если mappable — ContourSet, его extend kwarg автоматически включается.

Параметр shrink предоставляет простой способ масштабирования шкалы цвета относительно системы координат. Обратите внимание, что если задан cax, он определяет размер шкалы цвета, и shrink и aspect игнорируются.

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

Известно, что некоторые визуализаторы векторной графики (svg и pdf) отображают белые зазоры между сегментами шкалы цвета. Это связано с ошибками в визуализаторах, а не с Matplotlib. В качестве обходного решения шкала цвета может быть отрисована с перекрывающимися сегментами:

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

Однако это имеет негативные последствия в других обстоятельствах, например, с полупрозрачными изображениями (alpha < 1) и расширениями шкалы цвета; поэтому это обходное решение не используется по умолчанию (см. вопрос #1188).