{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The tessellation is computed using the Qhull library " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "Qhull library" } ], "url": "http://www.qhull.org/", "title": "" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Unless you pass in the Qhull option \"QJ\", Qhull does not guarantee that each input point appears as a vertex in the Delaunay triangulation. Omitted points are listed in the " }, { "__type": "CrossRef", "__tag": 4002, "value": "coplanar", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "coplanar" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " attribute." } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "QhullError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Raised when Qhull encounters an error condition, such as geometrical degeneracy when options to resolve are not enabled." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Raised if an incompatible array is given as input." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Delaunay tessellation in N dimensions." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "points", "annotation": "ndarray of double, shape (npoints, ndim)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Coordinates of input points." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "simplices", "annotation": "ndarray of ints, shape (nsimplex, ndim+1)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Indices of the points forming the simplices in the triangulation. For 2-D, the points are oriented counterclockwise." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "neighbors", "annotation": "ndarray of ints, shape (nsimplex, ndim+1)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Indices of neighbor simplices for each simplex. The kth neighbor is opposite to the kth vertex. For simplices at the boundary, -1 denotes no neighbor." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "equations", "annotation": "ndarray of double, shape (nsimplex, ndim+2)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "[normal, offset] forming the hyperplane equation of the facet on the paraboloid (see " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "Qhull documentation" } ], "url": "http://www.qhull.org/", "title": "" }, { "__type": "Text", "__tag": 4046, "value": " for more)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "paraboloid_scale, paraboloid_shift", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Scale and shift for the extra paraboloid dimension (see " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "Qhull documentation" } ], "url": "http://www.qhull.org/", "title": "" }, { "__type": "Text", "__tag": 4046, "value": " for more)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "transform", "annotation": "ndarray of double, shape (nsimplex, ndim+1, ndim)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Affine transform from " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " to the barycentric coordinates " }, { "__type": "InlineCode", "__tag": 4051, "value": "c" }, { "__type": "Text", "__tag": 4046, "value": ". This is defined by " } ] }, { "__type": "Code", "__tag": 4050, "value": "T c = x - r", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "At vertex " }, { "__type": "InlineCode", "__tag": 4051, "value": "j" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "c_j = 1" }, { "__type": "Text", "__tag": 4046, "value": " and the other coordinates zero." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For simplex " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "transform[i,:ndim,:ndim]" }, { "__type": "Text", "__tag": 4046, "value": " contains inverse of the matrix " }, { "__type": "InlineCode", "__tag": 4051, "value": "T" }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineCode", "__tag": 4051, "value": "transform[i,ndim,:]" }, { "__type": "Text", "__tag": 4046, "value": " contains the vector " }, { "__type": "InlineCode", "__tag": 4051, "value": "r" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the simplex is degenerate or nearly degenerate, its barycentric transform contains NaNs." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "vertex_to_simplex", "annotation": "ndarray of int, shape (npoints,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Lookup array, from a vertex, to some simplex which it is a part of. If qhull option \"Qc\" was not specified, the list will contain -1 for points that are not vertices of the tessellation." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "convex_hull", "annotation": "ndarray of int, shape (nfaces, ndim)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Vertices of facets forming the convex hull of the point set. The array contains the indices of the points belonging to the (N-1)-dimensional facets that form the convex hull of the triangulation." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Computing convex hulls via the Delaunay triangulation is inefficient and subject to increased numerical instability. Use " }, { "__type": "CrossRef", "__tag": 4002, "value": "ConvexHull", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial._qhull:ConvexHull" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " instead." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "coplanar", "annotation": "ndarray of int, shape (ncoplanar, 3)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Indices of coplanar points and the corresponding indices of the nearest facet and the nearest vertex. Coplanar points are input points which were " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "not" } ] }, { "__type": "Text", "__tag": 4046, "value": " included in the triangulation due to numerical precision issues." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If option \"Qc\" is not specified, this list is not computed." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.12.0" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "vertex_neighbor_vertices", "annotation": "tuple of two ndarrays of int; (indptr, indices)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Neighboring vertices of vertices. The indices of neighboring vertices of vertex " }, { "__type": "InlineRole", "__tag": 4003, "value": "k", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " are " }, { "__type": "InlineCode", "__tag": 4051, "value": "indices[indptr[k]:indptr[k+1]]" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "furthest_site", "annotation": "", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "True if this was a furthest site triangulation and False if not." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.4.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "points", "annotation": "ndarray of floats, shape (npoints, ndim)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Coordinates of points to triangulate" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "furthest_site", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to compute a furthest-site Delaunay triangulation. Default: False" } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.12.0" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "incremental", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Allow adding new points incrementally. This takes up some additional resources." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "qhull_options", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Additional options to pass to Qhull. See Qhull manual for details. Option \"Qt\" is always enabled. Default:\"Qbb Qc Qz Qx Q12\" for ndim > 4 and \"Qbb Qc Qz Q12\" otherwise. Incremental mode omits \"Qz\"." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.12.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.9" } ] } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/spatial/_qhull.cpython-314-x86_64-linux-gnu.so", "item_line": null, "item_type": "class", "aliases": [ "scipy.spatial.Delaunay" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Triangulation of a set of points:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\npoints = np.array([[0, 0], [0, 1.1], [1, 0], [1, 1]])\nfrom scipy.spatial import Delaunay\ntri = Delaunay(points)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nWe can plot it:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import matplotlib.pyplot as plt\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "plt.triplot(points[:,0], points[:,1], tri.simplices)\nplt.plot(points[:,0], points[:,1], 'o')\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "plt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-cbfad6cb9e7eb4c3.png" } }, { "__type": "Text", "__tag": 4046, "value": "\nPoint indices and coordinates for the two triangles forming the\ntriangulation:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "tri.simplices\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nNote that depending on how rounding errors go, the simplices may\nbe in a different order than above.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "points[tri.simplices]\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nTriangle 0 is the only neighbor of triangle 1, and it's opposite to\nvertex 1 of triangle 1:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "tri.neighbors[1]\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "points[tri.simplices[1,1]]\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nWe can find out which triangle points are in:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "p = np.array([(0.1, 0.2), (1.5, 0.5), (0.5, 1.05)])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "tri.find_simplex(p)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nThe returned integers in the array are the indices of the simplex the\ncorresponding point is in. If -1 is returned, the point is in no simplex.\nBe aware that the shortcut in the following example only works correctly\nfor valid points as invalid points result in -1 which is itself a valid\nindex for the last simplex in the list.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "p_valids = np.array([(0.1, 0.2), (0.5, 1.05)])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "tri.simplices[tri.find_simplex(p_valids)]\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nWe can also compute barycentric coordinates in triangle 1 for\nthese points:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "b = tri.transform[1,:2].dot(np.transpose(p - tri.transform[1,2]))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.c_[np.transpose(b), 1 - b.sum(axis=0)]\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nThe coordinates for the first point are all positive, meaning it\nis indeed inside the triangle. The third point is on an edge,\nhence its null third coordinate." } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "points", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "furthest_site", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "incremental", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "qhull_options", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "Delaunay" }, "references": null, "qa": "scipy.spatial._qhull:Delaunay", "arbitrary": [], "local_refs": [ "convex_hull", "coplanar", "equations", "furthest_site", "incremental", "neighbors", "paraboloid_scale", "paraboloid_shift", "points", "qhull_options", "simplices", "transform", "vertex_neighbor_vertices", "vertex_to_simplex" ] }