keywordRule.cpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_dpm_libmerge
 * @copyright ESO - European Southern Observatory
 */
#include <daq/dpm/keywordRule.hpp>
 
#include <algorithm>
#include <daq/fits/keyword.hpp>
 
namespace daq::dpm {
 
fits::KeywordVector StandardKeywordRuleProcessor::Process(fits::KeywordVector const& keywords,
                                                          DefaultRule default_rule) const {
    /*
                Class  Value             Keywords
      TYP_STRUC_KEY  10  SIMPLE, BITPIX, NAXIS, NAXISn, EXTEND, BLOCKED,
                         GROUPS, PCOUNT, GCOUNT, END
                         XTENSION, TFIELDS, TTYPEn, TBCOLn, TFORMn, THEAP,
                         and the first 4 COMMENT keywords in the primary array
                         that define the FITS format.
      TYP_CMPRS_KEY  20  The keywords used in the compressed image or table
                         format, including ZIMAGE, ZCMPTYPE, ZNAMEn, ZVALn,
                         ZTILEn, ZBITPIX, ZNAXISn, ZSCALE, ZZERO, ZBLANK
      TYP_SCAL_KEY   30  BSCALE, BZERO, TSCALn, TZEROn
      TYP_NULL_KEY   40  BLANK, TNULLn
      TYP_DIM_KEY    50  TDIMn
      TYP_RANG_KEY   60  TLMINn, TLMAXn, TDMINn, TDMAXn, DATAMIN, DATAMAX
      TYP_UNIT_KEY   70  BUNIT, TUNITn
      TYP_DISP_KEY   80  TDISPn
      TYP_HDUID_KEY  90  EXTNAME, EXTVER, EXTLEVEL, HDUNAME, HDUVER, HDULEVEL
      TYP_CKSUM_KEY 100  CHECKSUM, DATASUM
      TYP_WCS_KEY   110  WCS keywords defined in the the WCS papers, including:
                         CTYPEn, CUNITn, CRVALn, CRPIXn, CROTAn, CDELTn
                         CDj_is, PVj_ms, LONPOLEs, LATPOLEs
                         TCTYPn, TCTYns, TCUNIn, TCUNns, TCRVLn, TCRVns, TCRPXn,
                         TCRPks, TCDn_k, TCn_ks, TPVn_m, TPn_ms, TCDLTn, TCROTn
                         jCTYPn, jCTYns, jCUNIn, jCUNns, jCRVLn, jCRVns, iCRPXn,
                         iCRPns, jiCDn,  jiCDns, jPVn_m, jPn_ms, jCDLTn, jCROTn
                         (i,j,m,n are integers, s is any letter)
      TYP_REFSYS_KEY 120 EQUINOXs, EPOCH, MJD-OBSs, RADECSYS, RADESYSs, DATE-OBS
      TYP_COMM_KEY   130 COMMENT, HISTORY, (blank keyword)
      TYP_CONT_KEY   140 CONTINUE
      TYP_USER_KEY   150 all other keywords
    */
    fits::KeywordVector result;
    result.reserve(keywords.size());
    if (default_rule == DefaultRule::All) {
        result = keywords;
    } else if (default_rule == DefaultRule::User) {
        // note: Start by keeping only USER keys
        std::copy_if(keywords.begin(),
                     keywords.end(),
                     std::back_inserter(result),
                     [](fits::KeywordVariant const& kw_var) -> bool {
                         // Exclude all but user types
                         return std::visit(
                             [](auto const& kw) {
                                 return fits::GetKeywordClass(kw.GetName().name) ==
                                        fits::KeywordClass::User;
                             },
                             kw_var);
                     });
    } else {
        // DefautlRule::None, do nothing
    }
 
    for (auto const& rule : m_rules) {
        auto kws = rule(result);
        result.swap(kws);
    }
    return result;
}
 
}  // namespace daq::dpm