pyriemann_qiskit.optimization.mean.qmean_euclid

pyriemann_qiskit.optimization.mean.qmean_euclid(X, sample_weight=None, optimizer=<pyriemann_qiskit.optimization.docplex.ClassicalOptimizer object>)[source]

Euclidean mean with Constraint Programming Model.

Constraint Programming Model (CPM) [1] formulation of the mean with Euclidean distance.

Parameters:

  • X (ndarray, shape (n_matrices, n_channels, n_channels)) – Set of SPD matrices.

  • sample_weights (None | ndarray, shape (n_matrices,), default=None) – Weights for each matrix. Never used in practice. It is kept only for standardization with pyRiemann.

  • optimizer (pyQiskitOptimizer, default=ClassicalOptimizer()) – An instance of pyriemann_qiskit.optimization.docplex.pyQiskitOptimizer.

Returns:

mean – CPM-optimized Euclidean mean.

Return type:

ndarray, shape (n_channels, n_channels)

Notes

Added in version 0.0.3.

Changed in version 0.0.4: Add regularization of the results.

Changed in version 0.2.0: Rename from fro_mean_convex to qmean_euclid. Remove shrinkage.

References