imicpe 0.0.9.6__tar.gz → 1.0.0__tar.gz

{imicpe-0.0.9.6 → imicpe-1.0.0}/DESCRIPTION.md

@@ -15,7 +15,6 @@ Developped and maintained for teaching usage only!
 # Usage example
 
 The example below uses the mse method available in the `optim.metrics` subpackage of `imicpe`.
-It requires `numpy.randn` to generate a gaussian distribution of N points.
 
 ```python
 import numpy as np

{imicpe-0.0.9.6 → imicpe-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imicpe
-Version: 0.0.9.6
+Version: 1.0.0
 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
@@ -18,6 +18,8 @@ Requires-Dist: plotly
 Requires-Dist: torch
 Requires-Dist: torchvision
 Requires-Dist: tqdm
+Requires-Dist: PyWavelets
+Requires-Dist: scikit-image
 
 
 A toolbox used for practical sessions at [CPE Lyon](https://www.cpe.fr/).
@@ -36,7 +38,6 @@ Developped and maintained for teaching usage only!
 # Usage example
 
 The example below uses the mse method available in the `optim.metrics` subpackage of `imicpe`.
-It requires `numpy.randn` to generate a gaussian distribution of N points.
 
 ```python
 import numpy as np

imicpe-1.0.0/README.md

