geoana.utils.check_xyz_dim#

geoana.utils.check_xyz_dim(xyz, dim=3, dtype=<class 'float'>)#

Checks if the arguments are compatible with the expected dimensionality and type

If xyz is a list or tuple of arrays, this will attempt to stack the arrays along the last dimension, ensuring all arrays are of consistent shapes with each other.

Parameters
xyz(dim,) tuple of numpy.ndarray, or (…, dim) numpy.ndarray

The array to check

dimint, optional

The expected dimensionality

dtypeDataType, optional

The requested data type for the array

Returns
xyz(…, dim) numpy.ndarray of dtype

The validated array