Skip to main content

Riemannian covariance estimation (riecovest)

This is a package for estimation of signal covariance matrices from noisy signal and noise-only data. The package is using pymanopt to perform optimization over Riemannian manifolds, using JAX to as a backend for automatic differentiation.

More info and complete API documentation

References

The code was developed as part of the paper J. Brunnström, M. Moonen, and F. Elvander, “Robust signal and noise covariance matrix estimation using Riemannian optimization,” presented at the European Signal Processing Conference (EUSIPCO), Sep. 2024. The examples folder contains code to replicate the results from the paper. If you use this software in your research, please cite the paper.

@inproceedings{brunnstromRobust2024,
  title = {Robust Signal and Noise Covariance Matrix Estimation Using {{Riemannian}} Optimization},
  booktitle = {European {{Signal Processing Conference}} ({{EUSIPCO}})},
  author = {Brunnstr{\"o}m, Jesper and Moonen, Marc and Elvander, Filip},
  year = {2024},
  month = sep,
  keywords = {covariance estimation,GEVD,low-rank,manifolds,MWF,quotient manifold,riemannian optimization,robust,SPD}
}

License

The software is distributed under the MIT license. See the LICENSE file for more information.

Installation

The package can be installed via pip from the PyPi repository:

pip install riecovest

Alternatively, clone this repository and install the package using:

pip install path/to/riecovest

To run the examples "reproduce_covest_t_distribution.py" and "reproduce_spatial_filtering.py" which reproduces the results from the aforementioned paper, a longer list of dependencies is needed. These can be installed with pip using:

pip install riecovest[examples]

The example "reproduce_spatial_filtering.py" also makes use of the MeshRIR dataset. It must be downloaded from the original source along with the dataset loader irutilities.py. The dataset loader must be placed in the same folder as the example script.

Acknowledgements

The software has been developed during a PhD project as part of the SOUNDS ETN at KU Leuven. The SOUNDS project has recieved funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No. 956369.

Metadata

Release files for riecovest 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for riecovest 0.0.4
File Size Uploaded
riecovest-0.0.4.tar.gz 15.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for riecovest 0.0.4
File Interpreter ABI Platform
riecovest-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 31.0 kB

Release files / riecovest-0.0.4.tar.gz

Download URL riecovest-0.0.4.tar.gz
Size 15.9 kB
Tags Source
SHA-256 checksum
How to use checksums
dcd511b1a406926e304bb69067df9f70769adbbe3573761cc86975daab7e7905
BLAKE2b-256 checksum
How to use checksums
c85b709fade8e31713fb65cb2704ad9ce5b10032bb0f3a0739ca4a58999f374a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Release files / riecovest-0.0.4-py3-none-any.whl

Download URL riecovest-0.0.4-py3-none-any.whl
Size 15.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
624cf1e88da1e850422325aabe106094f6e70685fcbb38270c59a62565f7dd49
BLAKE2b-256 checksum
How to use checksums
ca3c74ad8fa895fc5f944df33e8f6975222917b5f6a15288e999c6b72b444ad6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page