plotastrodata 1.8.0__tar.gz → 1.8.1__tar.gz

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

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

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

{plotastrodata-1.8.0 → plotastrodata-1.8.1}/plotastrodata/noise_utils.py

@@ -1,5 +1,6 @@
 import warnings
 import numpy as np
+import matplotlib.pyplot as plt
 from scipy.special import erf
 
 from plotastrodata.fitting_utils import EmceeCorner
@@ -157,12 +158,36 @@ class Noise:
         self.std = float(self.popt[0] * self.s0)
         self.model = model(self.hbin, *self.popt)
 
+    def plot_histogram(self, savefig: dict | str | None = None,
+                       show: bool = False):
+        """Make a simple figure of the histogram and model.
+
+        Args:
+            savefig (dict or str, optional): For plt.figure().savefig(). Defaults to None.
+            show (bool, optional): True means doing plt.show(). Defaults to False.
+        """
+        savefig0 = {'bbox_inches': 'tight', 'transparent': True}
+        fig = plt.figure()
+        ax = fig.add_subplot(1, 1, 1)
+        ax.plot(self.hbin, self.hist, drawstyle='steps-mid')
+        ax.plot(self.hbin, self.model, '-')
+        ax.set_xlabel('(noise - m0) / s0')
+        ax.set_ylabel('Probability density')
+        fig.tight_layout()
+        if savefig is not None:
+            s = {'fname': savefig} if type(savefig) is str else savefig
+            savefig0.update(s)
+            fig.savefig(**savefig0)
+        if show:
+            plt.show()
+        plt.close()
+
 
 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.
+    """Estimate a noise level of a data array.
+       When a float number or None is given as sigma, this function just outputs it.
 
     Args:
         data (np.ndarray): Data array whose noise is estimated.

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

@@ -88,7 +88,7 @@ class PlotAxes2D():
         aspect (dict or float, optional): Defaults to None.
     """
     samexy: bool = True
-    loglog: bool | None = None
+    loglog: float | None = None
     xscale: str = 'linear'
     yscale: str = 'linear'
     xlim: list | None = None
@@ -99,8 +99,8 @@ class PlotAxes2D():
     yticks: list | None = None
     xticklabels: list | None = None
     yticklabels: list | None = None
-    xticksminor: list | int = None
-    yticksminor: list | int = None
+    xticksminor: list | int | None = None
+    yticksminor: list | int | None = None
     grid: dict | None = None
     aspect: dict | float | None = None
 
@@ -1170,9 +1170,12 @@ def plotprofile(coords: list[str] | str = [],
                 title: list[str] | None = None,
                 text: list[str] | None = None,
                 dist: float = 1., vsys: float = 0.,
-                nrows: int = 0, ncols: int = 1, fig=None, ax=None,
+                nrows: int = 0, ncols: int = 1,
+                fig: object | None = None,
+                ax: object | None = None,
                 getfigax: bool = False,
-                savefig: dict = None, show: bool = True,
+                savefig: dict | str | None = None,
+                show: bool = False,
                 **kwargs) -> tuple[object, object]:
     """Use Axes.plot of matplotlib to plot line profiles at given coordinates. kwargs must include the arguments of AstroData to specify the data to be plotted. kwargs can include the arguments of PlotAxes2D to adjust x and y axes.
 
@@ -1188,6 +1191,15 @@ def plotprofile(coords: list[str] | str = [],
         gauss_kwargs (dict, optional): Kwargs for Axes.plot. Defaults to {}.
         title (list, optional): For each plot. Defaults to None.
         text (list, optional): For each plot. Defaults to None.
+        dist (float, optional): Change x and y in arcsec to au. Defaults to 1..
+        vsys (float, optional): Each channel shows v-vsys. Defaults to 0..
+        nrows (int, optional): Used for channel maps. Defaults to 0.
+        ncols (int, optional): Used for channel maps. Defaults to 1.
+        fig (optional): External plt.figure(). Defaults to None.
+        ax (optional): External fig.add_subplot(). Defaults to None.
+        getfigax (bool, optional): Defaults to False.
+        savefig (dict or str, optional): For plt.figure().savefig(). Defaults to None.
+        show (bool, optional): True means doing plt.show(). Defaults to False.
 
     Returns:
         tuple: (fig, ax), where ax is a list, if getfigax=True. Otherwise, no return.
@@ -1281,7 +1293,20 @@ def plotslice(length: float, dx: float | None = None, pa: float = 0,
         length (float): Slice length.
         dx (float, optional): Grid increment. Defaults to None.
         pa (float, optional): Degree. Position angle. Defaults to 0.
-        fitsimage to show: same as in PlotAstroData.
+        dist (float, optional): For AstroFrame. Defaults to 1.
+        xoff (float, optional): For AstroFrame. Defaults to 0.
+        yoff (float, optional): For AstroFrame. Defaults to 0.
+        xflip (bool, optional): For AstroFrame. Defaults to True.
+        yflip (bool, optional): For AstroFrame. Defaults to False.
+        txtfile (str, optional): File name for numpy.savetxt(). Defaults to None.
+        fig (optional): External plt.figure(). Defaults to None.
+        ax (optional): External fig.add_subplot(). Defaults to None.
+        getfigax (bool, optional): Defaults to False.
+        savefig (dict or str, optional): For plt.figure().savefig(). Defaults to None.
+        show (bool, optional): True means doing plt.show(). Defaults to False.
+
+    Returns:
+        tuple: (fig, ax), where ax is a list, if getfigax=True. Otherwise, no return.
     """
     _kw = {'linestyle': '-', 'marker': 'o'}
     _kw.update(kwargs)

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

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