matplotlib.colorbar

Colorbars are a visualization of the mapping from scalar values to colors. In Matplotlib they are drawn into a dedicated 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

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

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

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

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

Параметры:

axAxes

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

mappableScalarMappable

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

Для отображения цветов для значений вне диапазона нормализация отображаемого объекта должна быть задана как

norm = colors.Normalize(clip=False)

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

norm=colors.NoNorm()

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

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

normNormalize

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

alphafloat

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

orientationNone или {'вертикальный', 'горизонтальный'}

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

ticklocation{'автоматический', 'слева', 'справа', 'сверху', 'снизу'}

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

extend{'ничего', 'оба', 'мин', 'макс'}

Добавить стреловидные концы для значений вне диапазона (если не 'ничего'). Они устанавливаются для заданной цветовой карты с помощью методов set_under и set_over цветовой карты.

extendfrac{None, 'автоматический', длина, длины}

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

Если равно 'автоматический', делает длину треугольных расширений шкалы цвета такой же, как длины внутренних прямоугольников (если spacing равен 'равномерный') или такие же, как длины соседних внутренних прямоугольников (если spacing равен 'пропорционально').

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

extendrectbool

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

spacing{'равномерный', 'пропорционально'}

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

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 или {'слева', 'справа', 'сверху', 'снизу'}

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

Добавлен в версии 3.7.

Атрибуты:

axAxes

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

linesсписок

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

dividersLineCollection

ЛинияCollection (пустая, если 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

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

get_ticks(minor=False)[source]

Возвращает метки в виде списка положений.

Параметры:

minorboolean, по умолчанию: False

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

propertylocator

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

propertyminorformatter

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

propertyminorlocator

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

minorticks_off()[source]

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

minorticks_on()[source]

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

n_rasterize=50

remove()[source]

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

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

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список строк, необязательно

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

minorbool, по умолчанию: 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 подходящий для цветовой шкалы.

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

Параметры:

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

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

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

Возвращает:

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 заменяет gridspec родителя новым.

Параметры:

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

Возвращает:

caxAxes

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

kwargsdict

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