teareduce 0.4.3__py3-none-any.whl → 0.4.5__py3-none-any.whl

teareduce/imshow.py

@@ -30,10 +30,15 @@ def imshowme(data, **kwargs):
         Instance of Axes.
     img : matplotlib AxesImage
         Instance returned by ax.imshow()
+    cax : matplotlib.axes.Axes or None
+        Instance of Axes where the color bar is drawn, or None if
+        colorbar is False.
+    cbar : matplotlib.colorbar.Colorbar or None
+        Instance of Colorbar, or None if colorbar is False.
     """
     fig, ax = plt.subplots()
-    img = imshow(fig=fig, ax=ax, data=data, **kwargs)
-    return fig, ax, img
+    img, cax, cbar = imshow(fig=fig, ax=ax, data=data, **kwargs)
+    return fig, ax, img, cax, cbar
 
 
 def imshow(fig=None, ax=None, data=None,
@@ -85,7 +90,11 @@ def imshow(fig=None, ax=None, data=None,
     ------
     img : matplotlib AxesImage
         Instance returned by ax.imshow()
-
+    cax : matplotlib.axes.Axes or None
+        Instance of Axes where the color bar is drawn, or None if
+        colorbar is False.
+    cbar : matplotlib.colorbar.Colorbar or None
+        Instance of Colorbar, or None if colorbar is False.
     """
 
     # protections
