Metadata-Version: 2.4
Name: imicpe
Version: 1.0.7
Summary: Toolbox for Maths,Signal,Image Teaching @ CPE
Author-email: Marion Foare <marion.foare@cpe.fr>, Eric Van Reeth <eric.vanreeth@cpe.fr>, Arthur Gautheron <arthur.gautheron@cpe.fr>
License: MIT License
Project-URL: Homepage, https://www.cpe.fr
Project-URL: Documentation, https://cpe.pages.in2p3.fr/msi/toolbox_imi/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: plotly
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: tqdm
Requires-Dist: PyWavelets
Requires-Dist: scikit-image
Dynamic: license-file


A toolbox used for practical sessions at [CPE Lyon](https://www.cpe.fr/).
Developped and maintained for teaching usage only!

# Installation

## In a Jupyter Notebook

```!pip install -U imicpe```

## In a local environment

```pip install -U imicpe```

# Usage example

The example below uses the mse method available in the `optim.metrics` subpackage of `imicpe`.

```python
import numpy as np
from imicpe.optim import metrics
N=10000

x=np.random.randn(1,N)
ref = np.zeros((1,N)) 
mse=metrics.mse(x,ref)   

print(mse)
```
