Spec-Zone.ru › Matplotlib 3.6

matplotlib.tri

Функции для неструктурированных треугольных сеток.

classmatplotlib.tri.Triangulation(x, y, triangles=None, mask=None)[source]

Неструктурированная треугольная сетка, состоящая из npoints точек и ntri треугольников. Треугольники могут быть указаны пользователем или автоматически сгенерированы с помощью триангуляции Делоне.

Параметры:
x, y(npoints,) array-like

Координаты точек сетки.

triangles(ntri, 3) array-like целых чисел, необязательно

Для каждого треугольника индексы трёх точек, образующих треугольник, упорядоченные против часовой стрелки. Если не указано, рассчитывается триангуляция Делоне.

mask(ntri,) array-like булевых значений, необязательно

Какие треугольники скрыты (маскированы).

Примечания

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

Атрибуты:
triangles(ntri, 3) массив целых чисел

Для каждого треугольника индексы трёх точек, образующих треугольник, упорядоченные против часовой стрелки. Если нужно учесть mask, используйте get_masked_triangles вместо этого.

mask(ntri,) массив булевых значений

Скрытые (маскированные) треугольники.

is_delaunaybool

Является ли Triangulation вычисленной триангуляцией Делоне (если triangles не был указан) или нет.

calculate_plane_coefficients(z)[source]

Вычисляет коэффициенты уравнения плоскости для всех нескрытых треугольников из координат точек (x, y) и заданного массива z формы (npoints). Возвращаемый массив имеет форму (npoints, 3) и позволяет вычислить значение z в позиции (x, y) в треугольнике tri с помощью z = array[tri, 0] * x  + array[tri, 1] * y + array[tri, 2].

propertyedges

Возвращает целочисленный массив формы (nedges, 2), содержащий все рёбра нескрытых треугольников.

Каждая строка определяет ребро по индексу начальной и конечной точки. Каждое ребро появляется только один раз, т.е. для ребра между точками i и j будет либо (i, j), либо (j, i).

get_cpp_triangulation()[source]

Возвращает базовую C++ Triangulation-объект, создавая её, если необходимо.

staticget_from_args_and_kwargs(*args, **kwargs)[source]

Возвращает объект Triangulation из args и kwargs, и оставшиеся args и kwargs со значениями, которые были использованы, удалены.

Есть два варианта: либо первый аргумент – объект Triangulation, в этом случае он возвращается, либо args и kwargs достаточно для создания нового Triangulation для возврата. В последнем случае, см. Triangulation.__init__ для возможных args и kwargs.

get_masked_triangles()[source]

Возвращает массив треугольников с учётом маски.

get_trifinder()[source]

Возвращает значение по умолчанию matplotlib.tri.TriFinder этой триангуляции, создавая его при необходимости. Это позволяет легко использовать один и тот же объект TriFinder.

propertyneighbors

Возвращает целочисленный массив формы (ntri, 3), содержащий соседние треугольники.

Для каждого треугольника индексы трёх треугольников, которые разделяют общие рёбра, или -1, если такого соседнего треугольника нет. neighbors[i, j] - это треугольник, который является соседом ребра от точки с индексом triangles[i, j] до точки с индексом triangles[i, (j+1)%3].

set_mask(mask)[source]

Устанавливает или очищает маску.

Параметры:
maskNone или массив bool длины ntri
classmatplotlib.tri.TriContourSet(ax, *args, **kwargs)[source]

Базовый класс: ContourSet

Создаёт и хранит набор контурных линий или залитых областей для треугольной сетки.

Этот класс обычно не создаётся пользователем напрямую, но используется tricontour и tricontourf.

Атрибуты:
axAxes

Объект Axes, в котором нарисованы контуры.

collectionssilent_list объектов PathCollection

Объекты Artist, представляющие контуры. Это список объектов PathCollection для линий и залитых контуров.

levelsмассив

Значения контурных уровней.

layersмассив

То же, что и levels для контурных линий; половина расстояния между уровнями для залитых контуров. См. ContourSet._process_colors.

Рисует контурные линии или залитые области треугольной сетки, в зависимости от того, установлено ли ключевое слово arg filled в False (по умолчанию) или True.

Первый аргумент инициализатора должен быть объектом Axes. Остальные аргументы и ключевые слова описаны в документации для tricontour.

