plotastrodata 1.8.9__tar.gz → 1.8.11__tar.gz

{plotastrodata-1.8.9/plotastrodata.egg-info → plotastrodata-1.8.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotastrodata
-Version: 1.8.9
+Version: 1.8.11
 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.8.9 → plotastrodata-1.8.11}/plotastrodata/__init__.py

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

{plotastrodata-1.8.9 → plotastrodata-1.8.11}/plotastrodata/plot_utils.py

@@ -65,20 +65,22 @@ def logticks(ticks: list[float], lim: list[float, float]
     return newticks, newlabels
 
 
-def logcbticks(vmin: float = -3.01, vmax: float = 3.01
+def logcbticks(vmin: float = 1e-3, vmax: float = 1e3
                ) -> tuple[np.ndarray, np.ndarray]:
     """Make nice ticks for a log color bar.
 
     Args:
-        vmin (float, optional): Minimum value. Defaults to -3.01.
-        vmax (float, optional): Maximum value. Defaults to 3.01.
+        vmin (float, optional): Minimum value. Defaults to 1e-3.
+        vmax (float, optional): Maximum value. Defaults to 1e3.
 
     Returns:
         tuple: (ticks, ticklabels).
     """
-    ticks = np.outer(np.logspace(-3, 3, 7), np.arange(1, 10))
+    i0 = int(np.floor(np.log10(vmin)))
+    i1 = int(np.ceil(np.log10(vmax)))
+    ticks = np.outer(np.logspace(i0, i1, i1 - i0 + 1), np.arange(1, 10))
     ticklabels = []
-    for i in range(-3, 4):
+    for i in range(i0, i1 + 1):
         ii = np.abs(min(i, 0))
         ii = f'{ii:d}'
         for j in range(1, 10):
@@ -88,41 +90,10 @@ def logcbticks(vmin: float = -3.01, vmax: float = 3.01
             else:
                 s = ''
             ticklabels.append(s)
-    ticks = np.log10(np.ravel(ticks))
+    ticks = np.ravel(ticks)
     ticklabels = np.ravel(ticklabels)
-    ticklabels = ticklabels[((vmin < ticks) * (ticks < vmax))]
-    ticks = ticks[((vmin < ticks) * (ticks < vmax))]
-    return ticks, ticklabels
-
-
-def pow10(x: np.ndarray, stretchpower: float) -> np.ndarray:
-    """A power-law function scaled by xmin. This function is used for the case of stretch='power' in PlotAstroData.add_color().
-
-    Args:
-        x (np.ndarray): Input in the linear scale.
-        stretchpower (float, optional): The output is (data**stretchpower - 1) / stretchpower / ln(10). 1 means the linear scale, while 0 means the logarithmic scale.
-
-    Returns:
-        np.ndarray: Output values.
-    """
-    p = 1e-6 if stretchpower == 0 else stretchpower
-    y = (x**p - 1) / p / np.log(10)
-    return y
-
-
-def ipow10(x: np.ndarray, stretchpower: float) -> np.ndarray:
-    """The inverse function of pow10. This function is used for the case of stretch='power' in PlotAstroData.add_color().
-
-    Args:
-        x (np.ndarray): Input values.
-        stretchpower (float, optional): The input is (data**stretchpower - 1) / stretchpower / ln(10). 1 means the linear scale, while 0 means the logarithmic scale.
-
-    Returns:
-        np.ndarray: Output values in the linear scale.
-    """
-    p = 1e-6 if stretchpower == 0 else stretchpower
-    y = (1 + p * np.log(10) * x)**(1 / p)
-    return y
+    cond = (vmin <= ticks) * (ticks <= vmax)
+    return ticks[cond], ticklabels[cond]
 
 
 def do_stretch(x: list | np.ndarray,
@@ -133,8 +104,8 @@ def do_stretch(x: list | np.ndarray,
     Args:
         x (list | np.ndarray): Input array in the linear scale.
         stretch (str): 'log', 'asinh', 'power', or 'linear'. Any other means 'linear'. 'log' means the mapped data are logarithmic. 'asinh' means the mapped data are arc sin hyperbolic. 'power' means the mapped data are power-law (see also stretchpower). Defaults to 'linear'.
-        stretchscale (float, optional): The output is asinh(data / stretchscale). Defaults to None.
-        stretchpower (float, optional): The output is ((data / stretchscale)**stretchpower - 1) / stretchpower / ln(10). 1 means the linear scale, while 0 means the logarithmic scale.
+        stretchscale (float): The output is asinh(data / stretchscale).
+        stretchpower (float): The output is data**stretchpower / stretchpower. 1 means the linear scale, while 0 means the logarithmic scale.
 
     Returns:
         np.ndarray: Output stretched array.
@@ -142,11 +113,12 @@ def do_stretch(x: list | np.ndarray,
     t = np.array(x)
     match stretch:
         case 'log':
-            t = np.log10(t)
+            t = np.log10(t)  # To be consistent with logcbticks().
         case 'asinh':
             t = np.arcsinh(t / stretchscale)
         case 'power':
-            t = pow10(t / stretchscale, stretchpower)
+            p = 1e-6 if stretchpower == 0 else stretchpower
+            t = t**p / p
     return t
 
 
@@ -158,8 +130,8 @@ def undo_stretch(x: list | np.ndarray,
     Args:
         x (list | np.ndarray): Input stretched array.
         stretch (str): 'log', 'asinh', 'power', or 'linear'. Any other means 'linear'. 'log' means the mapped data are logarithmic. 'asinh' means the mapped data are arc sin hyperbolic. 'power' means the mapped data are power-law (see also stretchpower). Defaults to 'linear'.
-        stretchscale (float, optional): The input is asinh(data / stretchscale). Defaults to None.
-        stretchpower (float, optional): The input is ((data / stretchscale)**stretchpower - 1) / stretchpower / ln(10). 1 means the linear scale, while 0 means the logarithmic scale.
+        stretchscale (float): The input is asinh(data / stretchscale).
+        stretchpower (float): The input is data**stretchpower / stretchpower. 1 means the linear scale, while 0 means the logarithmic scale.
 
     Returns:
         np.ndarray: Output array in the linear scale.
@@ -167,11 +139,12 @@ def undo_stretch(x: list | np.ndarray,
     t = np.array(x)
     match stretch:
         case 'log':
-            t = 10**t
+            t = 10**t  # To be consistent with logcbticks().
         case 'asinh':
             t = np.sinh(t) * stretchscale
         case 'power':
-            t = ipow10(t, stretchpower) * stretchscale
+            p = 1e-6 if stretchpower == 0 else stretchpower
+            t = (t * p)**(1 / p)
     return t
 
 
@@ -285,9 +258,9 @@ def set_minmax(data: np.ndarray, stretch: str, stretchscale: float,
 
     Args:
         data (np.ndarray): Plotted data.
-        stretch (str): 'log', 'asinh', 'power'. Any other means linear.
-        stretchscale (float): For the arcsinh strech and the power stretch.
-        stretchpower (float): For the power strech.
+        stretch (str): 'log', 'asinh', 'power', or 'linear'. Any other means 'linear'. 'log' means the mapped data are logarithmic. 'asinh' means the mapped data are arc sin hyperbolic. 'power' means the mapped data are power-law (see also stretchpower). Defaults to 'linear'.
+        stretchscale (float): The input is asinh(data / stretchscale).
+        stretchpower (float): The input is data**stretchpower / stretchpower. 1 means the linear scale, while 0 means the logarithmic scale.
         sigma (float): Noise level.
         kw (dict): Probably like {'vmin':0, 'vmax':1}.
 
@@ -346,8 +319,7 @@ def kwargs2AstroData(kw: dict) -> AstroData:
     d = AstroData(data=np.zeros((2, 2)))
     for k in vars(d):
         if k in kw:
-            tmp[k] = kw[k]
-            del kw[k]
+            tmp[k] = kw.pop(k)
     if tmp == {}:
         print('No argument given.')
         return None
@@ -389,8 +361,7 @@ def kwargs2PlotAxes2D(kw: dict) -> PlotAxes2D:
     d = PlotAxes2D()
     for k in vars(d):
         if k in kw:
-            tmp[k] = kw[k]
-            del kw[k]
+            tmp[k] = kw.pop(k)
     d = PlotAxes2D(**tmp)
     return d
 
@@ -407,11 +378,8 @@ def kwargs2beamargs(kw: dict) -> dict:
     tmp = {}
     for k in ['show_beam', 'beamcolor', 'beampos']:
         if k in kw:
-            tmp[k] = kw[k]
-            del kw[k]
-    if 'beam_kwargs' in kw:
-        tmp.update(kw['beam_kwargs'])
-        del kw['beam_kwargs']
+            tmp[k] = kw.pop(k)
+    tmp.update(kw.pop('beam_kwargs', {}))
     return tmp
 
 
@@ -598,16 +566,8 @@ class PlotAstroData(AstroFrame):
         """
         beam_kwargs = kwargs2beamargs(kw)
         self._kw.update(kw)
-        if 'xskip' in self._kw:
-            xskip = self._kw['xskip']
-            del self._kw['xskip']
-        else:
-            xskip = 1
-        if 'yskip' in self._kw:
-            yskip = self._kw['yskip']
-            del self._kw['yskip']
-        else:
-            yskip = 1
+        xskip = self._kw.pop('xskip', 1)
+        yskip = self._kw.pop('yskip', 1)
         d = kwargs2AstroData(self._kw)
         self.read(d, xskip, yskip)
         self.beam = d.beam
@@ -736,6 +696,11 @@ class PlotAstroData(AstroFrame):
         """
         _kw = {'color': 'gray', 'fontsize': 15, 'ha': 'center',
                'va': 'center', 'zorder': 10}
+        subkeys = {'ha': 'horizontalalignment',
+                   'va': 'verticalalignment'}
+        for short, long in subkeys.items():
+            if long in kwargs:
+                kwargs[short] = kwargs.pop(long)
         _kw.update(kwargs)
         if include_chan is None:
             include_chan = self.allchan
@@ -820,7 +785,7 @@ class PlotAstroData(AstroFrame):
             linewidth (float, optional): Width of the bar. Defaults to 3.
         """
         if length == 0:
-            print('Please input length to add_scalebar().')
+            print('No length is given. Skip add_scalebar().')
             return
         if fontsize is None:
             fontsize = 20 if len(self.ax) == 1 else 15
@@ -859,20 +824,21 @@ class PlotAstroData(AstroFrame):
         font = mpl.font_manager.FontProperties(size=16)
         cb.ax.yaxis.label.set_font_properties(font)
         stretch_args = (stretch, stretchscale, stretchpower)
-        if cbticks is not None and ch // self.rowcol == 0:
-            cbticks = do_stretch(cbticks, *stretch_args)
         if cbticks is None and stretch == 'log':
-            cbticks, cbticklabels = logcbticks()
-        if cbticks is None:
+            cbticks, cbticklabels = logcbticks(10**vmin, 10**vmax)
+        if cbticks is not None:
+            cbticks = do_stretch(cbticks, *stretch_args)
+        else:
             cbticks = cb.get_ticks()
-        cond = (vmin < cbticks) * (cbticks < vmax)
-        cb.set_ticks(cbticks[cond])
+        cond = (vmin <= cbticks) * (cbticks <= vmax)
+        cbticks = cbticks[cond]
+        cb.set_ticks(cbticks)
         if cbticklabels is not None:
-            tl = np.array(cbticklabels)[cond]
+            cbticklabels = np.array(cbticklabels)[cond]
         else:
-            t = undo_stretch(cb.get_ticks(), *stretch_args)
-            tl = [f'{d:{cbformat[1:]}}' for d in t]
-        cb.set_ticklabels(tl)
+            t = undo_stretch(cbticks, *stretch_args)
+            cbticklabels = [f'{d:{cbformat[1:]}}' for d in t]
+        cb.set_ticklabels(cbticklabels)
 
     def add_color(self,
                   stretch: str = 'linear',
@@ -890,7 +856,7 @@ class PlotAstroData(AstroFrame):
         Args:
             stretch (str, optional): 'log', 'asinh', 'power', or 'linear'. Any other means 'linear'. 'log' means the mapped data are logarithmic. 'asinh' means the mapped data are arc sin hyperbolic. 'power' means the mapped data are power-law (see also stretchpower). Defaults to 'linear'.
             stretchscale (float, optional): Color scale is asinh(data / stretchscale). Defaults to None.
-            stretchpower (float, optional): Color scale is ((data / stretchscale)**stretchpower - 1) / stretchpower / ln(10). 1 means the linear scale, while 0 means the logarithmic scale. Defaults to 0.5.
+            stretchpower (float, optional): Color scale is data**stretchpower / stretchpower. 1 means the linear scale, while 0 means the logarithmic scale. Defaults to 0.5.
             show_cbar (bool, optional): Show color bar. Defaults to True.
             cblabel (str, optional): Colorbar label. Defaults to None.
             cbformat (float, optional): Format for ticklabels of colorbar. Defaults to '%.1e'.
@@ -1023,7 +989,7 @@ class PlotAstroData(AstroFrame):
         Args:
             stretch (str, optional): 'log', 'asinh', 'power', or 'linear'. Any other means 'linear'. 'log' means the mapped data are logarithmic. 'asinh' means the mapped data are arc sin hyperbolic. 'power' means the mapped data are power-law (see also stretchpower). Defaults to 'linear'.
             stretchscale (float, optional): Color scale is asinh(data / stretchscale). Defaults to None.
-            stretchpower (float, optional): Color scale is ((data / stretchscale)**stretchpower - 1) / stretchpower / ln(10). 1 means the linear scale, while 0 means the logarithmic scale. Defaults to 1.
+            stretchpower (float, optional): Color scale is data**stretchpower / stretchpower. 1 means the linear scale, while 0 means the logarithmic scale. Defaults to 1.
         """
         from PIL import Image
 
@@ -1253,7 +1219,8 @@ class PlotAstroData(AstroFrame):
             tuple: (fig, ax)
         """
         if len(self.ax) > 1:
-            print('get_figax is not supported with channel maps')
+            print('PlotAstroData.get_figax() is not supported'
+                  + ' with channel maps')
             return
 
         fig = plt.figure(0) if self.fig is None else self.fig

{plotastrodata-1.8.9 → plotastrodata-1.8.11/plotastrodata.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotastrodata
-Version: 1.8.9
+Version: 1.8.11
 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