matplotlib.pyplot.colorbar

matplotlib.pyplot.colorbar(mappable=None, cax=None, ax=None, **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 не задан.

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

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

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

Возвращаемые значения:

colorbarColorbar

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

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

Положение, относительно родительской оси, где создаётся ось цветковой шкалы. Оно также определяет ориентацию цветковой шкалы (цветковые шкалы слева и справа вертикальные, цветковые шкалы сверху и снизу горизонтальные). Если 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 или str или Formatter

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

drawedgesbool

Определяет, рисовать ли линии на границах цветов.

labelstr

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

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

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

Примечания

Примечание

Это обертка pyplot для Figure.colorbar.

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

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

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

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

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

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