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, filled=<deprecated parameter>, extendfrac=None, extendrect=False, label='', location=None)[source]

Bases: 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 или {'вертикаль', 'горизонталь'}

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

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

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

drawedgesbool

Отображать ли линии на границах цветов.

filledbool

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

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

extendfrac{None, 'авто', длина, длины}

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

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

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

extendrectbool

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

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

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

ticksNone или список делений или Locator

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

formatNone или строка или Форматировщик

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

drawedgesbool

Отображать ли линии на границах цветов.

labelстрока

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

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

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

locationNone или {'слева', 'справа', 'сверху', 'снизу'}

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

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

Атрибуты:

axAxes

Объект Axes, на котором отображается шкала цветов.

linesсписок

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

dividersLineCollection

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

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

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

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

Параметры:

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

Позиции линий.

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

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

linewidthsfloat или массив-подобный объект

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

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

Удалять ли ранее добавленные линии.

Примечания

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

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

draw_all()[source]

[Устаревшее] Вычисление произвольных параметров на основе текущей палитры и нормализации, и выполнение всего рисования.

Примечания

Устаревшее с версии 3.6: Используйте fig.draw_without_rendering() вместо этого.

propertyfilled[source]

[Устаревшее]

Примечания

Устаревшее с версии 3.6:

propertyformatter

Метка основных шкал помечающих Formatter для цветовой шкалы.

get_ticks(minor=False)[source]

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

Параметры:

minorboolean, по умолчанию: 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, необязательно

Расположение подписи.

• Для горизонтальной ориентации одно из {'left', 'center', 'right'}
• Для вертикальной ориентации одно из {'bottom', 'center', 'top'}

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

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

Параметры:

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

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

kwargsсловарь

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

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

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