NaiveEnclosingSimplex

class NaiveEnclosingSimplex(*args)

Naive implementation of point location.

This class implements a naive implementation of point location, by looking into all its simplices. It works well for convex domains, but may be slow otherwise.

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

Vertices.

simplices : IndicesCollection

Simplices.

Notes

In order to speed-up point location, a first pass is performed by looping over all simplices containing the nearest point. If query point is not found in those simplices, then all simplices are looked for.

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.NaiveEnclosingSimplex(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.
getName() Accessor to the object’s name.
getNearestNeighbourAlgorithm() Accessor to the nearest neighbour algorithm.
getShadowedId() Accessor to the object’s shadowed id.
getSimplices() Collection of simplex accessor.
getVertices() Collection of vertices accessor.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
query(*args) Get the index of the enclosing simplex of the given point.
setName(name) Accessor to the object’s name.
setNearestNeighbourAlgorithm(nearestNeighbour) Accessor to the nearest neighbour algorithm.
setShadowedId(id) Accessor to the object’s shadowed id.
setVerticesAndSimplices(vertices, simplices) Rebuild a new data structure for these vertices and simplices.
setVisibility(visible) Accessor to the object’s visibility state.
__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.

getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.

getNearestNeighbourAlgorithm()

Accessor to the nearest neighbour algorithm.

Returns:
nearestNeighbour : NearestNeighbourAlgorithm

Algorithm used during first pass to locate the nearest point.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
id : int

Internal unique identifier.

getSimplices()

Collection of simplex accessor.

Returns:
simplices : IndicesCollection

Collection of simplices.

getVertices()

Collection of vertices accessor.

Returns:
vertices : Sample

Collection of points.

getVisibility()

Accessor to the object’s visibility state.

Returns:
visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:
hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:
hasVisibleName : bool

True if the name is not empty and not the default one.

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.

setNearestNeighbourAlgorithm(nearestNeighbour)

Accessor to the nearest neighbour algorithm.

Parameters:
nearestNeighbour : NearestNeighbourAlgorithm

Algorithm to use during first pass to locate the nearest point.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
id : int

Internal unique identifier.

setVerticesAndSimplices(vertices, simplices)

Rebuild a new data structure for these vertices and simplices.

Parameters:
vertices : Sample

Vertices.

simplices : IndicesCollection

Simplices.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visible : bool

Visibility flag.