Spec-Zone.ru › Matplotlib 3.7

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:

Построение двумерного поля штрихов.

Вызов:

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.

Parameters:
X, Y1D или 2D массив-подобный объект, необязательно

Координаты 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, V1D или 2D массив-подобный объект

Компоненты x и y оси штриха.

C1D или 2D массив-подобный объект, необязательно

Числовые данные, определяющие цвета штрихов с помощью colormapping через 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_emptybool, по умолчанию: False

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

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

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

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

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

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

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

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

Returns:
barbsBarbs
Other Parameters:
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

Bbox

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

неизвестно

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

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

alpha

массив-подобный объект, скаляр или None

animated

булево значение

antialiased или aa или antialiaseds

булево значение или список булевых значений

array

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

capstyle

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

clim

(vmin: float, vmax: float)

clip_box

Bbox

clip_on

булево значение

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

булево значение

joinstyle

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

label

объект

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

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

linewidth или linewidths или lw

вещественное число или список вещественных чисел

mouseover

булево значение

norm

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

offset_transform или transOffset

неизвестно

offsets

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

path_effects

AbstractPathEffect

paths

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

picker

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

pickradius

неизвестно

rasterized

булево значение

sizes

numpy.ndarray или None

sketch_params

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

snap

булево значение или None

transform

Transform

url

строка

urls

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

verts

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

verts_and_codes

неизвестно

visible

булево значение

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

Spec-Zone.ru

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