Merge pull request #30 from sdss/boss

updated path with special functions to flag plates and zero pad fieldIDs for relevant run2d version

Author: havok2063

CHANGELOG.rst

@@ -6,6 +6,10 @@ Change Log
 
 This document records the main changes to the sdss_access code.
 
+2.0.2 (unreleased)
+------------------
+- Adds new `isplate` and `pad_fieldid` special functions for BHM paths.
+
 2.0.1 (2022-05-13)
 ------------------
 - Adds new `configgrp` special function.

python/sdss_access/path/path.py

@@ -328,6 +328,10 @@ def extract(self, name, example):
             template = re.sub('@healpixgrp[|]', '{healpixgrp}', template)
         elif re.search('@configgrp[|]', template):
             template = re.sub('@configgrp[|]', '{configgrp}', template)
+        elif re.search('@isplate[|]', template):
+            template = re.sub('@isplate[|]', '{isplate}', template)
+        elif re.search('@pad_fieldid[|]', template):
+           template = re.sub('@pad_fieldid[|]', '{fieldid}', template)
         if re.search('@plateid6[|]', template):
             template = re.sub('@plateid6[|]', '{plateid:0>6}', template)
 
@@ -1293,5 +1297,56 @@ def configgrp(self, filetype, **kwargs):
             return '0000XX'
         return '{:0>4d}XX'.format(int(configid) // 100)
 
+    def isplate(self, filetype, **kwargs):
+        ''' Returns the plate flag for BOSS idlspec2d run2d versions that utilize it
+
+        Parameters
+        ---------
+        filetype : str
+            File type paramter
+        run2d : str
+            BOSS idlspec2d run2d version
+
+        Returns
+        -------
+        isplate : str
+            isplate flag = 'p' for relevent run2d plates else flag = ''
+        '''
+
+        run2d = kwargs.get('run2d', None)
+        if not run2d:
+            return ''
+        if run2d in ['v6_0_1','v6_0_2', 'v6_0_3', 'v6_0_4']:
+            return 'p'
+        return ''
+
+    def pad_fieldid(self, filetype, **kwargs):
+        ''' Returns the fieldid zero padded to its proper length for the BOSS idlspec2d run2d version
+
+        Parameters
+        ---------
+        filetype : str
+            File type paramter
+        run2d : str
+            BOSS idlspec2d run2d version
+        fieldid : str or int
+            Field ID number. Will be converted to str internally.
+
+        Returns
+        -------
+        fieldid : str
+            padd_fieldid in the form of N*'0' where N is the number of necessary zeros to pad fieldid
+        '''
+
+        fieldid = kwargs.get('fieldid', None)
+        run2d = kwargs.get('run2d', None)
+
+        if (not run2d) & (not fieldid):
+            return ''
+        if run2d in ['v6_0_1','v6_0_2', 'v6_0_3', 'v6_0_4']:
+            return str(fieldid)
+        return str(fieldid).zfill(6)
+
+
 class AccessError(Exception):
     pass

tests/path/test_sdss5.py

@@ -46,8 +46,19 @@ def test_apogee_paths(self, path, name, special, keys, exp):
                               ('apField', '@apgprefix', {'telescope': 'lco25m', 'apred': 'r12', 'field': '2J01'},
                                'redux/r12/stars/lco25m/2J01/asField-2J01.fits'),
                               ('apHist', '@apgprefix', {'apred': 'r12', 'mjd': '52123', 'chip':'b', 'instrument': 'apogee-n'},
-                               'r12/exposures/apogee-n/52123/apHist-b-52123.fits')],
-                             ids=['configgrp', 'apgprefix-apo', 'apgprefix-lco', 'apgprefix-ins'])
+                               'r12/exposures/apogee-n/52123/apHist-b-52123.fits'),
+                              ('spField', '@isplate', {'run2d': 'v6_0_4', 'mjd': '59187', 'fieldid': '15007'},
+                                'v6_0_4/15007p/spField-15007-59187.fits'),
+                              ('spField', '@pad_fieldid', {'run2d': 'v6_0_8', 'mjd': '59630', 'fieldid': '021160'},
+                                'v6_0_8/021160/spField-021160-59630.fits'),
+                              ('spField', '@pad_fieldid', {'run2d': 'v6_0_8', 'mjd': '59760', 'fieldid': '112359'},
+                                'v6_0_8/112359/spField-112359-59760.fits'),
+                              ('spFrame', '@pad_fieldid', {'run2d': 'v6_0_8', 'br': 'b', 'id': '1', 'frame': '5432', 'fieldid':'1234'},
+                                'v6_0_8/001234/spFrame-b1-00005432.fits.gz'),
+                              ('spFrame', '@pad_fieldid', {'run2d': 'v6_0_4', 'br': 'b', 'id': '1', 'frame': '5432', 'fieldid':'1234'},
+                                'v6_0_4/1234p/spFrame-b1-00005432.fits.gz')],
+                             ids=['configgrp', 'apgprefix-apo', 'apgprefix-lco', 'apgprefix-ins',
+                                  'isplate-v6_0_4','pad_fieldid-5','pad_fieldid-6', 'frame-pad', 'frame-nopadp'])
     def test_special_function(self, path, name, special, keys, exp):
         assert special in path.templates[name]
         full = path.full(name, **keys)