v0.4.1

What's Changed

• Add returns_A and returns_B parameters by @gcattan in #50
• Bump peter-evans/create-pull-request from 5 to 6 by @dependabot in #56
• Bump pypa/gh-action-pypi-publish from 1.8.11 to 1.8.12 by @dependabot in #57

Full Changelog: v0.4...v0.4.1

v0.4

What's Changed

• Bump peter-evans/create-pull-request from 4 to 5 by @dependabot in #40
• Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6 by @dependabot in #41
• Bump pypa/gh-action-pypi-publish from 1.8.6 to 1.8.7 by @dependabot in #42
• Bump pypa/gh-action-pypi-publish from 1.8.7 to 1.8.8 by @dependabot in #43
• Bump pypa/gh-action-pypi-publish from 1.8.8 to 1.8.10 by @dependabot in #44
• Bump actions/checkout from 3 to 4 by @dependabot in #45
• Bump gcattan/git-quality-check from 0.1.2 to 0.1.3 by @dependabot in #46
• Bump pypa/gh-action-pypi-publish from 1.8.10 to 1.8.11 by @dependabot in #47
• Bump actions/setup-python from 4 to 5 by @dependabot in #48
• Bump github/codeql-action from 2 to 3 by @dependabot in #49

Full Changelog: v0.3...v0.4

v0.3

What's Changed

• Bump pypa/gh-action-pypi-publish from 1.8.1 to 1.8.3 by @dependabot in #34
• Bump pypa/gh-action-pypi-publish from 1.8.3 to 1.8.4 by @dependabot in #35
• Bump pypa/gh-action-pypi-publish from 1.8.4 to 1.8.5 by @dependabot in #36
• Update get_covmat.py by @gcattan in #26
• Update version number by @gcattan in #39

Full Changelog: v0.2.1...v0.3

v0.2.1

What's Changed

• Bump actions/setup-python from 3 to 4 by @dependabot in #21
• Bump pypa/gh-action-pypi-publish from 1.4.2 to 1.5.1 by @dependabot in #20
• Bump pypa/gh-action-pypi-publish from 1.5.1 to 1.5.2 by @dependabot in #22
• Update git-quality-check.yml by @gcattan in #25
• Bump pypa/gh-action-pypi-publish from 1.5.2 to 1.6.4 by @dependabot in #24
• Update alphawaves dependency by @gcattan in #29
• Bump gcattan/git-quality-check from 0.1.1 to 0.1.2 by @dependabot in #28
• Bump pypa/gh-action-pypi-publish from 1.6.4 to 1.7.1 by @dependabot in #30
• Bump pypa/gh-action-pypi-publish from 1.7.1 to 1.8.0 by @dependabot in #31
• Bump pypa/gh-action-pypi-publish from 1.8.0 to 1.8.1 by @dependabot in #32
• update version number by @gcattan in #33

Full Changelog: v0.2...v0.2.1

v0.2

What's Changed

• Create formatter.yml by @gcattan in #4
• Create dependabot.yml by @gcattan in #8
• Bump actions/setup-python from 2 to 4 by @dependabot in #10
• Bump actions/checkout from 2 to 3 by @dependabot in #9
• Bump peter-evans/create-pull-request from 3 to 4 by @dependabot in #11
• Update testing.yml by @gcattan in #12
• Create git-quality-check by @gcattan in #13
• Create codeql-analysis.yml by @gcattan in #18
• Create python-publish.yml by @gcattan in #19

New Contributors

• @gcattan made their first contribution in #4
• @dependabot made their first contribution in #10

Full Changelog: v0.1...v0.2

v0.1

Release notes

This software implements a simple method to get semi-definite positive (SPD) covariance matrices for testing. A possible use case is the use of such software for testing electroencephalography (EEG) or magnetoencephalography (MEG) classification pipeline based on covariance matrices and Riemannian geometry.  

Samples are real EEG recordings of participants during an opened/closed eye experiment [1]. The implementation takes as parameters the expected number of matrices and channels and returns a random set of samples from the experiment. The number of channels has to be between 1 and 16. Covariance matrices are estimated using pyRiemann [2].

Usage

The software can be installed using pip:

pip install covmattest

And the following code generates 3 matrices of size 2x2:

covmat = get_covmat(3, 2)

By default, matrices are issued from the same subject, picked randomly at the initialization of the script. To enforce the choice of a new random subject, you can use the following code:

from covmatest import CovmatGen
gen = CovmatGen()
covmat = gen.get_covmat(3, 2)

Note that each instance of CovmatGen picks a subject randomly and then keeps it during the whole time of its lifecycle.

References

[1]  G. Cattan, P. L. Coelho Rodrigues, and M. Congedo, ‘EEG Alpha Waves Dataset’, GIPSA-LAB, Research Report, décembre 2018. [Online]. Available: https://hal.archives-ouvertes.fr/hal-02086581

[2] A. Barachant, pyRiemann. pyRiemann, 2015. [Online]. Available: https://github.com/pyRiemann/pyRiemann