ogip_dictionary.py

from ogip_dictionary_timing import ogip_dictionary_timing
from ogip_dictionary_spectral import ogip_dictionary_spectral
from ogip_dictionary_caldb import ogip_dictionary_caldb
from ogip_dictionary_arf import ogip_dictionary_arf
from ogip_dictionary_rmf import ogip_dictionary_rmf
from ogip_dictionary_image import ogip_dictionary_image
import os


def ogip_dictionary(type,meta_key=None):
    import ogip_generic_lib

    """
    for a given OGIP file type (timing, etc),
    returns a dictionary giving the extnames, the keywords and columns for that extension, and whether the
    entry is required (1) or recommended (0), and the specific values for the entry, if any
    An asterisk (*) as the final character of a keyword indicates that the keyword root can have multiple values,
    for example: MJDREF (MJDREFI + MJDREFF), E_MIN1...E_MINn, etc
    Other Special Characters:
        a "+" is used if values are tied - if one appears the others need to appear ("MJDREFI + MJDREFF")
        a "|" separates names which can be used as alternates ("MJDREF | MJDREFI + MJDREFF")
        Square brackets "[ ]" mark required keyword values "HDUCLASS[OGIP]"

    Allowed OGIP types:
        type = TIMING, SPECTRAL, CALDB, ARF, RMF
    @param extname:
    @return:
    """
    """
    this function returns the  required and optional keywords and columns
    as defined by OGIP 93-003 (TIMING), 92-007 (SPECTRAL), 92-002 and 92-002a (ARF and RMF) for a given extension
    """
    #########################################
    #  Get the base dictionary:
    if type.strip().upper() == 'TIMING':
        ogip=ogip_dictionary_timing()
    elif type.strip().upper() == 'SPECTRAL':
        ogip=ogip_dictionary_spectral()
    elif type.strip().upper() == 'CALDB':
        ogip=ogip_dictionary_caldb()
    elif type.strip().upper() == 'ARF':
        ogip=ogip_dictionary_arf()
    elif type.strip().upper() == 'RMF':
        ogip=ogip_dictionary_rmf()
    elif type.strip().upper() == 'IMAGE':
        ogip=ogip_dictionary_image()
    else:
        print "Currently defined for"
        print "Type = TIMING, SPECTRAL, CALDB, ARF, RMF, or IMAGE."
        ogip = 0


    #########################################
    #  Replace/add items in dictionary if found in the given meta data file.  
    if meta_key is not None:
        meta=ogip_generic_lib.ogip_get_meta(meta_key)

        #  The meta table is minimal, so things are only there if
        #  needed.  First check each of the keys that have a single
        #  string value.  Then check the EXTENSIONS and ALT_EXTNS, which are
        #  dictionary types.  Then loop over keyword and column
        #  requirements for each extension defined.  If the meta data
        #  includes the full requirement ("level" and "req") for each
        #  "key", then replace the whole thing.  But if it is only the
        #  level, then don't touch the original requirement.
        if "dicts" in meta and type in meta["dicts"]:
            for k in ('REFERENCE','REFURL','REFTITLE'):
                if k in meta["dicts"][type]:  ogip[k]=meta["dicts"][type][k] 

            for list in ('EXTENSIONS','ALT_EXTNS'):
                if list in meta["dicts"][type]:  
                    for k in ogip[list]:
                        if k in meta['dicts'][type][list]:  ogip[list][k]=meta['dicts'][type][list][k]

            for extn in meta["dicts"][type]:
                if 'KEYWORDS' in meta["dicts"][type][extn]:  
                    for key,req in meta["dicts"][type][extn]['KEYWORDS'].iteritems():
                        if "req" in req:
                            ogip[extn]['KEYWORDS'][key]=req
                        else:
                            ogip[extn]['KEYWORDS'][key]["level"]=req["level"]

                if 'COLUMNS' in meta["dicts"][type][extn]:  
                    for key,req in meta["dicts"][type][extn]['COLUMNS'].iteritems():
                        if "req" in req:
                            ogip[extn]['COLUMNS'][key]=req
                        else:
                            ogip[extn]['COLUMNS'][key]["level"]=req["level"]



    return ogip