CUQIpy 1.1.0.post0.dev21__py3-none-any.whl → 1.1.0.post0.dev39__py3-none-any.whl

{CUQIpy-1.1.0.post0.dev21.dist-info → CUQIpy-1.1.0.post0.dev39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CUQIpy
-Version: 1.1.0.post0.dev21
+Version: 1.1.0.post0.dev39
 Summary: Computational Uncertainty Quantification for Inverse problems in Python
 Maintainer-email: "Nicolai A. B. Riis" <nabr@dtu.dk>, "Jakob S. Jørgensen" <jakj@dtu.dk>, "Amal M. Alghamdi" <amaal@dtu.dk>, Chao Zhang <chaz@dtu.dk>
 License: Apache License

{CUQIpy-1.1.0.post0.dev21.dist-info → CUQIpy-1.1.0.post0.dev39.dist-info}/RECORD

@@ -1,6 +1,6 @@
 cuqi/__init__.py,sha256=LsGilhl-hBLEn6Glt8S_l0OJzAA1sKit_rui8h-D-p0,488
 cuqi/_messages.py,sha256=fzEBrZT2kbmfecBBPm7spVu7yHdxGARQB4QzXhJbCJ0,415
-cuqi/_version.py,sha256=pquuWWNWYDJTUFSDbH_S09M9kXQmP_DnjYFj4pEcm7k,509
+cuqi/_version.py,sha256=SFVwuROZ7PjMxlopbxtd_O7tlfLQi9nwgd9r4SLXD7o,509
 cuqi/config.py,sha256=wcYvz19wkeKW2EKCGIKJiTpWt5kdaxyt4imyRkvtTRA,526
 cuqi/diagnostics.py,sha256=5OrbJeqpynqRXOe5MtOKKhe7EAVdOEpHIqHnlMW9G_c,3029
 cuqi/array/__init__.py,sha256=-EeiaiWGNsE3twRS4dD814BIlfxEsNkTCZUc5gjOXb0,30
@@ -77,16 +77,16 @@ cuqi/sampler/_pcn.py,sha256=F0h9-nUFtkqn-o-1s8BCsmr8V7u6R7ycoCOeeV1uhj0,8601
 cuqi/sampler/_rto.py,sha256=-AtMiYq4fh7pF9zVqfYjYtQbIIEGayrWyRGTj8KecfE,11518
 cuqi/sampler/_sampler.py,sha256=TkZ_WAS-5Q43oICa-Elc2gftsRTBd7PEDUMDZ9tTGmU,5712
 cuqi/samples/__init__.py,sha256=E7B9IBUsiOBr-HAKH9o3_Lqhq4KeWO87hmesHkdbwTY,30
-cuqi/samples/_samples.py,sha256=UUyAhADdkshZZ-wi1ICl3u7FYx1OU5NXgO-EeAS5TCc,34804
+cuqi/samples/_samples.py,sha256=Pfy2piHmvZ3_fxh3c3BsQtX3mryIsDqRrqJ-Q7zw4Zo,35161
 cuqi/solver/__init__.py,sha256=DGl8IdUnochRXHNDEy_13o_VT0vLFY6FjMmmSH6YUkY,169
 cuqi/solver/_solver.py,sha256=TgezixCVf8nKGtEF9ZrkaTtAfxSs1Z8CR_cmhdTMqRw,22776
 cuqi/testproblem/__init__.py,sha256=DWTOcyuNHMbhEuuWlY5CkYkNDSAqhvsKmJXBLivyblU,202
 cuqi/testproblem/_testproblem.py,sha256=x769LwwRdJdzIiZkcQUGb_5-vynNTNALXWKato7sS0Q,52540
-cuqi/utilities/__init__.py,sha256=T4tLsC215MknBCsw_C0Qeeg_ox26aDUrCA5hbWvNQkU,387
+cuqi/utilities/__init__.py,sha256=H7xpJe2UinjZftKvE2JuXtTi4DqtkR6uIezStAXwfGg,428
 cuqi/utilities/_get_python_variable_name.py,sha256=QwlBVj2koJRA8s8pWd554p7-ElcI7HUwY32HknaR92E,1827
-cuqi/utilities/_utilities.py,sha256=MWAqV6L5btMpWwlUzrZYuV2VeSpfTbOaLRMRkuw2WIA,8509
-CUQIpy-1.1.0.post0.dev21.dist-info/LICENSE,sha256=kJWRPrtRoQoZGXyyvu50Uc91X6_0XRaVfT0YZssicys,10799
-CUQIpy-1.1.0.post0.dev21.dist-info/METADATA,sha256=rMz9rRNyTGpXZ9HSCjmlmKmZhBx4tp6oGXGT94UIdxE,18390
-CUQIpy-1.1.0.post0.dev21.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
-CUQIpy-1.1.0.post0.dev21.dist-info/top_level.txt,sha256=AgmgMc6TKfPPqbjV0kvAoCBN334i_Lwwojc7HE3ZwD0,5
-CUQIpy-1.1.0.post0.dev21.dist-info/RECORD,,
+cuqi/utilities/_utilities.py,sha256=Jc4knn80vLoA7kgw9FzXwKVFGaNBOXiA9kgvltZU3Ao,11777
+CUQIpy-1.1.0.post0.dev39.dist-info/LICENSE,sha256=kJWRPrtRoQoZGXyyvu50Uc91X6_0XRaVfT0YZssicys,10799
+CUQIpy-1.1.0.post0.dev39.dist-info/METADATA,sha256=tPkKE5LGWKpgvgM1zkAfKPq4tV0kLGVpbdZSz5ZCn3E,18390
+CUQIpy-1.1.0.post0.dev39.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
+CUQIpy-1.1.0.post0.dev39.dist-info/top_level.txt,sha256=AgmgMc6TKfPPqbjV0kvAoCBN334i_Lwwojc7HE3ZwD0,5
+CUQIpy-1.1.0.post0.dev39.dist-info/RECORD,,

{CUQIpy-1.1.0.post0.dev21.dist-info → CUQIpy-1.1.0.post0.dev39.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (73.0.1)
+Generator: setuptools (74.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cuqi/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-08-26T11:10:44+0200",
+ "date": "2024-08-29T10:46:43+0300",
  "dirty": false,
  "error": null,
- "full-revisionid": "d8a5799ec1e1e581a09e032cbf01bd3eab1b960d",
- "version": "1.1.0.post0.dev21"
+ "full-revisionid": "9d8920342c73b1bd8e7a47a216eb34056ea2f5d6",
+ "version": "1.1.0.post0.dev39"
 }
 '''  # END VERSION_JSON
 

cuqi/samples/_samples.py

@@ -873,3 +873,11 @@ class Samples(object):
         ax =  arviz.plot_violin(datadict, **kwargs)
 
         return ax
+
+    def __repr__(self) -> str: 
+        return "CUQIpy Samples:\n" + \
+               "---------------\n\n" + \
+               "Ns (number of samples):\n {}\n\n".format(self.Ns) + \
+               "Geometry:\n {}\n\n".format(self.geometry) + \
+               "Shape:\n {}\n\n".format(self.shape) + \
+               "Samples:\n {}\n\n".format(self.samples)

cuqi/utilities/__init__.py

@@ -11,6 +11,8 @@ from ._utilities import (
     sparse_cholesky,
     approx_derivative,
     check_if_conditional_from_attr,
+    plot_1D_density,
+    plot_2D_density
 )
 
 from ._get_python_variable_name import _get_python_variable_name

cuqi/utilities/_utilities.py

@@ -1,4 +1,5 @@
 from cuqi.array import CUQIarray
+from cuqi.density import Density
 import numpy as np
 import inspect
 from numbers import Number
@@ -7,6 +8,7 @@ from scipy.sparse import linalg as spslinalg
 from dataclasses import dataclass
 from abc import ABCMeta
 import copy
+import matplotlib.pyplot as plt
 
 
 def force_ndarray(value,flatten=False):
@@ -229,3 +231,117 @@ def approx_gradient(func, x, epsilon= 0.000001):
         eps_vec[i] = 0.0
         
     return FD_gradient
+
+
+# Function for plotting 1D density functions
+def plot_1D_density(density:Density,
+                    v_min, v_max,
+                    N=501, log_scale=False,
+                    **kwargs):
+    """ Plot 1D density function 
+
+    Parameters
+    ----------
+    density : CUQIpy Density
+        The density to be plotted.
+
+    v_min : float
+        Minimum value for the variable.
+    
+    v_max : float
+        Maximum value for the variable.
+
+    N : int
+        Number of grid points for the variable.
+
+    log_scale : bool
+        If True, the density is plotted in log scale.
+    
+    kwargs : dict
+        Additional keyword arguments for the plot that are passed to the
+        underlying plotting method: `matplotlib.pyplot.plot` function 
+        in this case.
+
+    """
+    # Assert that the density is 1D
+    assert density.dim == 1, "The density must be for a scalar variable"
+    ls = np.linspace(v_min, v_max, N)
+
+    # Create a map to evaluate density
+    density_map = (lambda x: x) if log_scale else (lambda x: np.exp(x))
+
+    # Evaluate density on grid
+    y = [density_map(density.logd(grid_point)) for grid_point in ls]
+    p = plt.plot(ls, y, **kwargs)
+    return p
+
+# Function for plotting 2D density functions
+def plot_2D_density(density: Density, 
+                    v1_min, v1_max,
+                    v2_min, v2_max,
+                    N1=201, N2=201,
+                    log_scale=False,
+                    **kwargs):
+    """ Plot 2D density function 
+
+    Parameters
+    ----------
+    density : CUQIpy Density
+        The density to be plotted.
+
+    v1_min : float
+        Minimum value for the first variable.
+    
+    v1_max : float
+        Maximum value for the first variable.
+    
+    v2_min : float
+        Minimum value for the second variable.
+
+    v2_max : float  
+        Maximum value for the second variable.
+
+    N1 : int
+        Number of grid points for the first variable.
+
+    N2 : int
+        Number of grid points for the second variable.
+    
+    log_scale : bool
+        If True, the density is plotted in log scale.
+
+    kwargs : dict
+        Additional keyword arguments for the plot that are passed to the
+        underlying plotting method: `matplotlib.pyplot.imshow` function 
+        in this case.
+
+    """
+    # Assert that the density is 2D
+    assert density.dim == 2,\
+        "The density must be for a two-dimensional variable"
+    # Create grid
+    ls1 = np.linspace(v1_min, v1_max, N1)
+    ls2 = np.linspace(v2_min, v2_max, N2)
+    grid1, grid2 = np.meshgrid(ls1, ls2)
+
+    # Create a map to evaluate density
+    density_map = (lambda x: x) if log_scale else (lambda x: np.exp(x))
+
+    # Evaluate density on grid
+    evaluated_density = np.zeros((N1, N2))
+    for ii in range(N1):
+        for jj in range(N2):
+            evaluated_density[ii,jj] = density_map(
+                density.logd([grid1[ii,jj], grid2[ii,jj]])) 
+
+    # Plot
+    pixelwidth_x = (v1_max-v1_min)/(N2-1)
+    pixelwidth_y = (v2_max-v2_min)/(N2-1)
+
+    hp_x = 0.5*pixelwidth_x
+    hp_y = 0.5*pixelwidth_y
+
+    extent = (v1_min-hp_x, v1_max+hp_x, v2_min-hp_y, v2_max+hp_y)
+
+    im = plt.imshow(evaluated_density, origin='lower', extent=extent, **kwargs)
+    return im