EnclosingSimplexAlgorithm

class EnclosingSimplexAlgorithm(*args)

Point location algorithm.

Base class to define an algorithm to find simplices containing a list of points.

Available constructors:
EnclosingSimplexAlgorithm(vertices, simplices)
Parameters:
vertices : Sample

Vertices.

simplices : IndicesCollection

Simplices.

Notes

Two algorithms can be selected in any dimension:

Two algorithms are specific to 1D meshes, and much more efficient:

It is recommended to use derived classes in order to select the best algorithm according to your data. If you create a generic EnclosingSimplexAlgorithm, here is how the derived class is selected:

Examples

>>> import openturns as ot
>>> mesher = ot.IntervalMesher([5, 10])
>>> lowerbound = [0.0, 0.0]
>>> upperBound = [2.0, 4.0]
>>> interval = ot.Interval(lowerbound, upperBound)
>>> mesh = mesher.build(interval)
>>> locator = ot.EnclosingSimplexAlgorithm(mesh.getVertices(), mesh.getSimplices())
>>> simplex = locator.query([0.1, 0.2])

Methods

getClassName() Accessor to the object’s name.
getId() Accessor to the object’s id.
getImplementation(*args) Accessor to the underlying implementation.
getName() Accessor to the object’s name.
query(*args) Get the index of the enclosing simplex of the given point.
setName(name) Accessor to the object’s name.
setVerticesAndSimplices(vertices, simplices) Rebuild a new data structure for these vertices and simplices.
getSimplices  
getVertices  
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

getClassName()

Accessor to the object’s name.

Returns:
class_name : str

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns:
id : int

Internal unique identifier.

getImplementation(*args)

Accessor to the underlying implementation.

Returns:
impl : Implementation

The implementation class.

getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.

query(*args)

Get the index of the enclosing simplex of the given point.

Available usages:

query(point)

query(sample)

Parameters:
point : sequence of float

Given point.

sample : 2-d sequence of float

Given points.

Returns:
index : int

If point is enclosed in a simplex, return its index; otherwise return an int which is at least greater than the number of simplices.

indices : openturns.Indices

Index of enclosing simplex of each point of the sample. If there is no enclosing simplex, value is an int which is at least greater than the number of simplices.

setName(name)

Accessor to the object’s name.

Parameters:
name : str

The name of the object.

setVerticesAndSimplices(vertices, simplices)

Rebuild a new data structure for these vertices and simplices.

Parameters:
vertices : Sample

Vertices.

simplices : IndicesCollection

Simplices.