Spec-Zone.ru › Matplotlib 3.8

matplotlib.quiver.Barbs

classmatplotlib.quiver.Barbs(ax, *args, pivot='tip', length=7, barbcolor=None, flagcolor=None, sizes=None, fill_empty=False, barb_increments=None, rounding=True, flip_barb=False, **kwargs)[source]

Bases: PolyCollection

Специализированное PolyCollection для штриховых стрелок.

Единственный API-метод — set_UVC(), который можно использовать для изменения размера, ориентации и цвета стрелок. Позиции изменяются с помощью метода коллекции set_offsets(). Этот метод, возможно, будет полезен при анимации.

Существует одна внутренняя функция _find_tails(), которая определяет, что именно должно быть нарисовано на штриховой стрелке, исходя из величины вектора. После этого используется функция _make_barbs(), чтобы определить вершины многоугольника для представления штриховой стрелки на основе этой информации.

Конструктор принимает один обязательный аргумент, экземпляр Axes, а также аргументы и ключевые слова, описанные в документации интерфейса pyplot:

Нарисовать 2D поле штриховых стрелок.

Вызов:

barbs([X, Y], U, V, [C], **kwargs)

Где X, Y определяют расположение штриховых стрелок, U, V — направления штриховых стрелок, а C (необязательно) — цвет.

Все аргументы могут быть одномерными или двумерными. U, V, C могут быть массивными массивами, но в настоящее время не поддерживаются массивные X, Y.

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

:                   /\    \
:                  /  \    \
:                 /    \    \    \
:                /      \    \    \
:               ------------------------------

Наибольшее приращение задается треугольником (или «флагом»). Затем идут целые линии (штрихи). Самое малое приращение — это половина линии. Конечно, всегда может быть не более одной половины линии. Если величина мала и требуется только одна половина линии, без целых линий или треугольников, то половина линии смещена от конца штриховой стрелки, чтобы ее можно было легко отличить от штриховых стрелок с одной целой линией. Величина штриховой стрелки, показанной выше, номинально равна 65, используя стандартные приращения 50, 10 и 5.

См. также https://en.wikipedia.org/wiki/Wind_barb.

Параметры:
X, YОдномерный или двумерный массив, необязательно

Координаты x и y расположения штриховых стрелок. См. pivot, чтобы узнать, как штриховые стрелки рисуются по отношению к позициям x, y.

Если не заданы, они будут сгенерированы как равномерная целочисленная сетка на основе размеров U и V.

Если X и Y одномерны, а U, V — двумерны, X, Y расширяются до двумерного вида с использованием X, Y = np.meshgrid(X, Y). В этом случае len(X) и len(Y) должны соответствовать столбцам и строкам U и V.

U, VОдномерный или двумерный массив

Компоненты x и y оси штриховой стрелки.

CОдномерный или двумерный массив, необязательно

Численные данные, определяющие цвета штриховых стрелок с помощью norm и cmap.

Это не поддерживает явные цвета. Если вы хотите установить цвета напрямую, используйте barbcolor.

lengthВещественное число, по умолчанию: 7

Длина штриховой стрелки в пунктах; остальные части штриховой стрелки масштабируются относительно этой величины.

pivot{'tip', 'middle'} или float, по умолчанию: 'tip'

Часть стрелки, закрепленная к сетке X, Y. Штриховая стрелка вращается вокруг этой точки. Это также может быть число, которое смещает начало штриховой стрелки на указанное количество пунктов от точки сетки.

barbcolorцвет или последовательность цветов

Цвет всех частей штриховой стрелки, кроме флагов. Этот параметр аналогичен параметру edgecolor для многоугольников, который можно использовать вместо него. Однако этот параметр переопределит facecolor.

flagcolorцвет или последовательность цветов

Цвет любых флагов на штриховой стрелке. Этот параметр аналогичен параметру facecolor для многоугольников, который можно использовать вместо него. Однако этот параметр переопределит facecolor. Если этот параметр не установлен (и C тоже не установлен), то flagcolor будет установлен в соответствии с barbcolor, чтобы штриховая стрелка имела однородный цвет. Если C установлен, flagcolor не имеет эффекта.

sizesсловарь, необязательно

Словарь коэффициентов, определяющих отношение заданной характеристики к длине штриховой стрелки. Нужно включать только те значения, которые необходимо переопределить. К этим характеристикам относятся:

  • 'spacing' - расстояние между элементами (флагами, целыми/половинными штрихами)
  • 'height' - высота (расстояние от оси до вершины) флага или целого штриха
  • 'width' - ширина флага, вдвое больше ширины целого штриха
  • 'emptybarb' - радиус круга, используемого для малых величин
fill_emptyбулево значение, по умолчанию: False

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

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

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

barb_incrementsсловарь, необязательно

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

  • 'half' - половины штрихов (По умолчанию 5)
  • 'full' - целые штрихи (По умолчанию 10)
  • 'flag' - флаги (по умолчанию 50)
flip_barbбулево значение или массив булевых значений, по умолчанию: False

Указывает, должны ли линии и флаги указывать в противоположном направлении. Нормальное поведение заключается в том, что штрихи и линии указывают вправо (это происходит от штриховых стрелок ветра, у которых эти элементы направлены к низкому давлению в Северном полушарии).

Одно значение применяется ко всем штриховым стрелкам. Отдельные штриховые стрелки могут быть перевернуты, передав массив булевых значений того же размера, что и U и V.

