persist_spatial.network_functions

Functions related to the network structure of the co-ordinates in the input data.

Functions

get_distances(→ numpy.ndarray)

Computes an ordered list of the squared distances from the central vertex to the nearest other vertices, in a radial

Module Contents

persist_spatial.network_functions.get_distances(num_wells: int, well_seperation: float, mesh_type: str) → numpy.ndarray

Computes an ordered list of the squared distances from the central vertex to the nearest other vertices, in a radial hexagonal or square grid, with a specified distance between adjacent vertices. To be called upon by compute_persistence.run_persistence()

Parameters:

  • num_wells (int) – Number of vertices to compute distances to.

  • well_separation (float) – Distance between adjacent vertices

  • mesh_type (str) – Should be ‘hexagonal’ or ‘square’.

Returns:

An ordered list of distances.

Return type:

np.ndarray