perturbopy.postproc.utils.lattice.convert_path2point

perturbopy.postproc.utils.lattice.convert_path2point(path_coord, point_array, path_array, atol=1e-05, rtol=0.01, nearest=True)

Method to find the point corresponding to a path coordinate

Parameters:

• path_coord (float) – The path coordinate to be converted to a point

• point_array (array_like) – A set of points

• path_array (array_like) – The path corresponding to the points

• atol (float, optional) – The absolute tolerance between the path coordinate to locate and the matching path coordinates

• rtol (float, optional) – The relative tolerance between the path coordinate to locate and the matching path coordinates

• nearest (bool, optional) – If True, only the nearest path coordinate, or coordinates in the case of repeats, are returned (even if other points are within the absolute and relative tolerance)

Returns:

point_array – The reciprocal space point(s) of the corresponding path coordinate

Return type:

list