matplotlib.tri
Функции для работы с неструктурированными треугольными сетками.
- classmatplotlib.tri.Triangulation(x, y, triangles=None, mask=None)[source]
-
Неструктурированная треугольная сетка, состоящая из npoints точек и ntri треугольников. Треугольники могут быть заданы пользователем или автоматически сгенерированы с помощью триангуляции Делоне.
- Параметры:
-
- x, y(npoints,) массив-подобный объект
-
Координаты точек сетки.
- triangles(ntri, 3) массив-подобный объект целых чисел, необязательно
-
Для каждого треугольника — индексы трёх точек, образующих треугольник, упорядоченные против часовой стрелки. Если не указано, вычисляется триангуляция Делоне.
- mask(ntri,) массив-подобный объект булевых значений, необязательно
-
Маска для отбрасывания треугольников.
Примечания
Для того чтобы триангуляция была корректной, она не должна содержать дублирующих точек, треугольников, образованных коллинеарными точками, или перекрывающихся треугольников.
- Атрибуты:
-
- triangles(ntri, 3) массив целых чисел
-
Для каждого треугольника — индексы трёх точек, образующих треугольник, упорядоченные против часовой стрелки. Если нужно учитывать mask, используйте
get_masked_trianglesвместо него. - mask(ntri, 3) массив булевых значений
-
Маска для отбрасывания треугольников.
- is_delaunaybool
-
Является ли триангуляция вычисленной триангуляцией Делоне (если 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 по аргументам и ключевым аргументам, а также оставшиеся аргументы и ключевые аргументы с удалёнными использованными значениями.
Есть два варианта: либо первый аргумент — объект Triangulation, который и возвращается, либо аргументы и ключевые аргументы достаточны для создания нового объекта Triangulation, который и возвращается. В последнем случае см. Triangulation.__init__ для возможных аргументов и ключевых аргументов.
- 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 или массив булевых значений длины ntri
- classmatplotlib.tri.TriContourSet(ax, *args, **kwargs)[source]
-
Наследуется от
ContourSetСоздание и хранение набора линий или областей контура для треугольной сетки.
Этот класс обычно не создаётся напрямую пользователем, а создаётся
tricontourиtricontourf.- Атрибуты:
-
-
ax
Axes -
Объект Axes, в котором отображаются контуры.
-
collections
silent_listобъектовPathCollection -
Объекты
Artist, представляющие контур. Это список объектовPathCollectionдля линий и заполненных контуров. - levelsмассив
-
Значения уровней контура.
- layersмассив
-
Аналогично levels для линий контура; значения между уровнями для заполненных контуров. См.
ContourSet._process_colors.
-
ax
Отображение линий контура или заполненных областей треугольной сетки, в зависимости от того, является ли ключевой аргумент filled ложным (по умолчанию) или истинным.
Первый аргумент инициализатора должен быть объектом
Axes. Остальные аргументы и ключевые аргументы описаны в строке документацииtricontour.
- classmatplotlib.tri.TriFinder(triangulation)[source]
-
Абстрактный базовый класс для классов, используемых для поиска треугольников Triangulation, в которых лежат точки (x, y).
Вместо создания объекта класса, производного от TriFinder, обычно лучше использовать функцию
Triangulation.get_trifinder.Производные классы реализуют __call__(x, y), где x и y — массивоподобные координаты точек, имеющие одинаковую форму.
- classmatplotlib.tri.TrapezoidMapTriFinder(triangulation)[source]
-
Базы:
TriFinderКласс
TriFinder, реализованный с использованием алгоритма карты трапеций из книги "Computational Geometry, Algorithms and Applications", второе издание, авторы М. де Берг, М. ван Кревельд, М. Овермарс и О. Шварцкопф.Треугольник должен быть валидным, т. е. он не должен иметь дублирующих точек, треугольников, образованных коллинеарными точками или перекрывающихся треугольников. Алгоритм обладает некоторой толерантностью к треугольникам, образованным коллинеарными точками, но на этом полагаться не следует.
- classmatplotlib.tri.TriInterpolator(triangulation, z, trifinder=None)[source]
-
Абстрактный базовый класс для классов, используемых для интерполяции на треугольной сетке.
Производные классы реализуют следующие методы:
-
__call__(x, y), где x, y — массивоподобные координаты точек, имеющие одинаковую форму, и возвращающий массив с маской того же размера, содержащий интерполированные значения z. -
gradient(x, y), где x, y — массивоподобные координаты точек, имеющие одинаковую форму, и возвращающий список из 2 массивов с маской того же размера, содержащий 2 производные интерполятора (производные интерполированных значений z по x и y).
-
- classmatplotlib.tri.LinearTriInterpolator(triangulation, z, trifinder=None)[source]
-
Базы:
TriInterpolatorЛинейная интерполяция на треугольной сетке.
Каждый треугольник представляется плоскостью, так что интерполированное значение в точке (x, y) лежит на плоскости треугольника, содержащего (x, y). Интерполированные значения, следовательно, непрерывны по всей сетке, но их первые производные разрывны на ребрах между треугольниками.
- Параметры:
-
-
triangulation
Triangulation -
Треугольная сетка для интерполяции.
- z(npoints,) array-like
-
Массив значений, определённых в узлах сетки, между которыми требуется интерполяция.
-
trifinder
TriFinder, необязательно -
Если это не указано, будет использоваться TriFinder по умолчанию для Triangulation, вызывая
Triangulation.get_trifinder.
-
triangulation
Методы
`__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 принимает значения функции в каждой вершине (предоставленные пользователем) и внутренне вычисляет значения производных, что приводит к гладкой интерполяции. (В качестве специальной функции пользователь также может задать значения производных в каждой вершине, но это не предполагается как общепринятый способ использования.)
- Параметры:
-
-
triangulation
Triangulation -
Треугольная сетка для интерполяции.
- z(npoints,) массив-подобный объект
-
Массив значений, определённых в узлах сетки, между которыми производится интерполяция.
- kind{'min_E', 'geom', 'user'}, необязательный
-
Выбор алгоритма сглаживания для вычисления производных интерполянта (по умолчанию 'min_E'):
- если 'min_E': (по умолчанию) Производные в каждой вершине вычисляются для минимизации энергии изгиба.
- если 'geom': Производные в каждой вершине вычисляются как взвешенная средняя соответствующих нормалей треугольников. Используется для повышения скорости на больших сетках.
- если 'user': Пользователь предоставляет аргумент dz, вычисление не требуется.
-
trifinder
TriFinder, необязательный -
Если не указано, будет использован TriFinder по умолчанию для Triangulation, вызывая
Triangulation.get_trifinder. - dzкортеж массивов-подобных объектов (dzdx, dzdy), необязательный
-
Используется только если kind ='user'. В этом случае dz должен быть предоставлен как (dzdx, dzdy), где dzdx, dzdy — массивы той же формы, что и z, и представляют собой первые производные интерполянта в точках triangulation.
-
triangulation
Примечания
Это техническое примечание, подробно описывающее вычисление кубической интерполяции.
Интерполяция основана на схеме разбиения Клоу-Точера сетки triangulation (проще говоря, каждый треугольник сетки делится на 3 дочерних треугольника, и на каждом дочернем треугольнике интерполирующая функция представляет собой кубический многочлен от 2 координат). Эта техника происходит из анализа метода конечных элементов (МКЭ); используемый элемент — редуцированный элемент Хсиэ-Клоу-Точера (ХКТ). Его базисные функции описаны в [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, "Итеративные методы для оптимизации".
Методы
`__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]
-
Основы:
TriRefinerРавномерное уточнение сетки путём рекурсивного разбиения.
- Параметры:
-
-
triangulation
Triangulation -
Оборачиваемая триангуляция (для уточнения)
-
triangulation
- refine_field(z, triinterpolator=None, subdiv=3)[source]
-
Уточнение поля, определённого на обёрнутой триангуляции.
- Параметры:
-
- z(npoints,) array-like
-
Значения поля для уточнения, определённые в узлах обёрнутой триангуляции. (
n_points— количество точек в исходной триангуляции) -
triinterpolator
TriInterpolator, необязательно -
Интерполятор, используемый для интерполяции поля. Если не указан, будет использован
CubicTriInterpolator. - subdivint, по умолчанию: 3
-
Уровень рекурсии для разбиения. Каждый треугольник делится на
4**subdivдочерних треугольников.
- Возвращаемые значения:
-
-
refi_tri
Triangulation -
Полученная уточнённая триангуляция.
- refi_zОдномерный массив длиной: количество узлов refi_tri.
-
Полученное интерполированное поле (в узлах refi_tri).
-
refi_tri
- refine_triangulation(return_tri_index=False, subdiv=3)[source]
-
Вычисление равномерно уточнённой триангуляции refi_triangulation обёрнутой
triangulation.Эта функция уточняет обёрнутую триангуляцию, разбивая каждый треугольник на 4 дочерних подтреугольника, построенных на узлах середины сторон, с рекурсией subdiv раз. В итоге каждый треугольник делится на
4**subdivдочерних треугольников.- Параметры:
-
- return_tri_indexbool, по умолчанию: False
-
Возвращать ли таблицу индексов, указывающую индекс родительского треугольника для каждой точки.
- subdivint, по умолчанию: 3
-
Уровень рекурсии для разбиения. Каждый треугольник делится на
4**subdivдочерних треугольников; таким образом, по умолчанию получается 64 уточнённых подтреугольника для каждого треугольника исходной триангуляции.
- Возвращаемые значения:
-
-
refi_triangulation
Triangulation -
Уточнённая триангуляция.
- found_indexмассив целых чисел
-
Индекс исходной триангуляции, содержащий треугольник для каждой точки refi_triangulation. Возвращается только если return_tri_index установлено в True.
-
refi_triangulation
- classmatplotlib.tri.TriAnalyzer(triangulation)[source]
-
Определение основных инструментов для анализа и улучшения треугольной сетки.
Объект TriAnalyzer содержит объект
Triangulationи предоставляет основные инструменты для анализа сетки и её улучшения.- Параметры:
-
-
triangulation
Triangulation -
Анализируемая треугольная сетка.
-
triangulation
- Атрибуты:
-
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.7.5/api/tri_api.html