matplotlib.colorbar

Цветные шкалы — это визуализация отображения скалярных значений в цвета. В Matplotlib они рисуются в специальной Axes.

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

Основы: object

Отрисовать шкалу цветов в существующих осях.

Как правило, шкалы цветов создаются с помощью 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 (непрозрачная).

orientation{'vertical', 'horizontal'}

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

drawedgesbool

filledbool

extend{'neither', 'both', 'min', 'max'}

Добавить стрелки (если не 'neither') для значений вне диапазона. Они устанавливаются для заданной цветовой карты с помощью методов 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 или список меток или локатор

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

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

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

drawedgesbool

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

labelstr

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

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

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

Атрибуты:

axAxes

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

linesсписок

Список 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]

draw_all()[source]

[Устарело] Вычислить любые свободные параметры на основе текущей цветовой карты и нормализации и выполнить всю отрисовку.

Примечания

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

свойствоfilled[source]

свойствоformatter

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

get_ticks(minor=False)[source]

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

Параметры:

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

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

свойствоlocator

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

свойствоminorformatter

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

свойствоminorlocator

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

minorticks_off()[source]

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

minorticks_on()[source]

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

n_rasterize=50

свойствоpatch[source]

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, update_ticks=<deprecated parameter>, *, 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, update_ticks=<deprecated parameter>, 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, путем изменения размера и перепозиционирования parents.

Параметры:

parentsAxes или список 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]

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

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

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

• make_axes_gridspec следует использовать только с родительской осью SubplotBase.
• make_axes создаёт Axes; make_axes_gridspec создаёт SubplotBase.
• make_axes обновляет положение родительской оси. make_axes_gridspec заменяет атрибут grid_spec родителя новым.

Хотя эта функция предназначена для совместимости с make_axes, могут быть небольшие отличия.

Параметры:

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

Возвращает:

caxSubplotBase

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

kwargsdict

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