matplotlib.pyplot.colorbar

matplotlib.pyplot.colorbar(mappable=None, cax=None, ax=None, **kw)[source]

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

Параметры:

mappable matplotlib.cm.ScalarMappable (например, AxesImage, ContourSet и т.д.) объекта, описываемого этой цветовой шкалой. Этот аргумент является обязательным для метода Figure.colorbar, но необязательный для функции pyplot.colorbar, которая устанавливает значение по умолчанию до текущего изображения. Обратите внимание, что можно создать ScalarMappable «на лету», чтобы сгенерировать цветовые шкалы, не привязанные к ранее нарисованному элементу, например: fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax) caxAxes, необязательно Система координат, в которую будет нарисована цветовая шкала. axAxes, список систем координат, необязательно Одна или несколько родительских систем координат, из которых будет взято место для новой системы координат цветовой шкалы, если cax равно None. Это не имеет эффекта, если cax задано. use_gridspecbool, необязательно Если cax равно None, новая cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec равно True, cax создается как экземпляр Subplot с использованием модуля gridspec.

Возвращает:

colorbarColorbar См. также его базовый класс ColorbarBase.

Замечания

Дополнительные ключевые аргументы бывают двух типов:

свойства осей:

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

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

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

Ориентация цветовой шкалы. Предпочтительно задавать расположение цветовой шкалы, так как оно также определяет ориентацию; передача несовместимых значений для 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', длина, длины} Если None, оба минимальные и максимальные треугольные расширения цветовой шкалы будут иметь длину 5% от длины внутренней цветовой шкалы (это значение по умолчанию). Если 'auto', треугольные расширения цветовой шкалы будут иметь ту же длину, что и внутренние прямоугольники (когда spacing установлен в 'uniform') или ту же длину, что и соответствующие смежные внутренние прямоугольники (когда spacing установлен в 'proportional'). Если скаляр, указывает длину минимальных и максимальных треугольных расширений цветовой шкалы как долю длины внутренней цветовой шкалы. Также может быть задана последовательность из двух элементов, указывающая длину минимального и максимального расширения цветовой шкалы соответственно как долю длины внутренней цветовой шкалы.
extendrect	bool Если False, минимальные и максимальные расширения цветовой шкалы будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	{'uniform', 'proportional'} Равномерное распределение дает каждому дискретному цвету одинаковое место; пропорциональное делает пространство пропорциональным интервалу данных.
ticks	None или список меток или локатор Если None, метки определяются автоматически из входных данных.
format	None или str или Форматировщик Если None, используется ScalarFormatter. Если задана строка формата, например, '%.3f', она используется. Вместо этого может быть задан другой Formatter.
drawedges	bool Рисовать ли линии на границах цветов.
label	str Подпись на длинной оси цветовой шкалы.

Следующие свойства, скорее всего, будут полезны только в контексте индексированных цветов (то есть, когда mappable имеет norm=NoNorm()) или других необычных ситуациях.

Свойство	Описание
boundaries	None или последовательность
values	None или последовательность, длина которой на 1 меньше, чем последовательность boundaries. Для каждого региона, ограниченного смежными элементами в boundaries, используется цвет, отображаемый для соответствующего значения в values.

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

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

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

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

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

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

Примеры использования matplotlib.pyplot.colorbar

Настройка отступов

Коллекция эллипсов

Делитель осей

Простая цветовая шкала

Руководство по изображениям

Руководство по Tight Layout