@@ -101,6 +110,7 @@ def imshow(fig=None, ax=None, data=None,
     if ylabel is None:
         ylabel = 'Y axis (array index)'
 
+    wavecalib = False
     if crpix1 is not None and crval1 is not None and cdelt1 is not None and cunit1 is not None:
         if 'extent' in kwargs:
             raise ValueError('extent parameter can not be used with a wavelength calibration scale')
@@ -112,9 +122,12 @@ def imshow(fig=None, ax=None, data=None,
         u_pixel = Unit('pixel')
         xminwv = crval1 + (xmin * u_pixel - crpix1 + 1 * u_pixel) * cdelt1
         xmaxwv = crval1 + (xmax * u_pixel - crpix1 + 1 * u_pixel) * cdelt1
-        extent = [xminwv.to(cunitx).value, xmaxwv.to(cunitx).value, ymin, ymax]
+        xminwv = xminwv.to(cunitx).value
+        xmaxwv = xmaxwv.to(cunitx).value
+        extent = [xminwv, xmaxwv, ymin, ymax]
         xlabel = f'Wavelength ({cunitx})'
         aspect = 'auto'
+        wavecalib = True
     else:
         if 'extent' in kwargs:
             extent = kwargs['extent']
@@ -143,9 +156,25 @@ def imshow(fig=None, ax=None, data=None,
     if title is not None:
         ax.set_title(title)
 
+    # if a wavelength calibration is provided, display the index scale
+    # on the top horizontal axis
+    if wavecalib:
+
+        def index2coord(i):
+            return xminwv + (xmaxwv - xminwv) * i / (naxis1 - 1)
+
+        def coord2index(x):
+            return (naxis1 - 1) * (x - xminwv) / (xmaxwv - xminwv)
+
+        ax_top = ax.secondary_xaxis('top', functions=(coord2index, index2coord))
+        ax_top.set_xlabel('X axis (array index)')
+
     if colorbar:
         divider = make_axes_locatable(ax)
         cax = divider.append_axes("right", size="5%", pad=0.05, axes_class=Axes)
-        fig.colorbar(img, cax=cax, label=cblabel)
+        cbar = fig.colorbar(img, cax=cax, label=cblabel)
+    else:
+        cax = None
+        cbar = None
 
-    return img
+    return img, cax, cbar

teareduce/tests/test_version.py

@@ -0,0 +1,8 @@
+
+from ..version import main, VERSION
+
+def test_main(capsys):
+    msg = f"Version: {VERSION}\n"
+    main()
+    captured = capsys.readouterr()
+    assert captured.out == msg

teareduce/version.py

@@ -9,7 +9,7 @@
 #
 """Module to define the version of the teareduce package."""
 
-VERSION = '0.4.3'
+VERSION = '0.4.5'
 
 
 def main():

{teareduce-0.4.3.dist-info → teareduce-0.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: teareduce
-Version: 0.4.3
+Version: 0.4.5
 Summary: Utilities for astronomical data reduction
 Author-email: Nicolás Cardiel <cardiel@ucm.es>
 License: GPL-3.0-or-later
@@ -30,7 +30,24 @@ Requires-Dist: pytest; extra == "test"
 Dynamic: license-file
 
 # teareduce
-Utilities for astronomical data reduction
+
+Utilities for astronomical data reduction.
+
+This package is not intended to be a general-purpose image reduction code. It
+only includes specific operations required in certain steps of the traditional
+astronomical image reduction process that, at the time of its creation, were
+not available in more established packages such as
+[ccdproc](https://ccdproc.readthedocs.io/en/latest/). In addition, it also
+offers alternative ways to perform certain tasks that we have found to be more
+practical for use in Master’s level classes.
+
+
+## Documentation
+
+The documentation for this package is available at [this
+link](https://guaix.fis.ucm.es/~tea/teareduce-cookbook/_build/html/intro.html).
+It includes Juypter notebooks that can be easily downloaded and demonstrate the
+practical use of the defined functionality.
 
 ## Installing the code
 
@@ -72,5 +89,6 @@ The latest development version is available through [GitHub](https://github.com/
 (venv_teareduce) $ ipython
 In [1]: import teareduce as tea
 In [2]: print(tea.__version__)
-0.2.1
+0.4.3
 ```
+

{teareduce-0.4.3.dist-info → teareduce-0.4.5.dist-info}/RECORD

@@ -6,7 +6,7 @@ teareduce/ctext.py,sha256=8QP_KW7ueJ34IUyduVpy7nk-x0If5eilawf87icDMJA,2084
 teareduce/draw_rectangle.py,sha256=xlwcKIkl7e0U6sa9zWZr8t_WuWAte_UKIqCwZQ41x4Q,1922
 teareduce/elapsed_time.py,sha256=QWakPeiOUA__WpjjFREnodKqW1FZzVGWstab0N3Ro6k,1418
 teareduce/histogram1d.py,sha256=3hlvcI8XPRmZ27H_sFmyL26gIcbJozk07ELBKWtngQk,2835
-teareduce/imshow.py,sha256=5j5RFoZOWBkF8CzUSLTR8-fNuuZHOFCMgH2CMOaDu50,4878
+teareduce/imshow.py,sha256=G_PxvCpv8Loa3jZX0h_9ZG6yTF-QdMojoPLOedo6s-g,5986
 teareduce/numsplines.py,sha256=1PpG-frdc9Qz3VRbC7XyZFWKmhus05ID4REtFnWDmUo,8049
 teareduce/peaks_spectrum.py,sha256=YPCJz8skJmIjWYqT7ZhBJGhnqPayFwy5xb7I9OHlUZI,9890
 teareduce/polfit.py,sha256=CGsrRsz_Du2aKxOcgXi36lpAZO04JyqCCUaxhC0C-Mk,14281
@@ -15,14 +15,15 @@ teareduce/sdistortion.py,sha256=5ZsZn4vD5Sw2aoqO8-NIOH7H89Zmh7ZDkow6YbAotHU,5916
 teareduce/simulateccdexposure.py,sha256=cdbpca6GVuM3d7R1LGzlIZZvjTq_jzrlkk_Cli7aouQ,24636
 teareduce/sliceregion.py,sha256=0h1xYcNG4mkJhR6bdaDe9pF2_MCuGeLJC7WVbbMZy8E,14977
 teareduce/statsummary.py,sha256=mtaM21d5aHvtLjCt_SSDMvD_fjI5nK21ZqxuDtcvldI,5426
-teareduce/version.py,sha256=SH9n_ZVdY2JuLjfax6Is4ri1SsZNjB9mWwd__OBJx0Y,419
+teareduce/version.py,sha256=5hcd5X42P8i74DCHN__pi2mwMbFrq_7s_6ZInGK6sOI,419
 teareduce/wavecal.py,sha256=iiKG_RPW2CllwZxG5fTsyckE0Ec_IeZ6v7v2cQt6OeU,68706
 teareduce/write_array_to_fits.py,sha256=kWDrEH9coJ1yIu56oQJpWtDqJL4c8HGmssE9jle4e94,617
 teareduce/zscale.py,sha256=HuPYagTW55D7RtjPGc7HcibQlCx5oqLYHKoM6WEHG2g,1161
 teareduce/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 teareduce/tests/test_sliceregion.py,sha256=25dhS7yJ1z_3tgFLw21uOkNKuugyVA-8L1ehafSQjFg,1769
-teareduce-0.4.3.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-teareduce-0.4.3.dist-info/METADATA,sha256=xj4Kdw08405olw1sdCcZ1ybcK65YPlOA9qxk6ou9sTk,2246
-teareduce-0.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-teareduce-0.4.3.dist-info/top_level.txt,sha256=7OkwtX9zNRkGJ7ACgjk4ESgC74qUYcS5O2qcO0v-Si4,10
-teareduce-0.4.3.dist-info/RECORD,,
+teareduce/tests/test_version.py,sha256=mKLnbXyvVNc1pATq5PxR8qeoFMPAFL_GilFV6IHLOi0,172
+teareduce-0.4.5.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+teareduce-0.4.5.dist-info/METADATA,sha256=n9hHTG2LOCEv2CnYdMi383O1krY9S6tD-rsv0efSdUE,3017
+teareduce-0.4.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+teareduce-0.4.5.dist-info/top_level.txt,sha256=7OkwtX9zNRkGJ7ACgjk4ESgC74qUYcS5O2qcO0v-Si4,10
+teareduce-0.4.5.dist-info/RECORD,,