imicpe 1.0.8.1__tar.gz → 1.0.10__tar.gz

{imicpe-1.0.8.1 → imicpe-1.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: imicpe
-Version: 1.0.8.1
+Version: 1.0.10
 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

{imicpe-1.0.8.1 → imicpe-1.0.10}/pyproject.toml

@@ -14,7 +14,7 @@ mypkg = ["*.txt", "*.mat", "*.npy"]
 #[tool.setuptools_scm]
 
 [project]
-version="1.0.8.1"
+version="1.0.10"
 name = "imicpe"
 authors = [
   { name="Marion Foare", email="marion.foare@cpe.fr" },

imicpe-1.0.10/src/imicpe/_version.py

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

imicpe-1.0.10/src/imicpe/optim/metrics.py

@@ -0,0 +1,64 @@
+import numpy as np
+import torch
+from skimage.metrics import structural_similarity as ssim
+
+def mse(I,ref):
+    """ Calcule la MSE
+
+    Parameters
+    ----------
+    I : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D dégradé(e)
+    
+    ref : (numpy.ndarray)               
+        vérité terrain (signal 1D OU image NON vectorisée 2D)
+
+    
+    Returns
+    -------
+    : (float)
+        Valeur de MSE
+    """
+
+    return np.round(np.sum((I-ref)**2)/I.size,5)
+
+def snr(I,ref):
+    """ Calcule le SNR
+
+    Parameters
+    ----------
+    I : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D dégradé(e)
+    
+    ref : (numpy.ndarray)               
+        vérité terrain (signal 1D OU image NON vectorisée 2D)
+
+    
+    Returns
+    -------
+    : (float)
+        Valeur de SNR
+    """
+    return np.round(10* np.log10(np.sum(ref**2)/np.sum((I-ref)**2)),2)
+
+def ssim(I,ref):
+    """ Calcule le SSIM
+
+    Parameters
+    ----------
+    I : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D dégradé(e)
+    
+    ref : (numpy.ndarray)               
+        vérité terrain (signal 1D OU image NON vectorisée 2D)
+
+    
+    Returns
+    -------
+    : (float)
+        Valeur de SSIM
+    """
+
+    return np.round(ssim(img, img_noise, data_range=img_noise.max() - img_noise.min())
+,3)
+

{imicpe-1.0.8.1 → imicpe-1.0.10}/src/imicpe/optim/operators.py

@@ -8,12 +8,16 @@ import scipy.sparse as sp
 ############################################################
 def Id(x):
     """Opérateur identité
-   
-    Args:
-        X (numpy.ndarray)               signal 1D ou: image non vectorisée 2D
-                                
-    Returns: 
-        (numpy.ndarray)                  X 
+    
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
+                  
+    Returns
+    -------
+    : (numpy.ndarray)
+        X 
     """
     
     return x
@@ -27,12 +31,15 @@ def D(x):
     """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 
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
+                   
+    Returns
+    -------
+    : (numpy.ndarray)
+        Gradient de X 
     """
     
     if x.ndim == 1:
@@ -50,12 +57,15 @@ def Dt(x):
     """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 
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
+                    
+    Returns
+    -------
+    : (numpy.ndarray)
+        Divergence de X 
     """
     
     if x.ndim == 1:
@@ -73,12 +83,15 @@ def L(x):
     """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
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
                                 
-    Returns: 
-        (numpy.ndarray)                 Laplacien de X 
+    Returns
+    -------
+    : (numpy.ndarray)
+        Laplacien de X 
     """
     
     if x.ndim == 1:
@@ -95,12 +108,15 @@ def Lt(x):
     """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
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
                                 
-    Returns: 
-        (numpy.ndarray)                 Adjoint du Laplacien de X 
+    Returns
+    -------
+    : (numpy.ndarray)
+        Adjoint du Laplacien de X 
     """
     
     if x.ndim == 1:
@@ -114,18 +130,25 @@ def Lt(x):
     return lap
 
 def generateDiff3D(vert, faces, dtype):
-    """
-    generateDiff3D       Génère la matrice de différentiation de type DTYPE (ordre 1 ou 2) en 3D
+    """Génère la matrice de différentiation de type DTYPE (ordre 1 ou 2) en 3D
+    
+    Parameters
+    ----------
+    VERT : (numpy.ndarray)            
+        matrice Nx3 dont la i-ème ligne correspond au vecteur
+        de coordonnées (X,Y,Z) du i-ème point du maillage
     
-    Args:
-        VERT (numpy.ndarray)            matrice Nx3 dont la i-ème ligne correspond au vecteur
-                                            de coordonnées (X,Y,Z) du i-ème point du maillage
-        FACES (numpy.ndarray)           matrice Nx3 dont la i-ème ligne donne les  numéros des
-                                            3 points composant un triangle du maillage
-        DTYPE(str)                      'gradient', 'laplacian'
+    FACES : (numpy.ndarray)
+        matrice Nx3 dont la i-ème ligne donne les  numéros des
+        3 points composant un triangle du maillage
     
-    Returns:
-        (numpy.ndarray)                 matrice 3D de différentiation de type DTYPE
+    DTYPE : (str)
+        'gradient', 'laplacian'
+    
+    Returns
+    -------
+    : (numpy.ndarray)
+        matrice 3D de différentiation de type DTYPE
     """
     
     if dtype == 'gradient':
@@ -197,16 +220,24 @@ def generateDiff3D(vert, faces, dtype):
 def generatePSF(dim,blurtype,kernelSize):
     """Génère le noyau de convolution d’un flou de dimension DIM, de type BLURTYPE, 
     et de taille KERNELSIZE.
+
+    -> voir les fonctions A(x,h) et At(x,h).
     
-    Args:
-        DIM (str)                       ’1D’ ou ’2D’
-        BLURTYPE (str)                  ’none’, ’gaussian’ ou ’uniform’
-        KERNELSIZE (int)                entier impair
-                                
-    Returns: 
-        (numpy.ndarray)                 Noyau de convolution
+    Parameters
+    ----------
+    DIM : (str)
+        ’1D’ ou ’2D’
     
-    -> voir les fonctions A(x,h) et At(x,h).
+    BLURTYPE : (str)
+        ’none’, ’gaussian’ ou ’uniform’
+    
+    KERNELSIZE : (int)
+        entier impair
+                                
+    Returns
+    -------
+    : (numpy.ndarray)
+        Noyau de convolution
     """
 
     # compute kernel
@@ -238,13 +269,19 @@ def A(x,psf):
     Autrement dit, A(x,h) calcule le produit de convolution h*x, ou de manière équivalente, calcule
     le produit matriciel Hx.
 
-    Args:
-        X (numpy.ndarray)               signal 1D
-                                    ou: image non vectorisée 2D
-        PSF (numpy.ndarray)             doit être générée à partir de la fonction generatePSF
 
-    Returns:
-        (numpy.ndarray)                 Convolution de X par le noyau PSF
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
+
+    PSF : (numpy.ndarray)             
+        doit être générée à partir de la fonction generatePSF
+                  
+    Returns
+    -------
+    : (numpy.ndarray)                 
+        Convolution de X par le noyau PSF
     """
     
     if x.ndim == 1:
@@ -259,13 +296,18 @@ def At(x,psf):
     Autrement dit, A(x,h) calcule le produit de convolution h'*x, ou de manière équivalente, calcule
     le produit matriciel H'x.
 
-    Args:
-        X (numpy.ndarray)               signal 1D
-                                    ou: image non vectorisée 2D
-        PSF (numpy.ndarray)             doit être générée à partir de la fonction generatePSF
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
 
-    Returns:
-        (numpy.ndarray)                 Correlation de X par le noyau PSF
+    PSF : (numpy.ndarray)             
+        doit être générée à partir de la fonction generatePSF
+    
+    Returns
+    -------
+    : (numpy.ndarray)                 
+        Correlation de X par le noyau PSF
     """
     
     if x.ndim == 1:
@@ -283,11 +325,15 @@ def At(x,psf):
 def S(x):
     """Convolue X avec un noyau KER.
    
-    Args:
-        X (numpy.ndarray)               image non vectorisée 2D
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
                                 
-    Returns: 
-        (numpy.ndarray)                 Convolution de X par le noyau KER
+    Returns
+    -------
+    : (numpy.ndarray)
+        Convolution de X par le noyau KER
     """
     
     h,w = x.shape
@@ -307,11 +353,15 @@ def S(x):
 def St(x):   
     """Corrèle X avec un noyau KER.
    
-    Args:
-        X (numpy.ndarray)               image non vectorisée 2D
+    Parameters
+    ----------
+    X : (numpy.ndarray)               
+        signal 1D OU image NON vectorisée 2D
                                 
-    Returns: 
-        (numpy.ndarray)                 Correlation de X par le noyau KER
+    Returns
+    ------- 
+    : (numpy.ndarray)
+        Correlation de X par le noyau KER
     """
     
     h,w = x.shape
@@ -337,13 +387,21 @@ def opNorm(op,opt,dim):
     """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 (str)                       '1D', '2D'
+    Parameters
+    ----------
+    OP : (function)
+        opérateur direct
+    
+    OPT : (function)
+        opérateur adjoint
+    
+    DIM : (str)
+        '1D', '2D'
         
-    Returns:
-        (float)                         norme de l'opérateur OP
+    Returns
+    -------
+    : (float)
+        norme de l'opérateur OP
     """
     
     def T(x):
@@ -378,11 +436,15 @@ def opNorm(op,opt,dim):
 def matNorm(M):
     """Calcule la norme de la matrice M
 
-    Args:
-        M (numpy.ndarray)               matrice dont on souhaite calculer la norme
+    Parameters
+    ----------
+    M : (numpy.ndarray)
+        matrice dont on souhaite calculer la norme
         
-    Returns:
-        (float)                         norme de la matrice M
+    Returns
+    -------
+    : (float)
+        norme de la matrice M
     """
     
     def T(x):

{imicpe-1.0.8.1 → imicpe-1.0.10}/src/imicpe.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: imicpe
-Version: 1.0.8.1
+Version: 1.0.10
 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

imicpe-1.0.8.1/src/imicpe/_version.py

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

imicpe-1.0.8.1/src/imicpe/optim/metrics.py

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