plotastrodata 1.7.13__tar.gz → 1.8.0__tar.gz

{plotastrodata-1.7.13/plotastrodata.egg-info → plotastrodata-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotastrodata
-Version: 1.7.13
+Version: 1.8.0
 Summary: plotastrodata is a tool for astronomers to create figures from FITS files and perform fundamental data analyses with ease.
 Home-page: https://github.com/yusukeaso-astron/plotastrodata
 Download-URL: https://github.com/yusukeaso-astron/plotastrodata

{plotastrodata-1.7.13 → plotastrodata-1.8.0}/plotastrodata/__init__.py

@@ -1,4 +1,4 @@
 import warnings
 
 warnings.simplefilter('ignore', FutureWarning)
-__version__ = '1.7.13'
+__version__ = '1.8.0'

{plotastrodata-1.7.13 → plotastrodata-1.8.0}/plotastrodata/analysis_utils.py

@@ -7,8 +7,8 @@ from scipy.signal import convolve
 
 from plotastrodata.coord_utils import coord2xy, xy2coord, rel2abs
 from plotastrodata.matrix_utils import Mfac, Mrot, dot2d
-from plotastrodata.other_utils import (estimate_rms, trim,
-                                       gaussian2d, isdeg,
+from plotastrodata.noise_utils import estimate_rms
+from plotastrodata.other_utils import (trim, gaussian2d, isdeg,
                                        RGIxy, RGIxyv, to4dim)
 from plotastrodata.fits_utils import FitsData, data2fits, Jy2K
 from plotastrodata import const_utils as cu

{plotastrodata-1.7.13 → plotastrodata-1.8.0}/plotastrodata/fits_utils.py

@@ -4,8 +4,8 @@ from astropy import units, wcs
 
 from plotastrodata.coord_utils import coord2xy, xy2coord
 from plotastrodata.matrix_utils import dot2d
-from plotastrodata.other_utils import (estimate_rms, trim, isdeg,
-                                       RGIxy)
+from plotastrodata.noise_utils import estimate_rms
+from plotastrodata.other_utils import trim, isdeg, RGIxy
 from plotastrodata import const_utils as cu
 
 

plotastrodata-1.8.0/plotastrodata/noise_utils.py

@@ -0,0 +1,197 @@
+import warnings
+import numpy as np
+from scipy.special import erf
+
+from plotastrodata.fitting_utils import EmceeCorner
+
+
+def normalize(range: tuple = (-3.5, 3.5), bins: int = 100):
+    """Decorator factory to normalize a function over the given range."""
+    def decorator(f):
+        h = np.linspace(*range, bins + 1)
+        h = (h[1:] + h[:-1]) / 2
+        dh = (range[1] - range[0]) / 100
+
+        def wrapper(x, *args):
+            area = np.sum(f(h, *args)) * dh
+            if area == 0:
+                p = np.where(np.abs(x - args[1]) < dh / 2, 1 / dh, 0)
+            else:
+                p = f(x, *args) / area
+            return p
+
+        return wrapper
+    return decorator
+
+
+def gauss(x: np.ndarray, s: float, m: float) -> np.ndarray:
+    """Probability density of Gaussian noise.
+
+    Args:
+        x (np.ndarray): Intensity. The variable of the probability density.
+        s (float): Standard deviation of the Gaussian noise.
+        m (float): Mean of the Gaussian noise.
+
+    Returns:
+        np.ndarray: Probability density.
+    """
+    x1 = (x - m) / np.sqrt(2) / s
+    p = np.exp(-x1**2)
+    p = p / (np.sqrt(2 * np.pi) * s)
+    return p
+
+
+def gauss_pbcor(x: np.ndarray, s: float, m: float, R: float
+                ) -> np.ndarray:
+    """Probability density of Gaussian noise after primary-beam correction.
+
+    Args:
+        x (np.ndarray): Intensity. The variable of the probability density.
+        s (float): Standard deviation of the Gaussian noise.
+        m (float): Mean of the Gaussian noise.
+        R (float): The maximum radius scaled by the FWHM of the primary beam.
+
+    Returns:
+        np.ndarray: Probability density.
+    """
+    x1 = (x - m) / np.sqrt(2) / s
+    x0 = (x * 2**(-R**2) - m) / np.sqrt(2) / s
+    p = erf(x1) - erf(x0)
+    p = p / (2 * np.log(2) * x * R**2)
+    return p
+
+
+def select_noise(data: np.ndarray, sigma: str) -> np.ndarray:
+    """Select data pixels to be used for noise estimation.
+
+    Args:
+        data (np.ndarray): Original data array.
+        sigma (str): Selection methods. Multiple options are possible. 'edge', 'out', 'neg', or 'iter'.
+
+    Returns:
+        np.ndarray: 1D array that includes only the selected pixels.
+    """
+    n = data * 1
+    if 'edge' in sigma:
+        if np.ndim(n) <= 2:
+            print('\'edge\' is ignored because ndim <= 2.')
+        else:
+            n = n[::len(n) - 1]
+    if 'out' in sigma and 'pbcor' in sigma:
+        print('\'out\' is ignored because of \'pbcor\'.')
+    elif 'out' in sigma:
+        nx = np.shape(n)[-1]
+        ny = np.shape(n)[-2]
+        ntmp = np.moveaxis(n, [-2, -1], [0, 1])
+        ntmp[ny // 5: ny * 4 // 5, nx // 5: nx * 4 // 5] = np.nan
+        if np.all(np.isnan(ntmp)):
+            print('\'out\' is ignored because'
+                  + ' the outer region is filled with nan.')
+        else:
+            n = ntmp
+    n = n[~np.isnan(n)]
+    if 'neg' in sigma:
+        n = n[n < 0]
+        n = np.r_[n, -n]
+    if 'iter' in sigma:
+        for _ in range(5):
+            n = n[np.abs(n - np.mean(n)) < 3.5 * np.std(n)]
+    return n.ravel()
+
+
+class Noise:
+    def __init__(self, data: np.ndarray, sigma: str):
+        """This class holds the data selected as noise, histogram, and best-fit function.
+           The following methods are acceptable for data selection. Multiple options are possible.
+           'edge': use data[0] and data[-1].
+           'out': exclude inner 60% about axes=-2 and -1.
+           'neg': use only negative values.
+           'iter': exclude outliers.
+           The following methods are acceptable for noise estimation. Only single option is possible.
+           'med': calculate rms from the median of data^2 assuming Gaussian.
+           'hist': fit histgram with Gaussian.
+           'hist-pbcor': fit histgram with PB-corrected Gaussian.
+           '(no string)': calculate the mean and standard deviation.
+
+        Args:
+            data (np.ndarray): Original data array.
+            sigma (str): Methods above, like 'edge,neg,hist-pbcor'.
+        """
+        self.data = select_noise(data, sigma)
+        self.sigma = sigma
+        self.m0 = np.mean(self.data)
+        self.s0 = np.std(self.data)
+
+    def gen_histogram(self, **kwargs):
+        """Generage a pair of histogram and bins using numpy.histogram. The data values are shifted and scaled by the mean and standard deviation, respectively, to generate the histogram. The mean and standard deviation are stored as self.m0 and self.s0, respectively.
+        """
+        _kw = {'bins': 100, 'range': (-3.5, 3.5), 'density': True}
+        _kw.update(kwargs)
+        self.bins = _kw['bins']
+        self.range = _kw['range']
+        n = (self.data - self.m0) / self.s0
+        hist, hbin = np.histogram(n, **_kw)
+        hbin = (hbin[:-1] + hbin[1:]) / 2
+        self.hist = hist
+        self.hbin = hbin
+
+    def fit_histogram(self, **kwargs):
+        """kwargs is for plotastrodata.fitting_utils.EmceeCorner.
+        """
+        _kw = {'nwalkersperdim': 4, 'nsteps': 200, 'nburnin': 0}
+        _kw.update(kwargs)
+        f = gauss_pbcor if 'pbcor' in self.sigma else gauss
+        model = normalize(range=self.range, bins=self.bins)(f)
+        bounds = [[0.1, 2], [-2, 2]]
+        if 'pbcor' in self.sigma:
+            bounds.append([0.1, 2])
+        # curve_fit does not work for this fitting.
+        # 0.01 in sigma is set only to search the best-fit parameters.
+        # Thus, this sigma does not justify the parameter errors.
+        fitter = EmceeCorner(bounds=bounds, model=model,
+                             xdata=self.hbin, ydata=self.hist,
+                             sigma=np.max(self.hist) * 0.01)
+        fitter.fit(**_kw)
+        self.popt = fitter.popt
+        self.mean = float(self.popt[1] * self.s0 + self.m0)
+        self.std = float(self.popt[0] * self.s0)
+        self.model = model(self.hbin, *self.popt)
+
+
+def estimate_rms(data: np.ndarray,
+                 sigma: float | str | None = 'hist'
+                 ) -> float:
+    """Estimate a noise level of a N-D array.
+       When a float number or None is given, this function just outputs it.
+
+    Args:
+        data (np.ndarray): Data array whose noise is estimated.
+        sigma (float or str): Methods for the Noise class, like 'edge,neg,hist-pbcor'. Defaults to 'hist'.
+
+    Returns:
+        float: The estimated standard deviation of noise.
+    """
+    nums = [float, int, np.float64, np.int64, np.float32, np.int32]
+    if sigma is None or type(sigma) in nums:
+        return sigma
+
+    if np.ndim(np.squeeze(data)) == 0:
+        print('sigma cannot be estimated from only one pixel.')
+        return 0.0
+
+    n = Noise(data, sigma)
+    if 'hist' in sigma:
+        n.gen_histogram()
+        n.fit_histogram()
+        ave = n.mean
+        noise = n.std
+    elif 'med' in sigma:
+        ave = 0
+        noise = np.sqrt(np.median(n.data**2) / 0.454936)
+    else:
+        ave = n.m0
+        noise = n.s0
+    if np.abs(ave) > 0.2 * noise:
+        s = 'Mean > 0.2 x standard deviation.'
+        warnings.warn(s, UserWarning)
+    return noise

{plotastrodata-1.7.13 → plotastrodata-1.8.0}/plotastrodata/other_utils.py

@@ -1,9 +1,6 @@
-import warnings
 import numpy as np
-from scipy.special import erf
 from scipy.interpolate import RegularGridInterpolator as RGI
 
-from plotastrodata.fitting_utils import EmceeCorner
 from plotastrodata.matrix_utils import Mrot, dot2d
 
 
@@ -37,128 +34,6 @@ def isdeg(s: str) -> bool:
         return False
 
 
-def estimate_rms(data: np.ndarray, sigma: float | str | None = 'hist'
-                 ) -> float:
-    """Estimate a noise level of a N-D array.
-       When a float number or None is given, this function just outputs it.
-       Following methos are acceptable.
-       'edge': use data[0] and data[-1].
-       'neg': use only negative values.
-       'med': use the median of data^2 assuming Gaussian.
-       'iter': exclude outliers.
-       'out': exclude inner 60% about axes=-2 and -1.
-       'hist': fit histgram with Gaussian. This option can be combined with 'edge' and/or 'neg'.
-       'hist-pbcor': fit histgram with PB-corrected Gaussian. This option can be combined with 'edge' and/or 'neg'.
-
-    Args:
-        data (np.ndarray): N-D array.
-        sigma (float or str): One of the methods above. Defaults to 'hist'.
-
-    Returns:
-        float: the estimated standard deviation of noise.
-    """
-    if sigma is None:
-        return None
-
-    def warning_offset(ave, noise):
-        if np.abs(ave) > 0.2 * noise:
-            s = 'The intensity offset is larger than 0.2 sigma.'
-            warnings.warn(s, UserWarning)
-
-    nums = [float, int, np.float64, np.int64, np.float32, np.int32]
-    if type(sigma) in nums:
-        noise = sigma
-    elif np.ndim(np.squeeze(data)) == 0:
-        print('sigma cannot be estimated from only one pixel.')
-        noise = 0.0
-    elif sigma == 'edge':
-        ave = np.nanmean(data[::len(data) - 1])
-        noise = np.nanstd(data[::len(data) - 1])
-        warning_offset(ave, noise)
-    elif sigma == 'neg':
-        noise = np.sqrt(np.nanmean(data[data < 0]**2))
-    elif sigma == 'med':
-        noise = np.sqrt(np.nanmedian(data**2) / 0.454936)
-    elif sigma == 'iter':
-        n = data.copy()
-        for _ in range(5):
-            ave, sig = np.nanmean(n), np.nanstd(n)
-            n = n - ave
-            n = n[np.abs(n) < 3.5 * sig]
-        ave = np.nanmean(n)
-        noise = np.nanstd(n)
-        warning_offset(ave, noise)
-    elif sigma == 'out':
-        n, n0, n1 = data * 1, len(data), len(data[0])
-        n = np.moveaxis(n, [-2, -1], [0, 1])
-        n[n0//5: n0*4//5, n1//5: n1*4//5] = np.nan
-        if np.all(np.isnan(n)):
-            print('sigma=\'neg\' instead of \'out\' because'
-                  + ' the outer region is filled with nan.')
-            noise = np.sqrt(np.nanmean(data[data < 0]**2))
-        else:
-            ave = np.nanmean(n)
-            noise = np.nanstd(n)
-            warning_offset(ave, noise)
-    elif 'hist' in sigma:
-        n = data * 1
-        if 'edge' in sigma:
-            n = n[::len(n) - 1]
-        if 'neg' in sigma:
-            n = n[n < 0]
-            n = np.r_[n, -n]
-        n = n[~np.isnan(n)]
-        m0, s0 = np.mean(n), np.std(n)
-        hist, hbin = np.histogram((n - m0) / s0,
-                                  bins=100, density=True,
-                                  range=(-3.5, 3.5))
-        hbin = (hbin[:-1] + hbin[1:]) / 2
-        h = np.linspace(-3.5, 3.5, 101)
-        dh = 0.07
-
-        def normalize(f, x, *args):
-            # For normalization within (-3.5, 3.5), not (-inf, inf).
-            area = np.sum(f(h, *args)) * dh
-            if area == 0:
-                p = np.where(np.abs(x - args[1]) < dh / 2, 1 / dh, 0)
-            else:
-                p = f(x, *args) / area
-            return p
-
-        if 'pbcor' in sigma:
-            bounds = [[0.1, 2], [-2, 2], [0.1, 2]]
-
-            def g(x, *p):
-                s, m, R = p
-                x1 = (x - m) / np.sqrt(2) / s
-                x0 = (x * 2**(-R**2) - m) / np.sqrt(2) / s
-                p = erf(x1) - erf(x0)
-                p = p / (2 * np.log(2) * x * R**2)
-                return p
-        else:
-            bounds = [[0.1, 2], [-2, 2]]
-
-            def g(x, *p):
-                s, m = p
-                x1 = (x - m) / np.sqrt(2) / s
-                p = np.exp(-x1**2)
-                p = p / (np.sqrt(2 * np.pi) * s)
-                return p
-
-        def model(x, *p):
-            return normalize(g, x, *p)
-        # curve_fit does not work for this fitting.
-        fitter = EmceeCorner(bounds=bounds, model=model,
-                             xdata=hbin, ydata=hist,
-                             sigma=np.max(hist) * 0.01)
-        fitter.fit(nwalkersperdim=4, nsteps=200, nburnin=0)
-        popt = fitter.popt
-        ave = popt[1] * s0 + m0
-        noise = popt[0] * s0
-        warning_offset(ave, noise)
-    return noise
-
-
 def trim(data: np.ndarray | None = None, x: np.ndarray | None = None,
          y: np.ndarray | None = None, v: np.ndarray | None = None,
          xlim: list[float, float] | None = None,

{plotastrodata-1.7.13 → plotastrodata-1.8.0}/plotastrodata/plot_utils.py

@@ -6,7 +6,8 @@ from matplotlib.patches import Ellipse, Rectangle
 from dataclasses import dataclass
 
 from plotastrodata.coord_utils import coord2xy, xy2coord
-from plotastrodata.other_utils import listing, estimate_rms
+from plotastrodata.noise_utils import estimate_rms
+from plotastrodata.other_utils import listing
 from plotastrodata.analysis_utils import AstroData, AstroFrame
 
 

{plotastrodata-1.7.13 → plotastrodata-1.8.0/plotastrodata.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotastrodata
-Version: 1.7.13
+Version: 1.8.0
 Summary: plotastrodata is a tool for astronomers to create figures from FITS files and perform fundamental data analyses with ease.
 Home-page: https://github.com/yusukeaso-astron/plotastrodata
 Download-URL: https://github.com/yusukeaso-astron/plotastrodata

{plotastrodata-1.7.13 → plotastrodata-1.8.0}/plotastrodata.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ plotastrodata/fits_utils.py
 plotastrodata/fitting_utils.py
 plotastrodata/los_utils.py
 plotastrodata/matrix_utils.py
+plotastrodata/noise_utils.py
 plotastrodata/other_utils.py
 plotastrodata/plot_utils.py
 plotastrodata.egg-info/PKG-INFO