plotastrodata 1.1.4__tar.gz → 1.2.0__tar.gz

{plotastrodata-1.1.4 → plotastrodata-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plotastrodata
-Version: 1.1.4
+Version: 1.2.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.1.4 → plotastrodata-1.2.0}/plotastrodata/__init__.py

@@ -1,4 +1,4 @@
 import warnings
 
 warnings.simplefilter('ignore', UserWarning)
-__version__ = '1.1.4'
+__version__ = '1.2.0'

{plotastrodata-1.1.4 → plotastrodata-1.2.0}/plotastrodata/analysis_utils.py

@@ -161,6 +161,7 @@ class AstroData():
         center (str, optional): Text coordinates. 'common' means initialized value. Defaults to 'common'.
         restfreq (float, optional): Used for velocity and brightness T. Defaults to None.
         cfactor (float, optional): Output data times cfactor. Defaults to 1.
+        pvpa (float, optional): Position angle of the PV cut. Defaults to None.
     """
     data: np.ndarray | None = None
     x: np.ndarray | None = None
@@ -173,6 +174,7 @@ class AstroData():
     center: str = 'common'
     restfreq: float | None = None
     cfactor: float = 1
+    pvpa: float | None = None
 
     def __post_init__(self):
         n = 0
@@ -707,6 +709,8 @@ class AstroFrame():
             d.fitsheader = [d.fitsheader] * d.n
         if type(d.pv) is not list:
             d.pv = [d.pv] * d.n
+        if type(d.pvpa) is not list:
+            d.pvpa = [d.pvpa] * d.n
         grid0 = [d.x, d.y, d.v]
         for i in range(d.n):
             if d.center[i] == 'common':
@@ -791,3 +795,4 @@ class AstroFrame():
             d.sigma_org = d.sigma_org[0]
             d.fitsheader = d.fitsheader[0]
             d.pv = d.pv[0]
+            d.pvpa = d.pvpa[0]

{plotastrodata-1.1.4 → plotastrodata-1.2.0}/plotastrodata/const_utils.py

@@ -81,4 +81,4 @@ quecto = 1e-30
 # Others
 mumol = 2.37 * m_p  # kg; Kauffmann et al. 2008, for sound speed
 muH2 = 2.8 * m_p  # kg; Kauffmann et al. 2008, for mass-H2 conversion
-c_kms = constants.c.to('km*s**(-1)').value
+c_kms = constants.c.to('km*s**(-1)').value

{plotastrodata-1.1.4 → plotastrodata-1.2.0}/plotastrodata/fits_utils.py

@@ -255,7 +255,7 @@ class FitsData:
                     print(f'Unknown CUNIT3 {cunitv} found.'
                           + ' v is read as is.')
                     s = s - vsys
-            
+
             self.v, self.dv = s, s[1] - s[0]
 
         if h['NAXIS'] > 0 and h['NAXIS1'] > 1:

{plotastrodata-1.1.4 → plotastrodata-1.2.0}/plotastrodata/plot_utils.py

@@ -356,12 +356,11 @@ class PlotAstroData(AstroFrame):
             else:
                 v = v[:k1]
         if self.pv or v is None or len(v) == 1:
-            nv = nrows = ncols = npages = nchan = nchanplot = 1
+            nv = nrows = ncols = npages = nchan = 1
         else:
             nv = len(v := v[::vskip])
             npages = int(np.ceil(nv / nrows / ncols))
             nchan = npages * nrows * ncols
-            nchanplot = len(v)
             v = np.r_[v, v[-1] + (np.arange(nchan-nv)+1) * (v[1] - v[0])]
             if type(channelnumber) is int:
                 nchan = npages = 1
@@ -379,15 +378,15 @@ class PlotAstroData(AstroFrame):
             fontsize = 18 if nchan == 1 else 12
         set_rcparams(fontsize=fontsize, nancolor=nancolor, dpi=dpi)
         ax = np.empty(nchan, dtype='object') if internalax else [ax]
+        if figsize is None:
+            sqrt_a = (self.ymax - self.ymin) / (self.xmax - self.xmin)
+            sqrt_a = np.sqrt(np.abs(sqrt_a))
+            if nchan == 1:
+                figsize = (7 / sqrt_a, 5 * sqrt_a)
+            else:
+                figsize = (ncols * 2 / sqrt_a, max(nrows*2, 3) * sqrt_a)
         for ch in range(nchan):
             n, i, j = ch2nij(ch)
-            if figsize is None:
-                sqrt_a = (self.ymax - self.ymin) / (self.xmax - self.xmin)
-                sqrt_a = np.sqrt(np.abs(sqrt_a))
-                if nchan == 1:
-                    figsize = (7 / sqrt_a, 5 * sqrt_a)
-                else:
-                    figsize = (ncols * 2 / sqrt_a, max(nrows*2, 3) * sqrt_a)
             if internalfig:
                 fig = plt.figure(n, figsize=figsize)
             sharex = ax[nij2ch(n, i - 1, j)] if i > 0 else None
@@ -397,8 +396,8 @@ class PlotAstroData(AstroFrame):
                                          sharex=sharex, sharey=sharey)
             if nchan > 1 or type(channelnumber) is int:
                 fig.subplots_adjust(hspace=0, wspace=0, right=0.87, top=0.87)
-                vellabel = v[ch] if channelnumber is None else v[channelnumber]
-                if ch < nchanplot:
+                if ch < nv:
+                    vellabel = v[ch] if channelnumber is None else v[channelnumber]
                     ax[ch].text(0.9 * self.rmax, 0.7 * self.rmax,
                                 rf'${vellabel:.{veldigit:d}f}$', color='black',
                                 backgroundcolor='white', zorder=20)
@@ -406,7 +405,7 @@ class PlotAstroData(AstroFrame):
         self.ax = ax
         self.rowcol = nrows * ncols
         self.npages = npages
-        self.allchan = np.arange(nchan if channelnumber is None else nv)
+        self.allchan = np.arange(nv)
         self.bottomleft = nij2ch(np.arange(npages), nrows - 1, 0)
         self.channelnumber = channelnumber
 
@@ -484,25 +483,62 @@ class PlotAstroData(AstroFrame):
     def add_beam(self,
                  beam: list[float | None, float | None, float | None] = [None, None, None],
                  beamcolor: str = 'gray',
-                 poslist: list[str | list[float, float]] | None = None) -> None:
+                 poslist: list[str | list[float, float]] | None = None,
+                 dv: float | None = None, pvpa: float | None = None) -> None:
         """Use add_region().
 
         Args:
             beam (list, optional): [bmaj, bmin, bpa]. Defaults to [None, None, None].
             beamcolor (str, optional): matplotlib color. Defaults to 'gray'.
             poslist (list, optional): text or relative. Defaults to None.
