matplotlib.colorbar

Палитры — это визуализация соответствия между скалярными значениями и цветами. В Matplotlib они выводятся в выделенном Axes.

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

Основы: object

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

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

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

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

Параметры:

axAxes

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

mappableScalarMappable

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

Чтобы отобразить цвета для значений вне диапазона, норма mappable должна быть указана как

norm = colors.Normalize(clip=False)

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

norm=colors.NoNorm()

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

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

normNormalize

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

alphafloat

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

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

Если None, используется значение, определённое параметром location. Если оба orientation и location равны None, по умолчанию используется 'vertical'.

ticklocation{'auto', 'left', 'right', 'top', 'bottom'}

Положение делений шкалы цветов. ticklocation должен совпадать с orientation. Например, горизонтальная шкала цветов может иметь деления только вверху или внизу. Если 'auto', деления будут такими же, как location, так что шкала слева будет иметь деления слева. Если location равно None, деления будут внизу для горизонтальной шкалы и справа для вертикальной.

drawedgesbool

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

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()) или в других необычных обстоятельствах.

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

Установите orientation и ticklocation шкалы цветов с помощью одного аргумента. Шкалы цветов слева и справа вертикальные, шкалы цветов вверху и внизу горизонтальные. ticklocation совпадает с location, так что если location равно 'top', деления находятся вверху. orientation и/или ticklocation могут быть указаны и переопределяют значение, заданное location, но могут возникнуть ошибки при несовместимых комбинациях.

Введено в версии 3.7.

Атрибуты:

axAxes

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

lineslist

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

dividersLineCollection

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

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

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

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

Параметры:

levelsarray-like

Положения линий.

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

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

linewidthsfloat или array-like

Одна толщина линии, применяемая ко всем линиям, или одна толщина линии для каждой линии.

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

Удалить линию, если она была уже добавлена.

Примечания

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

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

propertyformatter

Основная метка шкалы Formatter для цветовой шкалы.

get_ticks(minor=False)[source]

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

Параметры:

minorлогическое значение, по умолчанию: False

если True, возвращает вспомогательные метки.

propertylocator

Основной Locator шкалы для цветовой шкалы.

propertyminorformatter

Вспомогательная Formatter цветовой шкалы.

propertyminorlocator

Вспомогательный Locator для цветовой шкалы.

minorticks_off()[source]

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

minorticks_on()[source]

Включить вспомогательные метки цветовой шкалы.

n_rasterize=50

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, *, 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, *, labels=None, minor=False, **kwargs)[source]

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

Параметры:

ticksОдномерный массив-подобный объект

Список расположений меток делений.

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

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

minorбулево значение, по умолчанию: False

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

**kwargs

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

update_normal(mappable)[source]

Обновить заполненные области, линии и т.д.

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

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

update_ticks()[source]

Настроить метки делений и подписи. Пользователю обычно это не нужно.

matplotlib.colorbar.ColorbarBase[source]

Псевдоним для Colorbar

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

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

Ось размещается в фигуре оси parents, изменяя её размер и положение.

Параметры:

parentsAxes или итерируемый объект или numpy.ndarray из Axes

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

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

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

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

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

fractionвещественное число, по умолчанию: 0.15

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

shrinkвещественное число, по умолчанию: 1.0

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

aspectвещественное число, по умолчанию: 20

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

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

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

anchor(вещественное число, вещественное число), необязательно

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

panchor(вещественное число, вещественное число) или False, необязательно

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

Возвращает:

caxAxes

Дочерняя ось.

kwargsdict

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

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

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

Ось размещается в фигуре оси parent, путем изменения размера и перепозиционирования parent.

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

• make_axes_gridspec требует, чтобы parent имела объект subplotspec.
• make_axes позиционирует ось в координатах фигуры; make_axes_gridspec позиционирует ее с помощью subplotspec.
• make_axes обновляет положение родительской оси. make_axes_gridspec заменяет родительскую сетку новой.

Parameters:

parentAxes

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

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

Returns:

caxAxes

Вспомогательная ось.

kwargsdict

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