Merge branch 'develop' into aat_uhrf

# Conflicts:
#	doc/releases/1.16.1dev.rst

doc/releases/1.16.1dev.rst

@@ -64,6 +64,8 @@ Script Changes
 - Added the ``--extr`` parameter in the ``pypeit_sensfunc`` script (also as a SensFuncPar)
   to allow the user to specify the extraction method to use when computing the sensitivity
   function (before only optimal extraction was used).
+- Added ``pypeit_chk_flexure`` script to check both spatial and spectral flexure applied to
+  the reduced data.
 - Treatment of file names is now more formal.  Compression signatures are now
   considered, and filename matching is now more strict.
 

pypeit/core/flexure.py

@@ -17,6 +17,7 @@
 from astropy import stats
 from astropy import units
 from astropy.io import ascii
+from astropy.table import Table
 import scipy.signal
 import scipy.optimize as opt
 from scipy import interpolate
@@ -36,7 +37,7 @@
 from pypeit.datamodel import DataContainer
 from pypeit.images.detector_container import DetectorContainer
 from pypeit.images.mosaic import Mosaic
-from pypeit import specobj, specobjs
+from pypeit import specobj, specobjs, spec2dobj
 from pypeit import wavemodel
 
 from IPython import embed
@@ -1394,6 +1395,80 @@ def sky_em_residuals(wave:np.ndarray, flux:np.ndarray,
     return dwave[m], diff[m], diff_err[m], los[m], los_err[m]
 
 
+def flexure_diagnostic(file, file_type='spec2d', flexure_type='spec', chk_version=False):
+    """
+    Print the spectral or spatial flexure of a spec2d or spec1d file
+    Args:
+        file (:obj:`str`, `Path`_):
+            Filename of the spec2d or spec1d file to check
+        file_type (:obj:`str`, optional):
+            Type of the file to check. Options are 'spec2d' or 'spec1d'. Default is 'spec2d'.
+        flexure_type (:obj:`str`, optional):
+            Type of flexure to check. Options are 'spec' or 'spat'. Default is 'spec'.
+        chk_version (:obj:`bool`, optional):
+            If True, raise an error if the datamodel version or type check failed.
+            If False, throw a warning only. Default is False.
+
+    Returns:
+        :obj:`astropy.table.Table` or :obj:`float`:
+        - If file_type is 'spec2d' and flexure_type is 'spec', return a table with the spectral flexure
+        - If file_type is 'spec2d' and flexure_type is 'spat', return the spatial flexure
+        - If file_type is 'spec1d', return a table with the spectral flexure
+
+    """
+
+    # value to return
+    return_flex = None
+
+    if file_type == 'spec2d':
+        # load the spec2d file
+        allspec2D = spec2dobj.AllSpec2DObj.from_fits(file, chk_version=chk_version)
+        # Loop on Detectors
+        for det in allspec2D.detectors:
+            print('')
+            print('=' * 50 + f'{det:^7}' + '=' * 51)
+            # get and print the spectral flexure
+            if flexure_type == 'spec':
+                spec_flex = allspec2D[det].sci_spec_flexure
+                spec_flex.rename_column('sci_spec_flexure', 'global_spec_shift')
+                if np.all(spec_flex['global_spec_shift'] != None):
+                    spec_flex['global_spec_shift'].format = '0.3f'
+                # print the table
+                spec_flex.pprint_all()
+                # return the table
+                return_flex = spec_flex
+            # get and print the spatial flexure
+            if flexure_type == 'spat':
+                spat_flex = allspec2D[det].sci_spat_flexure
+                # print the value
+                print(f'Spat shift: {spat_flex}')
+                # return the value
+                return_flex = spat_flex
+    elif file_type == 'spec1d':
+        # no spat flexure in spec1d file
+        if flexure_type == 'spat':
+            msgs.error("Spat flexure not available in the spec1d file, try with a spec2d file")
+        # load the spec1d file
+        sobjs = specobjs.SpecObjs.from_fitsfile(file, chk_version=chk_version)
+        spec_flex = Table()
+        spec_flex['NAME'] = sobjs.NAME
+        spec_flex['global_spec_shift'] = sobjs.FLEX_SHIFT_GLOBAL
+        if np.all(spec_flex['global_spec_shift'] != None):
+            spec_flex['global_spec_shift'].format = '0.3f'
+        spec_flex['local_spec_shift'] = sobjs.FLEX_SHIFT_LOCAL
+        if np.all(spec_flex['local_spec_shift'] != None):
+            spec_flex['local_spec_shift'].format = '0.3f'
+        spec_flex['total_spec_shift'] = sobjs.FLEX_SHIFT_TOTAL
+        if np.all(spec_flex['total_spec_shift'] != None):
+            spec_flex['total_spec_shift'].format = '0.3f'
+        # print the table
+        spec_flex.pprint_all()
+        # return the table
+        return_flex = spec_flex
+
+    return return_flex
+
+
 # TODO -- Consider separating the methods from the DataContainer as per calibrations
 class MultiSlitFlexure(DataContainer):
     """

pypeit/scripts/__init__.py

@@ -9,6 +9,7 @@
 from pypeit.scripts import chk_alignments
 from pypeit.scripts import chk_edges
 from pypeit.scripts import chk_flats
+from pypeit.scripts import chk_flexure
 from pypeit.scripts import chk_tilts
 from pypeit.scripts import chk_for_calibs
 from pypeit.scripts import chk_noise_1dspec

pypeit/scripts/chk_flexure.py

@@ -0,0 +1,63 @@
+"""
+This script displays the flexure (spatial or spectral) applied to the science data.
+
+.. include common links, assuming primary doc root is up one directory
+.. include:: ../include/links.rst
+"""
+
+from pypeit.scripts import scriptbase
+
+
+class ChkFlexure(scriptbase.ScriptBase):
+
+    @classmethod
+    def get_parser(cls, width=None):
+        parser = super().get_parser(description='Print QA on flexure to the screen',
+                                    width=width)
+
+        parser.add_argument('input_file', type=str, nargs='+', help='One or more PypeIt spec2d or spec1d file')
+        inp = parser.add_mutually_exclusive_group(required=True)
+        inp.add_argument('--spec', default=False, action='store_true', help='Check the spectral flexure')
+        inp.add_argument('--spat', default=False, action='store_true', help='Check the spatial flexure')
+        parser.add_argument('--try_old', default=False, action='store_true',
+                            help='Attempt to load old datamodel versions.  A crash may ensue..')
+        return parser
+
+    @staticmethod
+    def main(args):
+
+        from IPython import embed
+        from astropy.io import fits
+        from pypeit import msgs
+        from pypeit.core import flexure
+
+        chk_version = not args.try_old
+
+        # Loop over the input files
+        for in_file in args.input_file:
+
+            msgs.info(f'Checking fluxure for file: {in_file}')
+
+            # What kind of file are we??
+            hdul = fits.open(in_file)
+            head0 = hdul[0].header
+            file_type = None
+            if 'PYP_CLS' in head0.keys() and head0['PYP_CLS'].strip() == 'AllSpec2DObj':
+                file_type = 'spec2d'
+            elif 'DMODCLS' in head0.keys() and head0['DMODCLS'].strip() == 'SpecObjs':
+                file_type = 'spec1d'
+            else:
+                msgs.error("Bad file type input!")
+
+            # Check the flexure
+            flexure.flexure_diagnostic(in_file, file_type=file_type, flexure_type='spat' if args.spat else 'spec',
+                                       chk_version=chk_version)
+
+            #  space between files for clarity
+            print('')
+
+
+
+
+
+

setup.cfg

@@ -110,6 +110,7 @@ console_scripts =
     pypeit_arxiv_solution = pypeit.scripts.arxiv_solution:ArxivSolution.entry_point
     pypeit_cache_github_data = pypeit.scripts.cache_github_data:CacheGithubData.entry_point
     pypeit_clean_cache = pypeit.scripts.clean_cache:CleanCache.entry_point
+    pypeit_chk_flexure = pypeit.scripts.chk_flexure:ChkFlexure.entry_point
     pypeit_chk_for_calibs = pypeit.scripts.chk_for_calibs:ChkForCalibs.entry_point
     pypeit_chk_noise_1dspec = pypeit.scripts.chk_noise_1dspec:ChkNoise1D.entry_point
     pypeit_chk_noise_2dspec = pypeit.scripts.chk_noise_2dspec:ChkNoise2D.entry_point