+            dv (float, optional): velocity resolution for a PV diagram. Defaults to None.
+            pvpa (float, optional): position angle of the PV cut in the unit of degrees. Defaults to None.
         """
         if None in beam:
             print('No beam to plot.')
             return False
 
-        if poslist is None:
-            poslist = [max(0.35 * beam[0] / self.rmax, 0.1)] * 2
         include_chan = self.bottomleft if self.channelnumber is None else self.allchan
-        self.add_region('ellipse', poslist, *beam,
+        if self.pv:
+            if pvpa is None:
+                pvpa = beam[0]
+                print('pvpa is not specified. pvpa=bmaj is assumed.')
+            p = np.radians(beam[2] - pvpa)
+            b = 1 / np.hypot(np.cos(p) / beam[0], np.sin(p) / beam[1]) / self.rmax
+            b = np.array([b, dv])
+            if poslist is None:
+                poslist = [max(0.35 * b[0], 0.1), 0.1]
+            if self.swapxy:
+                poslist = np.transpose(poslist)
+                b = np.transpose(b)
+            b = np.append(b, 0)
+            patch = 'rectangle'
+        else:
+            if poslist is None:
+                poslist = [max(0.35 * beam[0] / self.rmax, 0.1)] * 2
+            b = beam
+            patch = 'ellipse'
+        self.add_region(patch, poslist, *b,
                         include_chan=include_chan,
                         facecolor=beamcolor, edgecolor=None)
 
+    def _beam(self, show_beam: bool, beamcolor: str | list[str], d: AstroData):
+        """Internal wrapper of add_beam().
+
+        Args:
+            show_beam (bool): Whether to show the beam(s).
+            beamcolor (str | list[str]): Color name.
+            d (AstroData): For reading the velocity resolution, beam, and pvpa.
+        """
+        if show_beam:
+            dv = d.v[1] - d.v[0] if self.pv else None
+            c = type(beamcolor) is list
+            beam = d.beam if c else [d.beam]
+            bc = beamcolor if c else [beamcolor]
+            pvpa = d.pvpa if c else [d.pvpa]
+            for i in range(len(bc)):
+                self.add_beam(beam=beam[i], beamcolor=bc[i], dv=dv, pvpa=pvpa[i])
+
     def add_marker(self, poslist: list[str | list[float, float]] = [],
                    include_chan: list[int] | None = None, **kwargs) -> None:
         """Use Axes.plot of matplotlib.
