RegularGridEnclosingSimplex

class RegularGridEnclosingSimplex(*args)

Specialized point location algorithm on RegularGrid.

Available constructors:

RegularGridEnclosingSimplex(regularGrid)

Parameters:
regularGridRegularGrid

Points

See also

EnclosingSimplexAlgorithm

Examples

>>> import openturns as ot
>>> grid = ot.RegularGrid(0, 0.1, 20)
>>> locator = ot.RegularGridEnclosingSimplex(grid)
>>> simplex = locator.query([0.12])

Methods

getBarycentricCoordinatesEpsilon()

Accessor to the tolerance for membership test.

getClassName()

Accessor to the object's name.

getId()

Accessor to the object's id.

getName()

Accessor to the object's name.

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.

queryScalar(*args)

Accessor to the enclosing simplex index.

setBarycentricCoordinatesEpsilon(epsilon)

Accessor to the tolerance for membership test.

setName(name)

Accessor to the object's name.

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)
getBarycentricCoordinatesEpsilon()

Accessor to the tolerance for membership test.

Returns:
epsilonfloat

Tolerance for the membership. A point is in a simplex if its barycentric coordinates \xi_i are all in [-\varepsilon,1+\varepsilon] and \sum_{i=1}^d\xi_i\in[-\varepsilon,1+\varepsilon].

getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getId()

Accessor to the object’s id.

Returns:
idint

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
idint

Internal unique identifier.

getSimplices()

Collection of simplex accessor.

Returns:
simplicesIndicesCollection

Collection of simplices.

getVertices()

Collection of vertices accessor.

Returns:
verticesSample

Collection of points.

getVisibility()

Accessor to the object’s visibility state.

Returns:
visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:
hasVisibleNamebool

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:
pointsequence of float

Given point.

sample2-d sequence of float

Given points.

Returns:
indexint

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

indicesIndices

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.

queryScalar(*args)

Accessor to the enclosing simplex index.

Available usages:

queryScalar(x)

queryScalar(point)

Parameters:
xfloat

Given point.

pointsequence of float

Sequence of 1D points.

Returns:
indexint

If x is inside RegularGrid bounds, return the index of the interval in which it is contained; otherwise return an int which is at least greater than the number of intervals.

indicesIndices

Index of the enclosing simplex of the given 1D points.

setBarycentricCoordinatesEpsilon(epsilon)

Accessor to the tolerance for membership test.

Parameters:
epsilonfloat

Tolerance for the membership. A point is in a simplex if its barycentric coordinates \xi_i are all in [-\varepsilon,1+\varepsilon] and \sum_{i=1}^d\xi_i\in[-\varepsilon,1+\varepsilon].

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
idint

Internal unique identifier.

setVerticesAndSimplices(vertices, simplices)

Rebuild a new data structure for these vertices and simplices.

Parameters:
verticesSample

Vertices.

simplicesIndicesCollection

Simplices.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visiblebool

Visibility flag.