check_point_clouds

gtda.utils.check_point_clouds(X, distance_matrix=False, **kwargs)

Input validation on an array or list representing a collection of point clouds or distance matrices.

The input is checked to be either a single 3D array using a single call to check_array, or a list of 2D arrays by calling check_array on each entry. In the latter case, warnings are issued when not all point clouds are in the same Euclidean space.

Conversions and copies may be triggered as per check_list_of_arrays.

Parameters

• X (object) – Input object to check / convert.

• distance_matrix (bool, optional, default: False) – Whether the input represents a collection of distance matrices or of concrete point clouds in Euclidean space. In the first case, entries are allowed to be infinite unless otherwise specified in kwargs.

• kwargs – Keyword arguments accepted by check_list_of_arrays.

Returns

Xnew – The converted and validated object.

Return type

ndarray or list