dreye.compute_gamut#

dreye.compute_gamut(X, at_l1=None, relative_to=None, center_to_neutral=False, metric='width', center=True, seed=None)[source]#

Compute absolute gamut of a matrix X.

Parameters:
Xnp.ndarray

An n x m matrix with n samples and m features.

at_l1float, optional

[description], by default None

relative_tonp.ndarray, optional

Calculate relative to another array with samples, by default None

center_to_neutralbool, optional

Center for barycentric dimensionality reduction, by default False

metricstr, optional

The metric to use when computing the gamut, either ‘width’ or ‘volume’, by default ‘width’

centerbool, optional

If True, center the data before computing, by default True

seedint, optional

The seed for the random number generator, by default None

Returns:
float

The gamut of X.