Spec-Zone.ru › Matplotlib 3.6

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.

Parameters:
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.

Returns:
barbsBarbs
Other Parameters:
dataиндексируемый объект, необязательно

DATA_PARAMETER_PLACEHOLDER

**kwargs
END_OF_DOCUMENT_MARKER

Штриховку можно дополнительно настроить, используя ключевые аргументы 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 или строка или 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 или float или вызываемый объект

pickradius

неизвестно

rasterized

bool

sizes

массив NumPy или 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='\nОтображение 2D поля стрелочек.\n\nВызов функции::\n\n barbs([X, Y], U, V, [C], **kwargs)\n\nГде *X*, *Y* задают расположение стрелочек, *U*, *V* задают направления стрелочек, а *C* — необязательно задаёт цвет.\n\nВсе аргументы могут быть 1D или 2D. *U*, *V*, *C* могут быть массивами с пропускаемыми значениями, но в настоящее время пропускаемые значения\n*X*, *Y* не поддерживаются.\n\nСтрелки традиционно используются в метеорологии для отображения скорости и направления ветра, но технически могут быть использованы для\nотображения любого двухмерного векторного количества. В отличие от стрелок, которые указывают величину вектора длиной стрелки, стрелки дают больше\nколичественную информацию о величине вектора, помещая наклонные линии или треугольник для различных приращений величины, как показано схематично ниже::\n\n : /\\ \\\n : / \\ \\\n : / \\ \\ \\\n : / \\ \\ \\\n : ------------------------------\n\nНаибольшее приращение задаётся треугольником (или «флагом»). За ними следуют сплошные линии (стрелки). Наименьшее приращение — полулиния. Есть, конечно, только максимум одна полулиния. Если величина мала и требует только одной полулинии и нет сплошных линий или треугольников, полулиния смещена от конца стрелки, чтобы её легко можно было отличить от стрелок с одной сплошной линией. Величина показанной выше стрелки номинально составляет 65, используя стандартные приращения 50, 10 и 5.\n\nСм. также https://ru.wikipedia.org/wiki/Флаг_ветра.\n\nПараметры\n----------\nX, Y : 1D или 2D массив, необязательно\n Координаты x и y расположения стрелочек. Смотрите *pivot*, чтобы узнать, как стрелки выводятся на позиции x, y.\n\n Если они не заданы, они будут сгенерированы в виде равномерной целочисленной сетки на основе размеров *U* и *V*.\n\n Если *X* и *Y* 1D, но *U*, *V* 2D, *X*, *Y* расширяются до 2D\n с помощью ``X, Y = np.meshgrid(X, Y)``. В этом случае ``len(X)`` и ``len(Y)``\n должны соответствовать размерам столбцов и строк *U* и *V*.\n\nU, V : 1D или 2D массив\n Компоненты x и y оси стрелки.\n\nC : 1D или 2D массив, необязательно\n Численные данные, которые определяют цвета стрелок путём сопоставления цветов с помощью *norm* и\n *cmap*.\n\n Это не поддерживает явные цвета. Если вы хотите установить цвета напрямую,\n используйте *barbcolor* вместо этого.\n\nlength : float, по умолчанию: 7\n Длина стрелки в пунктах; другие части стрелки масштабируются относительно этого значения.\n\npivot : {\'tip\', \'middle\'} или float, по умолчанию: \'tip\'\n Часть стрелки, которая закреплена на сетке *X*, *Y*. Стрелка вращается вокруг этой точки. Это также может быть число, которое смещает начало стрелки на это количество пунктов от точки сетки.\n\nbarbcolor : цвет или последовательность цветов\n Цвет всех частей стрелки, кроме флагов. Этот параметр аналогичен параметру *edgecolor* для многоугольников, который можно использовать\n вместо него. Однако этот параметр переопределит facecolor.\n\nflagcolor : цвет или последовательность цветов\n Цвет всех флагов на стрелке. Этот параметр аналогичен параметру *facecolor* для многоугольников, который можно использовать вместо него. Однако\n этот параметр переопределит facecolor. Если этот параметр не установлен (и *C* тоже не установлен), тогда *flagcolor* будет установлен для соответствия *barbcolor*, чтобы стрелка имела одинаковый цвет. Если *C* задан, *flagcolor* не имеет эффекта.\n\nsizes : dict, необязательно\n Словарь коэффициентов, определяющих соотношение заданного\n элемента к длине стрелки. Включены только те значения, которые необходимо переопределить. Эти элементы включают:\n\n - \'spacing\' - расстояние между элементами (флагами, полными/полуполными стрелками)\n - \'height\' - высота (расстояние от оси до верха) флага или полной стрелки\n - \'width\' - ширина флага, в два раза больше ширины полной стрелки\n - \'emptybarb\' - радиус окружности, используемой для малых величин\n\nfill_empty : bool, по умолчанию: False\n Заполнять ли пустые стрелки (круги), которые выводятся, цветом флага. Если они не заполнены, центр прозрачен.\n\nrounding : bool, по умолчанию: True\n Округлять ли величину вектора при распределении компонентов стрелки.\n Если True, величина округляется до ближайшего кратного приращения полустрелки. Если False, величина просто усекается до ближайшего меньшего кратного.\n\nbarb_increments : dict, необязательно\n Словарь приращений, определяющий значения, которые следует связать\n с различными частями стрелки. Включаются только те значения, которые необходимо переопределить.\n\n - \'half\' - полустрелки (По умолчанию 5)\n - \'full\' - полные стрелки (По умолчанию 10)\n - \'flag\' - флаги (по умолчанию 50)\n\nflip_barb : bool или массив bool, по умолчанию: False\n Определяет, должны ли линии и флаги указывать в противоположную сторону.\n Нормальное поведение — это то, что стрелки и линии указывают вправо (происходит от стрелок ветра, у которых эти элементы указывают на низкое давление в Северном полушарии).\n\n Одно значение применяется ко всем стрелкам. Отдельные стрелки можно перевернуть, передав массив bool такого же размера, как *U* и *V*.\n\nВозвращает\n-------\nbarbs : `~matplotlib.quiver.Barbs`\n\nДругие параметры\n----------------\ndata : индексируемый объект, необязательно\n МЕСТОЗАМЕСТИТЕЛЬ_ПАРАМЕТРА_ДАННЫХ\n\n**kwargs\n Стрелки можно дополнительно настроить, используя параметры `.PolyCollection`:\n\n \n .. table::\n :class: property-table\n\n ================================================================================================= ==============================================================================================================================================================\n Свойство Описание \n ================================================================================================= ==============================================================================================================================================================\n :meth:`agg_filter <matplotlib.artist.Artist.set_agg_filter>` функция фильтрации, которая принимает (m, n, 3) массив с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения\n :meth:`alpha <matplotlib.collections.Collection.set_alpha>` массив или скаляр или None \n :meth:`animated <matplotlib.artist.Artist.set_animated>` bool \n :meth:`antialiased <matplotlib.collections.Collection.set_antialiased>` или aa или antialiaseds bool или список bool \n :meth:`array <matplotlib.cm.ScalarMappable.set_array>` массив или None \n :meth:`capstyle <matplotlib.collections.Collection.set_capstyle>` `.CapStyle` или {\'butt\', \'projecting\', \'round\'} \n :meth:`clim <matplotlib.cm.ScalarMappable.set_clim>` (vmin: float, vmax: float) \n :meth:`clip_box <matplotlib.artist.Artist.set_clip_box>` `.Bbox` \n :meth:`clip_on <matplotlib.artist.Artist.set_clip_on>` bool \n :meth:`clip_path <matplotlib.artist.Artist.set_clip_path>` Patch или (Path, Transform) или None \n :meth:`cmap <matplotlib.cm.ScalarMappable.set_cmap>` `.Colormap` или str или None \n :meth:`color <matplotlib.collections.Collection.set_color>` цвет или список кортежей rgba \n :meth:`edgecolor <matplotlib.collections.Collection.set_edgecolor>` или ec или edgecolors цвет или список цветов или \'face\' \n :meth:`facecolor <matplotlib.collections.Collection.set_facecolor>` или facecolors или fc цвет или список цветов \n :meth:`figure <matplotlib.artist.Artist.set_figure>` `.Figure` \n :meth:`gid <matplotlib.artist.Artist.set_gid>` str \n :meth:`hatch <matplotlib.collections.Collection.set_hatch>` {\'/\', \'\\\\\', \'|\', \'-\', \'+\', \'x\', \'o\', \'O\', \'.\', \'*\'} \n :meth:`in_layout <matplotlib.artist.Artist.set_in_layout>` bool \n :meth:`joinstyle <matplotlib.collections.Collection.set_joinstyle>` `.JoinStyle` или {\'miter\', \'round\', \'bevel\'} \n :meth:`label <matplotlib.artist.Artist.set_label>` объект \n :meth:`linestyle <matplotlib.collections.Collection.set_linestyle>` или dashes или linestyles или ls str или кортеж или список \n :meth:`linewidth <matplotlib.collections.Collection.set_linewidth>` или linewidths или lw float или список чисел \n :meth:`mouseover <matplotlib.artist.Artist.set_mouseover>` bool \n :meth:`norm <matplotlib.cm.ScalarMappable.set_norm>` `.Normalize` или str или None \n :meth:`offset_transform <matplotlib.collections.Collection.set_offset_transform>` или transOffset неизвестно \n :meth:`offsets <matplotlib.collections.Collection.set_offsets>` (N, 2) или (2,) массив \n :meth:`path_effects <matplotlib.artist.Artist.set_path_effects>` `.AbstractPathEffect` \n :meth:`paths <matplotlib.collections.PolyCollection.set_verts>` список массивов \n :meth:`picker <matplotlib.artist.Artist.set_picker>` None или bool или float или вызываемая функция \n :meth:`pickradius <matplotlib.collections.Collection.set_pickradius>` неизвестно \n :meth:`rasterized <matplotlib.artist.Artist.set_rasterized>` bool \n :meth:`sizes <matplotlib.collections._CollectionWithSizes.set_sizes>` массив или None \n :meth:`sketch_params <matplotlib.artist.Artist.set_sketch_params>` (scale: float, length: float, randomness: float) \n :meth:`snap <matplotlib.artist.Artist.set_snap>` bool или None \n :meth:`transform <matplotlib.artist.Artist.set_transform>` `.Transform` \n :meth:`url <matplotlib.artist.Artist.set_url>` str \n :meth:`urls <matplotlib.collections.Collection.set_urls>` список строк или None \n :meth:`verts <matplotlib.collections.PolyCollection.set_verts>` список массивов \n :meth:`verts_and_codes <matplotlib.collections.PolyCollection.set_verts_and_codes>` неизвестно \n :meth:`visible <matplotlib.artist.Artist.set_visible>` bool \n :meth:`zorder <matplotlib.artist.Artist.set_zorder>` float \n ================================================================================================= ==============================================================================================================================================================\n\n'
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 или 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.6.0/api/_as_gen/matplotlib.quiver.Barbs.html

Spec-Zone.ru

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