template_bank_generator_HM.TemplateBank.get_grid_index

Back to Class page

Summary

Get the multiindex of the gridpoint that most closely matches a point. Assumes that the grid is rectangular, but not necessarily regular.

Signature

def get_grid_index(grid_axes, point)

Input variables

Name	Type	Default	Description
grid_axes			list of arrays with the coordinates of the gridpoints, one for each grid dimension.
point			array with the coordinates of the point we want to match

Output variables

Return annotation	Docstring type	Description
None

Docstring

Get the multiindex of the gridpoint that most closely
matches a point. Assumes that the grid is rectangular, but not
necessarily regular.
:param grid_axes: list of arrays with the coordinates of the
                  gridpoints, one for each grid dimension.
:param point: array with the coordinates of the point we want to match