END_OF_DOCUMENT_MARKER ```
классmatplotlib.tri.TriFinder(triangulation)[source]

Абстрактный базовый класс для классов, используемых для поиска треугольников Triangulation, в которых лежат точки (x, y).

Вместо создания объекта класса, производного от TriFinder, обычно лучше использовать функцию Triangulation.get_trifinder.

Производные классы реализуют __call__(x, y), где x и y — массивоподобные координаты точек, имеющие одинаковую форму.

классmatplotlib.tri.TrapezoidMapTriFinder(triangulation)[source]

Базируется на TriFinder

TriFinder класс, реализованный с использованием алгоритма карты трапеций из книги «Вычислительная геометрия, алгоритмы и приложения», второе издание, авторы М. де Берг, М. ван Кревэл, М. Овермарс и О. Шварцкопф.

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

классmatplotlib.tri.TriInterpolator(triangulation, z, trifinder=None)[source]

Абстрактный базовый класс для классов, используемых для интерполяции на треугольной сетке.

Производные классы реализуют следующие методы:

  • __call__(x, y), где x, y — массивоподобные координаты точек с одинаковой формой, и который возвращает массив с маской той же формы, содержащий интерполированные значения z.
  • gradient(x, y), где x, y — массивоподобные координаты точек с одинаковой формой, и который возвращает список из 2 массивов с маской той же формы, содержащих 2 производные интерполятора (производные интерполированных значений z по x и y).
классmatplotlib.tri.LinearTriInterpolator(triangulation, z, trifinder=None)[source]

Базируется на TriInterpolator

Линейная интерполяция на треугольной сетке.

Каждый треугольник представлен плоскостью, так что интерполированное значение в точке (x, y) лежит на плоскости треугольника, содержащего (x, y). Интерполированные значения, следовательно, непрерывны по всей треугольной сетке, но их первые производные разрывны на границах между треугольниками.

Параметры:
triangulationTriangulation

Треугольная сетка для интерполяции.

z(npoints,) array-like

Массив значений, определённых в узлах сетки, между которыми необходимо выполнить интерполяцию.

trifinderTriFinder, необязательно

Если это не указано, будет использоваться дефолтный TriFinder треугольной сетки, вызывая Triangulation.get_trifinder.

Методы

`__call__` (x, y)

(Возвращает интерполированные значения в точках (x, y).)

`gradient` (x, y)

(Возвращает интерполированные производные в точках (x, y).)

gradient(x, y)[source]

Возвращает список из 2 массивов с маской, содержащих интерполированные производные в заданных точках (x, y).

Параметры:
x, yarray-like

Координаты x и y одинаковой формы и произвольного числа измерений.

Возвращает:
dzdx, dzdynp.ma.array

2 массива с маской той же формы, что и x и y; значения, соответствующие точкам (x, y) вне треугольной сетки, скрыты маской. Первый возвращаемый массив содержит значения \(\frac{\partial z}{\partial x}\), а второй — значения \(\frac{\partial z}{\partial y}\).

classmatplotlib.tri.CubicTriInterpolator(triangulation, z, kind='min_E', trifinder=None, dz=None)[source]

Bases: TriInterpolator

Кубический интерполятор на треугольной сетке.

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

CubicTriInterpolator принимает значение функции в каждой вершине — предоставленное пользователем — и внутренне вычисляет значение производных, что приводит к гладкой интерполяции. (В качестве специальной функции пользователь также может задать значение производных в каждой вершине, но это не предполагается как распространённое использование.)

Параметры:
triangulationTriangulation

Треугольная сетка, по которой выполняется интерполяция.

z(npoints,) массив

Массив значений, определённых в узлах сетки, между которыми нужно выполнить интерполяцию.

kind{'min_E', 'geom', 'user'}, необязательно

Выбор алгоритма сглаживания для вычисления производных интерполянта (по умолчанию 'min_E'):

  • если 'min_E': (по умолчанию) Производные в каждой вершине вычисляются для минимизации энергии изгиба.
  • если 'geom': Производные в каждой вершине вычисляются как взвешенное среднее соответствующих нормалей треугольника. Используется для оптимизации скорости (большие сетки).
  • если 'user': Пользователь предоставляет аргумент dz, вычисление не требуется.
trifinderTriFinder, необязательно

Если не указано, по умолчанию используется TriFinder треугольной сетки, вызывая Triangulation.get_trifinder.

dzкортеж массивов (dzdx, dzdy), необязательно

Используется только если kind ='user'. В этом случае dz должен быть предоставлен как (dzdx, dzdy), где dzdx, dzdy — массивы такой же формы, как z, и представляют собой первые производные интерполянта в точках triangulation.

Примечания

Это примечание немного техническое и описывает, как вычисляется кубическая интерполяция.

Интерполяция основана на схеме подразделения Клоуза-Точера сетки triangulation (проще говоря, каждый треугольник сетки будет разделен на 3 дочерних треугольника, и на каждом дочернем треугольнике интерполирующая функция является кубическим многочленом от двух координат). Этот метод происходит из анализа метода конечных элементов (МКЭ); используемый элемент — это сокращённый элемент Хси-Клоу-Точера (ХКТ). Его функции формы описаны в [1]. Собраная функция гарантированно является C1-гладкой, т. е. она непрерывна и её первые производные также непрерывны (это легко показать внутри треугольников, но это также верно при пересечении рёбер).

В случае по умолчанию (kind ='min_E'), интерполянт минимизирует энергию кривизны в функциональном пространстве, сгенерированном функциями формы элемента ХКТ — с заданными значениями, но произвольными производными в каждой вершине. Минимизируемый функционал — это интеграл так называемой полной кривизны (реализация основана на алгоритме из [2] — разреженный решатель PCG):

\[E(z) = \frac{1}{2} \int_{\Omega} \left( \left( \frac{\partial^2{z}}{\partial{x}^2} \right)^2 + \left( \frac{\partial^2{z}}{\partial{y}^2} \right)^2 + 2\left( \frac{\partial^2{z}}{\partial{y}\partial{x}} \right)^2 \right) dx\,dy\]

Если пользователь выберет kind ='geom', используется простое геометрическое приближение (взвешенное среднее векторов нормалей треугольника), что может улучшить скорость на очень больших сетках.

Список литературы

[1]

Michel Bernadou, Kamal Hassan, "Basis functions for general Hsieh-Clough-Tocher triangles, complete or reduced.", International Journal for Numerical Methods in Engineering, 17(5):784 - 789. 2.01.

[2]

C.T. Kelley, "Iterative Methods for Optimization".

Методы

`__call__` (x, y)

(Возвращает интерполированные значения в точках (x, y).)

`gradient` (x, y)

(Возвращает интерполированные производные в точках (x, y).)

gradient(x, y)[source]

Возвращает список из 2-х замаскированных массивов, содержащих интерполированные производные в заданных точках (x, y).

Параметры:
x, yмассив-подобные

Координаты x и y той же формы и любого числа измерений.

Возвращает:
dzdx, dzdynp.массив

2 замаскированных массива той же формы, что и x и y; значения, соответствующие точкам (x, y) вне треугольной сетки, маскируются. Первый возвращаемый массив содержит значения \(\frac{\partial z}{\partial x}\), а второй — значения \(\frac{\partial z}{\partial y}\).

classmatplotlib.tri.TriRefiner(triangulation)[source]

Абстрактный базовый класс для классов, реализующих уточнение сетки.

TriRefiner инкапсулирует объект Triangulation и предоставляет инструменты для уточнения сетки и интерполяции.

Производные классы должны реализовать:

  • refine_triangulation(return_tri_index=False, **kwargs) , где необязательные ключевые аргументы kwargs определены в каждой конкретной реализации TriRefiner, и которая возвращает:

    • уточнённую треугольную сетку,
    • необязательно (в зависимости от return_tri_index), для каждой точки уточнённой треугольной сетки: индекс треугольника исходной треугольной сетки, к которому она принадлежит.
  • refine_field(z, triinterpolator=None, **kwargs), где:

    • z массив значений поля (для уточнения), определённых в узлах исходной треугольной сетки,
    • triinterpolator — необязательный TriInterpolator,
    • другие необязательные ключевые аргументы kwargs определены в каждой конкретной реализации TriRefiner;

    и которая возвращает (в виде кортежа) уточнённую треугольную сетку и интерполированные значения поля в узлах уточнённой треугольной сетки.

classmatplotlib.tri.UniformTriRefiner(triangulation)[source]

Bases: TriRefiner

Равномерное уточнение сетки путём рекурсивного деления.

Parameters:
triangulationTriangulation

Оборачиваемая триангуляция (для уточнения)

refine_field(z, triinterpolator=None, subdiv=3)[source]

Уточнить поле, определённое на обёрнутой триангуляции.

Parameters:
z(npoints,) массив

Значения поля для уточнения, определённые в узлах обёрнутой триангуляции. (n_points — количество точек в исходной триангуляции)

triinterpolatorTriInterpolator, необязательно

Интерполятор, используемый для интерполяции поля. Если не указан, используется CubicTriInterpolator.

subdivint, по умолчанию: 3

Уровень рекурсии для деления. Каждый треугольник делится на 4**subdiv дочерних треугольников.

Returns:
refi_triTriangulation

Возвращаемая уточнённая триангуляция.

refi_zОдномерный массив длиной: количество узлов refi_tri.

Возвращаемое интерполированное поле (в узлах refi_tri).

refine_triangulation(return_tri_index=False, subdiv=3)[source]

Вычислить равномерно уточнённую триангуляцию refi_triangulation оборачиваемой triangulation.

Эта функция уточняет оборачиваемую триангуляцию, деля каждый родительский треугольник на 4 дочерних подтреугольника, построенных на средних узлах рёбер, рекурсивно subdiv раз. В итоге каждый треугольник делится на 4**subdiv дочерних треугольников.

Parameters:
return_tri_indexbool, по умолчанию: False

Возвращать ли таблицу индексов, указывающую индекс родительского треугольника каждой точки.

subdivint, по умолчанию: 3

Уровень рекурсии для деления. Каждый треугольник делится на 4**subdiv дочерних треугольников; таким образом, значение по умолчанию приводит к 64 уточнённым подтреугольникам для каждого треугольника исходной триангуляции.

Returns:
refi_triangulationTriangulation

Уточнённая триангуляция.

found_indexцелочисленный массив

Индекс исходной триангуляции, содержащей треугольник, для каждой точки refi_triangulation. Возвращается только если return_tri_index установлено в True.

classmatplotlib.tri.TriAnalyzer(triangulation)[source]

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

Объект TriAnalyzer инкапсулирует объект Triangulation и предоставляет основные инструменты для анализа сетки и улучшения её качества.

Параметры:
triangulationTriangulation

Анализируемая инкапсулированная треугольная сетка.

Атрибуты:
scale_factors

Коэффициенты для масштабирования треугольной сетки в единичный квадрат.

circle_ratios(rescale=True)[source]

Возвращает меру плоской формы треугольников в сетке.

Отношение радиуса вписанной окружности к радиусу описанной окружности является широко используемым показателем плоской формы треугольника. Оно всегда <= 0.5 и == 0.5 только для равносторонних треугольников. Коэффициенты окружностей, меньшие 0,01, указывают на очень плоские треугольники.

Для того, чтобы избежать нежелательно низких значений из-за разницы в масштабе между осями, треугольную сетку можно предварительно масштабировать для размещения внутри единичного квадрата с помощью scale_factors (только если rescale равно True, что является его значением по умолчанию).

Параметры:
rescalebool, по умолчанию: True

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

Возвращаемое значение:
маска массива

Отношение радиуса вписанной окружности к радиусу описанной окружности для каждого «масштабированного» треугольника инкапсулированной треугольной сетки. Значения, соответствующие замаскированным треугольникам, маскируются.

get_flat_tri_mask(min_circle_ratio=0.01, rescale=True)[source]

Удаляет избыточно плоские граничные треугольники из треугольной сетки.

Возвращает маску new_mask, которая позволяет очистить инкапсулированную треугольную сетку от её плоских треугольников, расположенных на границе (согласно их circle_ratios()). Эта маска предназначена для последующего применения к треугольной сетке с помощью Triangulation.set_mask. new_mask является расширением начальной маски треугольной сетки в том смысле, что первоначально замаскированный треугольник остаётся замаскированным.

Массив new_mask вычисляется рекурсивно; на каждом шаге плоские треугольники удаляются только в том случае, если они разделяют сторону с текущей границей сетки. Таким образом, не создаются новые отверстия в области, заданной треугольной сеткой.

Параметры:
min_circle_ratiofloat, по умолчанию: 0.01

Треугольники границы с отношением радиусов вписанной и описанной окружностей r/R будут удалены, если r/R < min_circle_ratio.

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

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

Возвращаемое значение:
массив bool

Маска для применения к инкапсулированной треугольной сетке. Все первоначально замаскированные треугольники остаются замаскированными в new_mask.

Примечания

Логика этой функции заключается в том, что триангуляция Делоне — для неупорядоченного набора точек — иногда содержит почти плоские треугольники на границе, что приводит к артефактам на графиках (особенно при контурировании с высоким разрешением). С замаскированными элементами new_mask, инкапсулированная треугольная сетка больше не будет содержать незамаскированных граничных треугольников с коэффициентом окружности меньше min_circle_ratio, что улучшает качество сетки для последующих графиков или интерполяции.

propertyscale_factors

Коэффициенты для масштабирования треугольной сетки в единичный квадрат.

Возвращаемое значение:
(float, float)

Коэффициенты масштабирования (kx, ky), такие, что треугольная сетка [triangulation.x * kx, triangulation.y * ky] точно помещается внутри единичного квадрата.

© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.6.0/api/tri_api.html

Spec-Zone.ru

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