Возвращаемое значение:
barbsBarbs
Другие параметры:
dataиндексируемый объект, необязательно

DATA_PARAMETER_PLACEHOLDER

**kwargs

Штриховые стрелки можно далее настроить, используя PolyCollection ключевые аргументы:

Свойство

Описание

agg_filter

функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

подобный массиву, скаляр или None

animated

bool

antialiased или aa или antialiaseds

bool или список bool

array

подобный массиву или None

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clim

(vmin: float, vmax: float)

clip_box

BboxBase или None

clip_on

bool

clip_path

Patch или (Path, Transform) или None

cmap

Colormap или строка или None

color

цвет или список кортежей RGBA

edgecolor или ec или edgecolors

цвет или список цветов или 'face'

facecolor или facecolors или fc

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

figure

Figure

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или dashes или linestyles или ls

строка или кортеж или список кортежей

linewidth или linewidths или lw

число с плавающей точкой или список чисел с плавающей точкой

mouseover

bool

norm

Normalize или строка или None

offset_transform или transOffset

Transform

offsets

массив (N, 2) или (2,)

path_effects

список AbstractPathEffect

paths

список подобных массивам

picker

None или bool или число с плавающей точкой или вызываемая функция

pickradius

число с плавающей точкой

rasterized

bool

sizes

numpy.ndarray или None

sketch_params

(scale: float, length: float, randomness: float)

snap

bool или None

transform

Transform

url

строка

urls

список строк или None

verts

список подобных массивам

verts_and_codes

неизвестно

visible

bool

zorder

вещественное число

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

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

Примечания

Устарело начиная с версии 3.7:

set(*, UVC=<НЕ ЗАДАНО>, agg_filter=<НЕ ЗАДАНО>, alpha=<НЕ ЗАДАНО>, animated=<НЕ ЗАДАНО>, antialiased=<НЕ ЗАДАНО>, array=<НЕ ЗАДАНО>, capstyle=<НЕ ЗАДАНО>, clim=<НЕ ЗАДАНО>, clip_box=<НЕ ЗАДАНО>, clip_on=<НЕ ЗАДАНО>, clip_path=<НЕ ЗАДАНО>, cmap=<НЕ ЗАДАНО>, color=<НЕ ЗАДАНО>, edgecolor=<НЕ ЗАДАНО>, facecolor=<НЕ ЗАДАНО>, gid=<НЕ ЗАДАНО>, hatch=<НЕ ЗАДАНО>, in_layout=<НЕ ЗАДАНО>, joinstyle=<НЕ ЗАДАНО>, label=<НЕ ЗАДАНО>, linestyle=<НЕ ЗАДАНО>, linewidth=<НЕ ЗАДАНО>, mouseover=<НЕ ЗАДАНО>, norm=<НЕ ЗАДАНО>, offset_transform=<НЕ ЗАДАНО>, offsets=<НЕ ЗАДАНО>, path_effects=<НЕ ЗАДАНО>, paths=<НЕ ЗАДАНО>, picker=<НЕ ЗАДАНО>, pickradius=<НЕ ЗАДАНО>, rasterized=<НЕ ЗАДАНО>, sizes=<НЕ ЗАДАНО>, sketch_params=<НЕ ЗАДАНО>, snap=<НЕ ЗАДАНО>, transform=<НЕ ЗАДАНО>, url=<НЕ ЗАДАНО>, urls=<НЕ ЗАДАНО>, verts=<НЕ ЗАДАНО>, verts_and_codes=<НЕ ЗАДАНО>, visible=<НЕ ЗАДАНО>, zorder=<НЕ ЗАДАНО>)[source]

Устанавливает сразу несколько свойств.

Поддерживаемые свойства:

Свойство

Описание

UVC

неизвестно

agg_filter

функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, а возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

массивоподобное значение, скаляр или None

animated

bool

antialiased или aa или antialiaseds

bool или список bool

array

массивоподобное значение или None

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clim

(vmin: float, vmax: float)

clip_box

BboxBase или None

clip_on

bool

clip_path

Объект Patch или (Path, Transform) или None

cmap

Colormap или строка или None

color

цвет или список кортежей RGBA

edgecolor или ec или edgecolors

цвет или список цветов или 'face'

facecolor или facecolors или fc

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

figure

Figure

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или dashes или linestyles или ls

строка или кортеж или список кортежей

linewidth или linewidths или lw

число с плавающей точкой или список чисел с плавающей точкой

mouseover

bool

norm

Normalize или строка или None

offset_transform или transOffset

Transform

offsets

последовательность пар чисел с плавающей точкой

path_effects

список AbstractPathEffect

paths

список массивоподобных значений

picker

None или bool или число с плавающей точкой или вызываемая функция

pickradius

число с плавающей точкой

rasterized

bool

sizes

numpy.ndarray или None

sketch_params

(scale: float, length: float, randomness: float)

snap

bool или None

transform

Transform

url

строка

urls

список строк или None

verts

список массивоподобных значений

verts_and_codes

неизвестно

visible

bool

zorder

вещественное число

set_UVC(U, V, C=None)[source]
set_offsets(xy)[source]

Устанавливает смещения для полигонов стрелок. Сохраняет переданные смещения и маскирует их соответствующим образом для существующих данных U/V.

Параметры:
xyпоследовательность пар чисел с плавающей запятой

© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.8.4/api/_as_gen/matplotlib.quiver.Barbs.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API