@@ -0,0 +1,127 @@
+# Librairie Python IMICPE
+
+Le dépôt de la librairie imicpe ainsi que la documentation associée sont disponibles ici :
+
+- Dépôt : <https://gitlab.in2p3.fr/cpe/msi/toolbox_imi> 
+- Doc : <https://cpe.pages.in2p3.fr/msi/toolbox_imi>
+
+Table des matières
+
+> [Introduction](#introduction)<br/>
+> [Créer un nouveau module dans une librairie](#cr%C3%A9er-un-nouveau-module-dans-une-librairie)<br/>
+> [Ajouter une nouvelle librairie/dépendence nécessaire à la librairie](#ajouter-une-nouvelle-librairiedépendence-nécessaire-à-la-librairie)<br/>
+> [Appeler une autre fonction de la librairie](#appeler-une-autre-fonction-de-la-librairie)<br/>
+> [Ajouter/Mettre à jour une fonction existante dans un module](#ajoutermettre-à-jour-une-fonction-existante-dans-un-module)<br/>
+>> [Déposer le code et générer une version de test disponible sur test.pypi.org](#d%C3%A9poser-le-code-et-g%C3%A9n%C3%A9rer-une-version-de-test-disponible-sur-testpypiorg)<br/>
+>> [Déposer le code et générer une version de disponible sur pypi.org](#d%C3%A9poser-le-code-et-g%C3%A9n%C3%A9rer-une-version-de-disponible-sur-pypiorg)<br/>
+>> [Déposer le code sans vouloir générer de version de la librairie](#d%C3%A9poser-le-code-sans-vouloir-g%C3%A9n%C3%A9rer-de-version-de-la-librairie)<br/>
+
+## Introduction
+
+Certains outils d’intégration continue ont été installé sur le dépôt gitlab de chacune des librairies pour faciliter la génération de la documentation technique ainsi que la compilation de la librairie et son dépôt sur pypi.org ou test.pypi.org. Cependant, cela requiert quelques actions de votre part qui sont détaillées dans la suite du document.
+
+## Créer un nouveau module dans une librairie
+Dans le dépôt git, vous trouverez l’arborescence suivante :<br/>
+<img src="docs/images/arborescence.png"
+     alt="Arborescence Structure"
+     style="float: left; margin-right: 10px;" />
+1. [ ] Créez un nouveau dossier dans le dossier « src/nom de la libraire/_nom du module »_ (dans l’exemple ci-dessous le nouveau dossier se trouverait au même niveau que ssl, tns, tsa ou utils…)
+2. [ ] Pour que le contenu de ce nouveau dossier soit reconnu comme un nouveau module de la librairie, il est nécessaire que ce dossier contienne un fichier **\__init_\_.py** qui va lister le lien vers toutes les fonctions du module.
+3. [ ] Si vous souhaitez que la documentation de ce module soit automatiquement générée :
+    1. Copier le fichier « docs/imicpe.optim.rst » et renommez le « imicpe._nom du module._rst ».
+    2. Adapter le contenu du fichier.
+    3. Editez le fichier « docs/imicpe.rst » en ajoutant « imicpe._nom du module »_ à la suite de la liste déjà existante dans ce fichier.
+4. Continuer en suivant les instructions de la partie suivante
+
+## Ajouter une nouvelle librairie/dépendence nécessaire à la librairie
+1. [ ] Identifier le nom de la librairie dans [Pypi](https://pypi.org)
+2. [ ] Ajouter le nom de la librairie à la liste `dependencies` du fichier *pyproject.toml*
+3. [ ] Ajouter le nom de la librairie au fichier *docs/requirements.txt*
+
+## Appeler une autre fonction de la librairie
+
+Bien faire l'appel en chemin relatif du fichier qui importe la fonction. 
+**Par exemple, pour introduire une fonction dans un autre fichier du même dossier, écrire** `from .my_file import my_func`
+
+## Ajouter/Mettre à jour une fonction existante dans un module
+
+Dans le dossier du module où vous souhaitez ajouter la fonction _myFunc_ :
+1. [ ] Créer un fichier _maFonction.py_ qui contiendra :
+	1. Les imports nécessaires pour l’exécution des fonctions de ce fichier
+	2. Une (ou plusieurs) fonction(s) python _myFunc_ (..)
+	3. La doc string descriptive de la fonction qui respecte la nomenclature suivante
+````			
+def sptheo(Q, method, fenetre=None):
+	"""
+	Calcule dans le cadre du TP Estimation spectrale :
+
+	- Gth : la valeur en dB de la DSPM du bruit blanc filtré entre 0 et 0,5.
+	- Gbiais : la valeur en dB de Gth convolué par la grandeur régissant le biais attaché à la 'method'.
+	- f : un vecteur fréquence réduite de même taille que Gth et Gbiais.
+
+	Parameters
+	----------
+	Q : int
+		Pour 'simple', représente la longueur de l'échantillon analysé.
+		Pour 'moyenne' ou 'welch', représente la longueur d'une tranche.
+
+	method : {'simple', 'moyenne', 'welch'}
+		Méthode d'estimation spectrale à utiliser.
+
+	fenetre : str, optional
+		Nom de la fenêtre à utiliser si method='welch'. Ignoré pour 'simple' et 'moyenne'.
+
+	Returns
+	-------
+	Gth : ndarray
+		Valeur en dB de la DSPM du bruit blanc filtré entre 0 et 0,5.
+
+	Gbiais : ndarray
+		Valeur en dB de Gth convolué par la grandeur régissant le biais.
+
+	f : ndarray
+		Vecteur fréquence réduite.
+
+	Notes
+	-----
+	Cette fonction calcule différentes valeurs théoriques dans le cadre de l'estimation spectrale,
+	en fonction de la méthode choisie ('simple', 'moyenne' ou 'welch') et des paramètres associés.
+
+	Example
+	-------
+	>>> from msicpe.tsa import sptheo
+	>>> sptheo(1024, 'welch', 'hamming')
+	"""
+
+````
+
+
+2. [ ]  Editer le fichier **\__init_\_.py** du même dossier pour importer la fonction qui doit être accessible dans la librairie.
+
+
+<i>Par exemple, si je veux que la fonction export_dat disponible dans le fichier export_dat.py soit accessible, je vais compléter le fichier_ **\__init_\_.py** de la façon suivante :</i>
+
+```
+from .export_dat import export_dat
+```
+
+3. [ ] Il faut maintenant déposer le code sur le dépôt git. Trois options s’offrent à vous :  
+    \- Déposer le code et générer une version de test disponible sur test.pypi.org<br/>
+	\- Déposer le code et générer une version de disponible sur pypi.org<br/>
+	\- Déposer le code sans vouloir générer de version de la librairie
+
+### Déposer le code et générer une version de test disponible sur test.pypi.org
+
+- [ ] Modifier le fichier **version.txt** situé à la racine du dépôt et indiquer une suite de chiffre supérieure à celle disponible sur <https://test.pypi.org/simple/imicpe/>
+- [ ] Faites un simple commit & push
+- [ ] La doc sera mise à jour et d’ici quelques minutes (~5 min) il y aura une nouvelle version de la librairie qui sera disponible sur <https://test.pypi.org/simple/imicpe/>
+
+### Déposer le code et générer une version de disponible sur pypi.org
+
+- [ ] Faites un simple commit & push
+- [ ] Sur le repo, créer un tag de la dernière version du git (en suivant la numérotation croissante existante).
+- [ ] La doc sera mise à jour et d’ici quelques minutes (~5 min) il y aura une nouvelle version de la librairie qui sera disponible sur <https://pypi.org/project/imicpe/>
+
+### Déposer le code sans vouloir générer de version de la librairie
+
+- [ ] Faites un simple commit & push

{imicpe-0.0.9.6 → imicpe-1.0.0}/pyproject.toml

@@ -9,12 +9,12 @@ build-backend = "setuptools.build_meta"
 where = ["src"]
 
 [tool.setuptools.package-data]
-mypkg = ["*.txt", "*.mat"]
+mypkg = ["*.txt", "*.mat", "*.npy"]
 
 #[tool.setuptools_scm]
 
 [project]
-version="0.0.9.6"
+version="1.0.0"
 name = "imicpe"
 authors = [
   { name="Marion Foare", email="marion.foare@cpe.fr" },
@@ -32,6 +32,8 @@ dependencies = [
     "torch",
     "torchvision",
     "tqdm",
+    "PyWavelets",
+    "scikit-image"
 ]
 classifiers = [
     "Programming Language :: Python :: 3",

imicpe-1.0.0/src/imicpe/_version.py

@@ -0,0 +1 @@
+__version__="1.0.0"

imicpe-1.0.0/src/imicpe/cs/__init__.py

@@ -0,0 +1,9 @@
+from .metrics import mse, snr
+from .operators import fwt, iwt, fwt2, iwt2
+from .tikhonov import tikhonov
+from .l1 import l1
+from .shepp_logan_phantom import phantom_shepp_logan
+from .masks import mat2mask, starPattern, getAcquisitionImage  #, sub2ind, ind2sub
+
+import os
+cameraman = os.path.join(os.path.dirname(__file__), 'cameraman.tif')

imicpe-1.0.0/src/imicpe/cs/l1.py

@@ -0,0 +1,111 @@
+
+import numpy as np
+from scipy import ndimage
+
+from .operators import *
+from tqdm import tqdm_notebook as tqdm
+
+def l1(opreg,A,At,z,x0,lam):
+    """
+    l1       Algorithme Forward-Backward pour résoudre le problème
+                xhat = argmin  ||Hx-z||_2^2 + lam.||Gx||_1
+                        x
+    
+    en particulier : 
+    - le modèle LASSO si G = Id,
+    - le modèle TV si G = D (gradient) ou L (laplacien),
+   
+    Args:
+        opreg (string)              nom de l'opérateur G sur lequel opère la contrainte de parcimonie {'id', 'gradient', 'laplacien'}
+        A (fonction)    
+        At (fonction)
+        z
+        x0 (numpy.ndarray)
+        lam (float)
+                                
+    Returns: 
+        xhat (numpy.ndarray)        solution du problème
+        loss (numpy.ndarray)        évolution de la fonction de coût au cours des itérations
+    """
+    
+    print('Running l1 model with ' +opreg+ ' sparsity constraint...\n\t')
+    
+    ### init ###
+    dim = x0.ndim
+    match opreg:
+        case 'id':
+            G = Id
+            Gt = Id
+        case 'gradient':
+            G = D
+            Gt = Dt
+        case 'laplacien':
+            G = L
+            Gt = Lt
+    
+    # operator norms
+    lipA = opNorm(A,At,dim,x0)
+    lipG = opNorm(G,Gt,dim,x0)   
+
+    # cost functions
+    def f(x):           # data fidelity
+        return np.sum(x**2)/2
+
+    def R(x):           # regularization
+        return np.sum(np.abs(x))
+    
+    def E(x,lam):       # total cost
+        return f(A(x)-z) + lam*R(G(x))
+
+    # proximity operator
+    def proxl1(x,gam):
+        return x - np.maximum(np.minimum(x,gam*np.ones(x.shape)),-gam*np.ones(x.shape))
+
+    ### Algo ###
+    niter       = 1e3;                                  # max number of iterations
+    # model hyperparameters
+    mu    = 5;                                          # Bregman parameter (in [1,10], should not vary)
+    
+    # algo hyperparameters
+    gamx  = .9/(lipA**2 + mu*lipG**2); #.5e-1;          # gradient descent step (x subproblem)
+    gamu  = 1/mu;                                       # proximal descent step (y subproblem)
+    
+    # initialize variables
+    En = np.zeros((int(niter+1),),float) * np.nan
+    xn = x0   #np.random.standard_normal((z.shape))
+    un = G(xn)                                          # splitting variable
+    bn = np.zeros(un.shape,float)                       # Bregman variable
+    
+    En[0] = E(xn,lam)
+
+    # loop parameters
+    k         = 0
+    tol       = 1e-10
+    stop_crit = En[0]
+    
+  
+    with tqdm(total=niter) as pbar: 
+        while (k < niter) and (stop_crit > tol):
+            # yn subproblem
+            Gxn = G(xn)
+            un = proxl1(un - gamu*mu*(un-Gxn-bn/mu) , lam*gamu)
+            
+            # xn subproblem (relaxed): gradient descent step instead of GS iteration
+            xn = xn - gamx*( At(A(xn)-z) - mu*Gt(un-Gxn-bn/mu) )
+
+            # bn subproblem
+            bn = bn - mu*(un-G(xn))
+            
+            # compute loss
+            En[k+1] = E(xn,lam)
+            
+            # update loop parameters
+            stop_crit = (En[k] - En[k+1])/En[k]
+            k += 1
+            pbar.update(1)
+    
+    pbar.close()
+    xhat = xn
+    loss = En
+    
+    return xhat, loss

imicpe-1.0.0/src/imicpe/cs/masks.py

@@ -0,0 +1,80 @@
+
+import numpy as np
+from scipy import ndimage
+import pywt
+
+
+mat2mask = lambda mat, H, W, M:  np.reshape(mat.T, (H, W, M))
+
+    
+def starPattern(N, M):
+    """
+    starPattern       Génère un masque de taille NxN en étoile (tomographie) correspondant à M mesures.
+
+    Args:
+    N (int)                    Taille du masque
+    M (int)                    Nombre de mesures
+
+    Returns: 
+    Amat (numpy.ndarray)       Matrice d'acquisition
+    mask (numpy.ndarray)       Masque 
+    """
+    
+
+    mask2mat = lambda mask: np.reshape(mask,  (M, N**2))  
+     
+    H = int(N)
+    W = int(N)
+    
+    n = int(N)
+    r = np.linspace(-1, 1, 3*n)*n
+
+    nrho = 2**4
+    R = np.round(np.linspace(-n/2, n/2, nrho))#.astype(int)
+
+    ntheta = M//nrho
+    T = np.linspace(0, np.pi, ntheta+1, endpoint=False)
+
+    mask = np.zeros((H, W, ntheta, nrho))
+    for itt in range(ntheta):
+        theta = T[itt]
+            
+        for itr in range(nrho):
+            rho = R[itr]
+                
+            x = np.round(r*np.cos(theta) + n/2 - rho*np.sin(theta))#.astype(int)
+            y = np.round(r*np.sin(theta) + n/2 + rho*np.cos(theta))#.astype(int)
+
+            valid = np.where((x >= 0) & (x < n) & (y >= 0) & (y < n))
+            x = x[valid].astype(int)
+            y = y[valid].astype(int)
+
+            tmpM = np.zeros((H, W))
+            tmpM[y, x] = 1
+ 
+            mask[:, :, itt, itr] = tmpM
+
+    mask = mask.reshape((H, W, M))
+    Amat = mask2mat(mask)
+        
+    return Amat, mask
+        
+        
+def getAcquisitionImage(x,mask):
+    _, _, Nmeasures = mask.shape
+    
+    zim = np.sum(mask * np.tile(x[..., None], (1, 1, Nmeasures)), axis=2)
+    zim = zim / np.max(zim)
+    
+    return zim
+
+
+
+# def sub2ind(array_shape, rows, cols):
+#     ind = rows*array_shape[1] + cols
+#     return ind.astype(int)
+
+# def ind2sub(array_shape, ind):
+#     rows = (ind.astype('int') / array_shape[1])
+#     cols = (ind.astype('int') % array_shape[1]) # or numpy.mod(ind.astype('int'), array_shape[1])
+#     return (int(rows), int(cols))

imicpe-1.0.0/src/imicpe/cs/metrics.py

@@ -0,0 +1,7 @@
+import numpy as np
+
+def mse(I,ref):
+    return np.sum((I-ref)**2)/I.size
+
+def snr(I,ref):
+    return 10* np.log10(np.sum(ref**2)/np.sum((I-ref)**2))

imicpe-1.0.0/src/imicpe/cs/operators.py

@@ -0,0 +1,298 @@
+
+import numpy as np
+from scipy import ndimage
+import pywt
+
+
+############################################################
+## identity operator
+############################################################
+def Id(x):
+    """
+    Id       Opérateur identité
+   
+    Args:
+        X (numpy.ndarray)               signal 1D
+                                    ou: image non vectorisée 2D
+                                
+    Returns: 
+        (numpy.ndarray)                  X 
+    """
+    
+    return x
+
+
+############################################################
+## differential forward and backward operators
+############################################################
+# gradient
+def D(x):
+    """
+    D       Calcule le gradient par différences finies à droite.
+    Autrement dit, D(x) calcule le produit matriciel Dx.
+   
+    Args:
+        X (numpy.ndarray)               signal 1D
+                                    ou: image non vectorisée 2D
+                                
+    Returns: 
+        (numpy.ndarray)                 Gradient de X 
+    """
+    
+    if x.ndim == 1:
+        grad = np.concatenate((x[1:] - x[:-1], [0]))/2.
+
+    elif x.ndim == 2:
+        sz = x.shape
+        Dx_im = np.concatenate((  x[:,1:] - x[:,:-1] , np.zeros((sz[0],1)) ), axis=1)/ 2.
+        Dy_im = np.concatenate((  x[1:,:] - x[:-1,:] , np.zeros((1,sz[1])) ), axis=0)/ 2.
+        
+        grad = np.array([Dx_im,Dy_im])
+    return grad
+
+def Dt(x):
+    """
+    Dt       Calcule l’adjoint gradient par différences finies à droite.
+    Autrement dit, Dt(x) calcule le produit matriciel D'x.
+   
+    Args:
+        X (numpy.ndarray)               signal 1D
+                                    ou: image non vectorisée 2D
+                                
+    Returns: 
+        (numpy.ndarray)                 Divergence de X 
+    """
+    
+    if x.ndim == 1:
+        div = - np.concatenate(([x[0]], x[1:-1] - x[:-2], [-x[-2]])) /2.
+
+    elif x.ndim == 3:
+        x1 = x[0]
+        x2 = x[1]
+        div = - np.concatenate((x1[:,[0]], x1[:,1:-1] - x1[:,:-2], -x1[:,[-2]]), axis=1) /2. \
+              - np.concatenate((x2[[0],:], x2[1:-1,:] - x2[:-2,:], -x2[[-2],:]), axis=0) /2.
+    return div
+
+# laplacian
+def L(x):
+    """
+    L        Calcule la dérivée seconde d’un signal, ou le laplacien dans le cas d’une image.
+    Autrement dit, L(x) calcule le produit matriciel Lx.
+   
+    Args:
+        X (numpy.ndarray)               signal 1D
+                                    ou: image non vectorisée 2D
+                                
+    Returns: 
+        (numpy.ndarray)                 Laplacien de X 
+    """
+    
+    if x.ndim == 1:
+        ker = np.array([1, -2, 1])
+        #lap = np.convolve(x,ker,'same')
+        lap = ndimage.convolve1d(x,ker,mode='nearest')
+    elif x.ndim == 2:
+        ker = np.array([[0, 1, 0], [1, -4, 1], [0, 1, 0]])    # V4
+        #ker = np.array([[1, 1, 1], [1, -8, 1], [1, 1, 1]])    # V8
+        lap = ndimage.convolve(x,ker,mode='nearest')
+    return lap
+
+def Lt(x):
+    """
+    Lt       Calcule l’adjoint du laplacien.
+    Autrement dit, Lt(x) calcule le produit matriciel L'x.
+   
+    Args:
+        X (numpy.ndarray)               signal 1D
+                                    ou: image non vectorisée 2D
+                                
+    Returns: 
+        (numpy.ndarray)                 Adjoint du Laplacien de X 
+    """
+    
+    if x.ndim == 1:
+        ker = np.array([1, -2, 1])
+        #lap = np.correlate(x,ker,'same')
+        lap = ndimage.correlate1d(x,ker,mode='nearest')
+    elif x.ndim == 2:
+        ker = np.array([[0, 1, 0], [1, -4, 1], [0, 1, 0]])    # V4
+        #ker = np.array([[1, 1, 1], [1, -8, 1], [1, 1, 1]])    # V8
+        lap = ndimage.correlate(x,ker,mode='nearest')
+    return lap
+
+
+############################################################
+## Wavelet transforms
+############################################################
+def fwt(x,wavelet,level):
+    """
+    P       Calcule la transformée en ondelettes directe 1D.
+
+    Args:
+    x (numpy.ndarray)               signal 1D
+
+    Returns: 
+    (numpy.ndarray)                 Vecteur des coefficients de la décomposition en ondelettes de x
+    """
+
+    dim = x.ndim
+
+    coeffs = pywt.wavedec(x, wavelet, level=level, mode="periodization")
+    coeff_arr, _, _ = pywt.ravel_coeffs(coeffs)
+            
+    return coeff_arr
+
+
+def iwt(x,wavelet,level,coeffs_slices=None,coeffs_shapes=None,):
+    """
+    P       Calcule la transformée en ondelettes inverse 1D.
+
+    Args:
+    x (numpy.ndarray)               Vecteur des coefficients d'ondelettes                                          
+
+    Returns: 
+    (numpy.ndarray)                 Signal correspondant aux coefficients d'ondelettes donnés par x
+    """
+
+    J = level
+    N = len(x)
+    
+    if coeffs_shapes is None:
+        # compute coeffs size at each level
+        sizes = [N // (2**j) for j in range(J, 0, -1)] + [N // (2**J)]
+
+        # coefficients splitting
+        start = 0
+        coeffs = []
+        for size in reversed(sizes):
+            coeffs.append(x[start:start + size])
+            start += size
+    else:
+        coeffs = pywt.unravel_coeffs(x, coeffs_slices, coeffs_shapes, output_format='wavedec')
+
+    # reconstruct corresponding signal
+    signal = pywt.waverec(coeffs, wavelet, mode="periodization")
+            
+    return signal
+
+
+def fwt2(x,wavelet,level):
+    """
+    P       Calcule la transformée en ondelettes directe 2D.
+
+    Args:
+    x (numpy.ndarray)               image NON vectorisée 2D
+
+    Returns: 
+    (numpy.ndarray)                 Vecteur des coefficients de la décomposition en ondelettes de x
+    """
+
+    coeffs = pywt.wavedec2(x, wavelet, level=level, mode="periodization")
+    coeff_arr, _, _ = pywt.ravel_coeffs(coeffs)
+
+    return coeff_arr
+
+def iwt2(x,wavelet,level,coeffs_slices,coeffs_shapes):
+    """
+    P       Calcule la transformée en ondelettes inverse 2D.
+
+    Args:
+    x (numpy.ndarray)               Vecteur des coefficients d'ondelettes                                          
+
+    Returns: 
+    (numpy.ndarray)                 Image correspondante aux coefficients d'ondelettes donnés par x
+    """
+
+    J = level
+    N = len(x)
+    
+    coeffs = pywt.unravel_coeffs(x, coeffs_slices, coeffs_shapes,
+                                      output_format='wavedec2')
+    
+    # reconstruct corresponding signal
+    image = pywt.waverec2(coeffs, wavelet, mode="periodization")
+
+    return image
+
+
+############################################################
+## Operator and matrix norm
+############################################################
+def opNorm(op,opt,dim,xn):
+    """
+    opNorm      Calcule la norme de l'opérateur OP, dont 
+    l'opérateur transposé est OPT, en dimension DIM
+
+    Args:
+        OP (function)                   opérateur direct
+        OPT (function)                  opérateur adjoint
+        DIM (int)                       1 or 2
+        
+    Returns:
+        (float)                         norme de l'opérateur OP
+    """
+    
+    def T(x):
+        return opt(op(x))
+
+    # match dim:
+    #     case 1:  
+    #         xn = np.random.standard_normal((64))
+    #     case 2:
+    #         xn = np.random.standard_normal((64,64))
+
+    xnn = xn
+
+    n = np.zeros((1000,),float)
+    n[1] = 1
+    tol  = 1e-4
+    rhon = n[1]+2*tol
+
+    k = 1
+    while abs(n[k]-rhon)/n[k] >= tol:
+        xn  = T(xnn)
+        xnn = T(xn)
+
+        rhon   = n[k]
+        n[k+1] = np.sum(xnn**2)/np.sum(xn**2)
+   
+        k = k+1
+
+    N = n[k-1] + 1e-16
+    return 1.01* N**(.25)              # sqrt(L) gives |||T|||=|||D'D||| ie |||D|||^2
+
+
+def matNorm(M):
+    """
+    matNorm      Calcule la norme de la matrice M
+
+    Args:
+        M (numpy.ndarray)               matrice dont on souhaite calculer la norme
+        
+    Returns:
+        (float)                         norme de la matrice M
+    """
+    
+    def T(x):
+        return np.dot(M.T, np.dot(M,x))
+
+    xn = np.random.standard_normal((M.shape[1]))
+    xnn = xn
+
+    n = np.zeros((1000,),float)
+    n[1] = 1
+    tol  = 1e-4
+    rhon = n[1]+2*tol
+
+    k = 1
+    while abs(n[k]-rhon)/n[k] >= tol:
+        xn  = T(xnn)
+        xnn = T(xn)
+
+        rhon   = n[k]
+        n[k+1] = np.sum(xnn**2)/np.sum(xn**2)
+   
+        k = k+1
+
+    N = n[k-1] + 1e-16
+    return 1.01* N**(.25)              # sqrt(L) gives |||T|||=|||D'D||| ie |||D|||^2

imicpe-1.0.0/src/imicpe/cs/shepp_logan_phantom.py

@@ -0,0 +1,21 @@
+
+import numpy as np
+
+from skimage.data import shepp_logan_phantom
+from skimage.transform import rescale, resize
+
+def phantom_shepp_logan(N):
+    """
+    phantom_shepp_logan       Génère le phantom de Shepp-Logan 2D de taille NxN.
+
+    Args:
+    N (int)                    Taille du phantom
+
+    Returns: 
+    (numpy.ndarray)           Image du phantom
+    """
+    p = shepp_logan_phantom()
+    p = resize(p, (int(N),int(N)), anti_aliasing=False)
+    p[p<1e-10] = .1
+    
+    return p

imicpe-1.0.0/src/imicpe/cs/tikhonov.py

@@ -0,0 +1,95 @@
+
+import numpy as np
+from scipy import ndimage
+
+from .operators import *
+from tqdm import tqdm_notebook as tqdm
+
+def tikhonov(opreg,A,At,z,x0,lam):
+    """
+    tikhonov   Algorithme de descente de gradient pour résoudre le problème
+                xhat = argmin  ||Hx-z||_2^2 + lam.||Gx||_2^2
+                        x
+    
+   
+    Args:
+        opreg (string)              nom de l'opérateur G sur lequel opère la contrainte de parcimonie {'id', 'gradient', 'laplacien'}
+        A (fonction)    
+        At (fonction)
+        z
+        x0 (numpy.ndarray)
+        lam (float)
+                                
+    Returns: 
+        xhat (numpy.ndarray)        solution du problème
+        loss (numpy.ndarray)        évolution de la fonction de coût au cours des itérations
+    """
+    
+    print('Running Tikhonov model with ' +opreg+ ' sparsity constraint...\n\t')
+    
+    ### init ###
+    dim = x0.ndim
+    match opreg:
+        case 'id':
+            G = Id
+            Gt = Id
+        case 'gradient':
+            G = D
+            Gt = Dt
+        case 'laplacien':
+            G = L
+            Gt = Lt
+    
+    # operator norms
+    lipA = opNorm(A,At,dim,x0)
+    lipG = opNorm(G,Gt,dim,x0)   
+
+    # cost functions
+    def f(x):           # data fidelity
+        return np.sum(x**2)/2
+
+    def R(x):           # regularization
+        return np.sum(x**2)/2
+    
+    def E(x,lam):       # total cost
+        return f(A(x)-z) + lam*R(G(x))
+
+    # proximity operator
+    def proxl1(x,gam):
+        return x - np.maximum(np.minimum(x,gam*np.ones(x.shape)),-gam*np.ones(x.shape))
+
+    ### Algo ###
+    niter       = 1e3;                                  # max number of iterations
+    
+    # algo hyperparameters
+    gam  = .9/(2*lipA**2 + 2*lam*lipG**2);            # gradient descent step
+
+    # initialize variables
+    En = np.zeros((int(niter+1),),float) * np.nan
+    xn = x0   #np.random.standard_normal((z.shape))
+    
+    En[0] = E(xn,lam)
+
+    # loop parameters
+    k         = 0
+    tol       = 1e-10
+    stop_crit = En[0]
+    
+    with tqdm(total=niter) as pbar: 
+        while (k < niter) and (stop_crit > tol):
+            # xn subproblem
+            xn = xn - 2*gam*(At(A(xn)-z) + lam*Gt(G(xn)))
+                
+            # compute loss
+            En[k+1] = E(xn,lam)
+                
+            # update loop parameters
+            stop_crit = (En[k] - En[k+1])/En[k]
+            k += 1
+            pbar.update(1)
+    
+    pbar.close()
+    xhat = xn
+    loss = En
+    
+    return xhat, loss

{imicpe-0.0.9.6 → imicpe-1.0.0}/src/imicpe.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imicpe
-Version: 0.0.9.6
+Version: 1.0.0
 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
@@ -18,6 +18,8 @@ Requires-Dist: plotly
 Requires-Dist: torch
 Requires-Dist: torchvision
 Requires-Dist: tqdm
+Requires-Dist: PyWavelets
+Requires-Dist: scikit-image
 
 
 A toolbox used for practical sessions at [CPE Lyon](https://www.cpe.fr/).
@@ -36,7 +38,6 @@ Developped and maintained for teaching usage only!
 # Usage example
 
 The example below uses the mse method available in the `optim.metrics` subpackage of `imicpe`.
-It requires `numpy.randn` to generate a gaussian distribution of N points.
 
 ```python
 import numpy as np

{imicpe-0.0.9.6 → imicpe-1.0.0}/src/imicpe.egg-info/SOURCES.txt

@@ -9,6 +9,13 @@ src/imicpe.egg-info/SOURCES.txt
 src/imicpe.egg-info/dependency_links.txt
 src/imicpe.egg-info/requires.txt
 src/imicpe.egg-info/top_level.txt
+src/imicpe/cs/__init__.py
+src/imicpe/cs/l1.py
+src/imicpe/cs/masks.py
+src/imicpe/cs/metrics.py
+src/imicpe/cs/operators.py
+src/imicpe/cs/shepp_logan_phantom.py
+src/imicpe/cs/tikhonov.py
 src/imicpe/optim/__init__.py
 src/imicpe/optim/metrics.py
 src/imicpe/optim/operators.py

{imicpe-0.0.9.6 → imicpe-1.0.0}/src/imicpe.egg-info/requires.txt

@@ -4,3 +4,5 @@ plotly
 torch
 torchvision
 tqdm
+PyWavelets
+scikit-image

imicpe-0.0.9.6/README.md

@@ -1,93 +0,0 @@
-# toolbox
-
-
-
-## Getting started
-
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
-```
-cd existing_repo
-git remote add origin https://gitlab.in2p3.fr/cpe/msi/toolbox.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.in2p3.fr/cpe/msi/toolbox/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

imicpe-0.0.9.6/src/imicpe/_version.py

@@ -1 +0,0 @@
-__version__="0.0.9.6"