@@ -715,8 +751,7 @@ class PlotAstroData(AstroFrame):
                     ticklin = 1 + (1 - stretchpower) * np.log(10) * t
                     ticklin = cmin_org * ticklin**(1 / (1 - stretchpower))
                 cb.set_ticklabels([f'{d:{cbformat[1:]}}' for d in ticklin])
-        if show_beam and not self.pv:
-            self.add_beam(beam, beamcolor)
+        self._beam(show_beam, beamcolor, d)
 
     def add_contour(self, xskip: int = 1, yskip: int = 1,
                     levels: list[float] = [-12, -6, -3, 3, 6, 12, 24, 48, 96, 192, 384],
@@ -742,8 +777,7 @@ class PlotAstroData(AstroFrame):
             c = [c[self.channelnumber]]
         for axnow, cnow in zip(self.ax, c):
             axnow.contour(x, y, cnow, np.sort(levels) * sigma, **_kw)
-        if show_beam and not self.pv:
-            self.add_beam(beam, beamcolor)
+        self._beam(show_beam, beamcolor, d)
 
     def add_segment(self, ampfits: str = None, angfits: str = None,
                     Ufits: str = None, Qfits: str = None,
@@ -809,8 +843,7 @@ class PlotAstroData(AstroFrame):
         _kw['scale'] = 1 if len(x) == 1 else 1. / np.abs(x[1] - x[0])
         for axnow, unow, vnow in zip(self.ax, U, V):
             axnow.quiver(x, y, unow, vnow, **_kw)
-        if show_beam and not self.pv:
-            self.add_beam(beam, beamcolor)
+        self._beam(show_beam, [beamcolor] * 2, d)
 
     def add_rgb(self, xskip: int = 1, yskip: int = 1,
                 stretch: list[str, str, str] = ['linear'] * 3,
@@ -860,9 +893,7 @@ class PlotAstroData(AstroFrame):
                     im.putpixel((i, j), value)
             axnow.imshow(im, extent=[x[0], x[-1], y[0], y[-1]])
             axnow.set_aspect(np.abs((x[-1]-x[0]) / (y[-1]-y[0])))
-        if show_beam and not self.pv:
-            for i in range(3):
-                self.add_beam(beam[i], beamcolor[i])
+        self._beam(show_beam, beamcolor, d)
 
     def set_axis(self, title: dict | str | None = None, **kwargs) -> None:
         """Use Axes.set_* of matplotlib. kwargs can include the arguments of PlotAxes2D to adjust x and y axis.

{plotastrodata-1.1.4 → plotastrodata-1.2.0}/plotastrodata.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plotastrodata
-Version: 1.1.4
+Version: 1.2.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