starling.structure.coordinates.compare_distance_matrices
- compare_distance_matrices(original_distance_matrix, coords, return_abs_diff=True)[source]
Function to compare the original distance matrix with the computed distance matrix.
- Parameters:
original_distance_matrix (np.ndarray) – The original distance matrix.
coords (np.ndarray) – The computed 3D coordinates.
return_abs_diff (bool) – Whether to return the absolute difference between the original and computed distance matrices, or the signed difference (original - computed), by default True.
- Returns:
A 2-element tuple of np.ndarray:
[0]: The distance matrix computed from the 3D coordinates.
[1]: The absolute difference between the original and computed distance matrices.
- Return type: