Spec-Zone.ru › Matplotlib

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, а также args и kwargs, описанные в документации интерфейса 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'} или число, по умолчанию: '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индексируемый объект, необязательно

ПЛАЦЕРДЕР_ПАРАМЕТРА_ДАННЫХ

**kwargs

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

Свойство

Описание

agg_filter

функция фильтра, которая принимает массив чисел с плавающей точкой (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 или str или 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

float

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

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

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

Свойство

Описание

UVC

неизвестно

agg_filter

функция фильтра, которая принимает массив с плавающей точкой (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

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

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

float

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/stable/api/_as_gen/matplotlib.quiver.Barbs.html

Spec-Zone.ru

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