Selections.h

Go to the documentation of this file.

#ifndef Selections_H
#define Selections_H

#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "CommonTools/UtilAlgos/interface/EventSelector.h"
#include <cstdlib>
#include <iomanip>
#include <iostream>
#include <sstream>
#include "TFormula.h"

class Filter {
 public:
  Filter() :  selector_(nullptr){}
  Filter(const edm::ParameterSet& iConfig, edm::ConsumesCollector & iC);
  Filter(std::string name, edm::ParameterSet& iConfig, edm::ConsumesCollector & iC) :
  name_(name), selector_(nullptr),cached_decision_(false),eventCacheID_(0)
  {
    dump_=iConfig.dump();
    if (!iConfig.empty()){
      const std::string d("name");
      iConfig.addUntrackedParameter<std::string>(d,name);
      std::string componentName = iConfig.getParameter<std::string>("selector");
      selector_ = EventSelectorFactoryFromHelper::get()->create(componentName, iConfig, iC);
      if (iConfig.exists("description"))
    description_=iConfig.getParameter<std::vector<std::string> >("description");
      else
    description_=selector_->description();
    }
  }
  virtual ~Filter(){}

  const std::string & name() {return name_;}
  const std::string & dump() { return dump_;}
  const std::vector<std::string> description() { return description_;}
  const std::string descriptionText() {
    std::string text;
    for (unsigned int i=0;i!=description_.size();++i) text+=description_[i]+"\n";
    text+=dump()+"\n";
    return text;}

  virtual  bool accept(edm::Event& iEvent) {
    bool decision=false; 
    if (std::numeric_limits<edm::Event::CacheIdentifier_t>::max() != eventCacheID_ and eventCacheID_ != iEvent.cacheIdentifier()){
      eventCacheID_=iEvent.cacheIdentifier();
      
      if (selector_)
    decision=selector_->select(iEvent);
      else
    decision=true;
      cached_decision_ = decision;
    }else{
      decision = cached_decision_;
    }
    return decision;
  }

 protected:
  std::string name_;
  std::vector<std::string> description_;
  EventSelector * selector_;
  mutable bool cached_decision_;
  mutable edm::Event::CacheIdentifier_t eventCacheID_ = 0;
  std::string dump_;
};

// will behave like a filter*
class SFilter {
 public:
  SFilter(Filter * f, bool i) : filter_(f),inverted_(i){};
  ~SFilter(){};

  Filter & operator*(){
    return *filter_;
  }
  Filter * operator->(){
    return filter_;
  }
  bool inverted() { return inverted_;}
 private:
  Filter * filter_;
  bool inverted_;
};

class FilterOR : public Filter{
 public:
  ~FilterOR() override{}
  FilterOR(const std::string & filterORlist,
       const std::map<std::string, Filter*> & filters){
    std::string filterORlistCopy=filterORlist;
    name_ = filterORlist;
    std::stringstream ss;
    ss<<"Filter doing an OR of: ";
    //split the OR-separated string into vector of strings
    unsigned int size=0;
    bool OK=true;
    while( OK ){
      size_t orPos = filterORlistCopy.find("_OR_");
      if (orPos == std::string::npos && !filterORlistCopy.empty()){
    size=filterORlistCopy.size();
    OK=false;
      }
      else
    size=orPos;

      std::string filter = filterORlistCopy.substr(0,size);
      //remove the filter name and the OR (4 characters) from the string
      if (OK)
    filterORlistCopy = filterORlistCopy.substr(0+size+4);

      std::map<std::string, Filter*>::const_iterator it=filters.find(filter);
      if (it==filters.end()){
    edm::LogError("FilterOR")<<"cannot do an OR of: "<<filter
                 <<" OR expression is: "<<filterORlist;
    break;
      }
      filters_.push_back(std::make_pair(it->first, it->second));
      ss<<it->first<<" ";
    }
    description_.push_back(ss.str());
  }
  bool accept(edm::Event& iEvent) override {
    for (unsigned int i=0 ; i!=filters_.size();++i)
      if (filters_[i].second->accept(iEvent))
    return true;
    return false;
  }
 private:
  std::vector <std::pair<std::string , Filter * > > filters_;
};


//forward declaration for friendship
class FilterSelections;

class FilterSelection : public Filter {
 public:
  typedef std::vector<SFilter>::iterator iterator;
  friend class FilterSelections;

  FilterSelection(std::string name, const edm::ParameterSet& iConfig) :
    name_(name),
    ntuplize_(iConfig.getParameter<bool>("ntuplize")),
    makeContentPlots_(iConfig.getParameter<bool>("makeContentPlots")),
    makeFinalPlots_(iConfig.getParameter<bool>("makeFinalPlots")),
    makeCumulativePlots_(iConfig.getParameter<bool>("makeCumulativePlots")),
    makeAllButOnePlots_(iConfig.getParameter<bool>("makeAllButOnePlots")),
    nSeen_(0),
    makeSummaryTable_(iConfig.getParameter<bool>("makeSummaryTable")),
    makeDetailledPrintout_(iConfig.exists("detailledPrintoutCategory"))
  {
    Filter::name_ = name_;
    Filter::description_.push_back(std::string("See definition of the corresponding selection"));
    if (iConfig.exists("nMonitor"))
      nMonitor_=iConfig.getParameter<unsigned int>("nMonitor");
    else
      nMonitor_=0;

    if (makeDetailledPrintout_)
      detailledPrintoutCategory_ = iConfig.getParameter<std::string>("detailledPrintoutCategory");
  }

  const std::string & name() {return name_;}
  iterator begin() { return filters_.begin();}
  iterator end() { return filters_.end();}

  bool accept(edm::Event& iEvent) override{
    if (std::numeric_limits<edm::Event::CacheIdentifier_t>::max() != eventCacheID_ and eventCacheID_ != iEvent.cacheIdentifier()){
      this->acceptMap(iEvent);
    }
    return cached_decision_;
  }


  std::map<std::string, bool> acceptMap(edm::Event& iEvent){
    nSeen_++;
    if (nMonitor_!=0 && nSeen_%nMonitor_==0){
      if (nSeen_==nMonitor_) print();
      else print(false);
    }
    std::map<std::string, bool> ret;
    bool global=true;
    for (iterator filter=begin(); filter!=end();++filter){
      const std::string & fName=(*filter)->name();
      Count & count=counts_[fName];
      count.nSeen_++;
      bool decision=(*filter)->accept(iEvent);
      bool inverted=(*filter).inverted();
      if (inverted) decision=!decision;
      ret[fName]=decision;
      if (decision) count.nPass_++;
      global=global && decision;
      if (global) count.nCumulative_++;
    }

    if (makeDetailledPrintout_){
      std::stringstream summary;
      summary<<std::setw(20)<<name().substr(0,19)<<" : "
         <<std::setw(10)<<iEvent.id().run()<<" : "
         <<std::setw(10)<<iEvent.id().event();
      for (iterator filter=begin(); filter!=end();++filter){
    const std::string & fName=(*filter)->name();
    summary<<" : "<<std::setw(10)<<(ret[fName]?"pass":"reject");
      }
      edm::LogVerbatim(detailledPrintoutCategory_)<<summary.str();
    }

    cached_decision_ = global;
    eventCacheID_=iEvent.cacheIdentifier();
    return ret;
  }

  void printDetailledPrintoutHeader(){
    if (makeDetailledPrintout_){
      std::stringstream summary;
      summary<<std::setw(20)<<" selection name "<<" : "
         <<std::setw(10)<<" run "<<" : "
         <<std::setw(10)<<" event ";
      for (iterator filter=begin(); filter!=end();++filter){
    summary<<" : "<<std::setw(10)<<(*filter)->name().substr(0,9);
      }
      edm::LogVerbatim(detailledPrintoutCategory_)<<summary.str();
    }
  }
  //print to LogVerbatim("Selections|<name()>")
  void print(bool description=true){
    if (!makeSummaryTable_) return;

    unsigned int maxFnameSize = 20;
    for (iterator filter=begin(); filter!=end();++filter){
      if ((*filter)->name().size() > maxFnameSize) maxFnameSize = (*filter)->name().size()+1;
    }

    //    const std::string category ="Selections|"+name();
    const std::string category ="Selections";
    std::stringstream summary;
    summary<<"   Summary table for selection: "<<name()<<" with: "<<nSeen_<<" events run."<<std::endl;
    if (nSeen_==0) return;
    if (description){
      for (iterator filter=begin(); filter!=end();++filter){
    const std::string & fName=(*filter)->name();
    summary<<"filter: "<<std::right<<std::setw(10)<<fName<<"\n"
           <<(*filter)->descriptionText()<<"\n";
      }
    }
    summary<<" filter stand-alone pass: "<<std::endl;
    summary<<std::right<<std::setw(maxFnameSize)<<"total read"<<": "
       <<std::right<<std::setw(10)<<nSeen_<<std::endl;
    for (iterator filter=begin(); filter!=end();++filter){
      std::string fName = (*filter)->name();
      const Count & count=counts_[fName];
      if ((*filter).inverted()) fName='!'+fName;
      summary<<std::right<<std::setw(maxFnameSize)<<fName<<": "
         <<std::right<<std::setw(10)<<count.nPass_<<" passed events. "
         <<std::right<<std::setw(10)<<std::setprecision (5)<<(count.nPass_/(float)count.nSeen_)*100.<<" [%]"<<std::endl;
    }
    summary<<" filter cumulative pass:"<<std::endl;
    summary<<std::right<<std::setw(maxFnameSize)<<"total read"<<": "
       <<std::right<<std::setw(10)<<nSeen_<<std::endl;
    unsigned int lastCount=nSeen_;
    for (iterator filter=begin(); filter!=end();++filter){
      std::string fName=(*filter)->name();
      const Count & count=counts_[fName];
      if ((*filter).inverted()) fName='!'+fName;
      summary<<std::right<<std::setw(maxFnameSize)<<fName<<": "
         <<std::right<<std::setw(10)<<count.nCumulative_<<" passed events. "
         <<std::right<<std::setw(10)<<std::setprecision (5)<<(count.nCumulative_/(float)count.nSeen_)*100.<<" [%]";
      if (lastCount!=0)
    summary<<" (to previous count) "<<std::right<<std::setw(10)<<std::setprecision (5)<<(count.nCumulative_/(float)lastCount)*100.<<" [%]";
      summary   <<std::endl;

      lastCount = count.nCumulative_;
    }
    summary<<"-------------------------------------\n";
    edm::LogVerbatim(category)<<summary.str();
    std::cout<<summary.str();
  };


  bool ntuplize() {return ntuplize_;}
  bool makeContentPlots() { return makeContentPlots_;}
  bool makeFinalPlots() { return makeFinalPlots_;}
  bool makeCumulativePlots() { return makeCumulativePlots_;}
  bool makeAllButOnePlots() { return makeAllButOnePlots_;}
  bool makeSummaryTable() { return makeSummaryTable_;}

 private:
  std::string name_;
  std::vector<SFilter> filters_; // this is the local list of filters belonging to the selection

  //some options
  bool ntuplize_;
  bool makeContentPlots_;
  bool makeFinalPlots_;
  bool makeCumulativePlots_;
  bool makeAllButOnePlots_;

  unsigned int nSeen_;
  unsigned int nMonitor_;

  struct Count{
    unsigned int nPass_;
    unsigned int nSeen_;
    unsigned int nCumulative_;
  };
  std::map<std::string, Count> counts_;
  bool makeSummaryTable_;
  bool makeDetailledPrintout_;
  std::string detailledPrintoutCategory_;
};

class FilterSelections {
 public:
  typedef std::vector<FilterSelection>::iterator iterator;

  FilterSelections(const edm::ParameterSet& iConfig, edm::ConsumesCollector && iC) :
    filtersPSet_(iConfig.getParameter<edm::ParameterSet>("filters")),
    selectionPSet_(iConfig.getParameter<edm::ParameterSet>("selections"))
  {
    //FIXME. what about nested filters
    // not so needed since we are explicitely spelling all modules
    //make all configured filters
    std::vector<std::string> filterNames;
    unsigned int nF=filtersPSet_.getParameterSetNames(filterNames);
    for (unsigned int iF=0;iF!=nF;iF++){
      edm::ParameterSet pset = filtersPSet_.getParameter<edm::ParameterSet>(filterNames[iF]);
      filters_.insert(std::make_pair(filterNames[iF],new Filter(filterNames[iF],pset, iC))); // this is the global pool of filters
    }

    //parse all configured selections
    std::vector<std::string> selectionNames;
    std::map<std::string, std::vector<std::string> > selectionFilters;
    unsigned int nS=selectionPSet_.getParameterSetNames(selectionNames);
    for (unsigned int iS=0;iS!=nS;iS++){
      edm::ParameterSet pset=selectionPSet_.getParameter<edm::ParameterSet>(selectionNames[iS]);
      // JR-2014 : the filters are not expanded here
      selections_.push_back(FilterSelection(selectionNames[iS],pset));
      //      selections_.insert(std::make_pair(selectionNames[iS],Selection(selectionNames[iS],pset)));
      //keep track of list of filters for this selection for further dependency resolution
      selectionFilters[selectionNames[iS]]=pset.getParameter<std::vector<std::string> >("filterOrder");
    }


    //watch out of recursive dependency
    //    unsigned int nestedDepth=0; //FIXME not taken care of

    //resolving dependencies
    for (std::map<std::string, std::vector<std::string> >::iterator sIt= selectionFilters.begin();sIt!=selectionFilters.end();++sIt)
      {
    //parse the vector of filterNames
    for (std::vector<std::string>::iterator fOrS=sIt->second.begin();fOrS!=sIt->second.end();++fOrS)
      {
        if (filters_.find(*fOrS)==filters_.end())
          {
        //not a know filter names uncountered : either Selection of _OR_.
        if (fOrS->find("_OR_") != std::string::npos){
          filters_.insert(std::make_pair((*fOrS),new FilterOR((*fOrS),filters_)));
        }//_OR_ filter
        else{
          // look for a selection name
          std::map<std::string, std::vector<std::string> >::iterator s=selectionFilters.find(*fOrS);
          if (s==selectionFilters.end()){
            //error.
            if ((*fOrS)[0] != '!'){
              edm::LogError("SelectionHelper")<<"unresolved filter/selection name: "<<*fOrS;
            }
          }//not a Selection name.
          else{
            // JR-2014 : don't do anything here, and move on : in fact no, replace it to have the details in the histograming tool
            //remove the occurence
            std::vector<std::string>::iterator newLoc=sIt->second.erase(fOrS);
            //insert the list of filters corresponding to this selection in there
            sIt->second.insert(newLoc,s->second.begin(),s->second.end());
            //decrement selection iterator to come back to it
            sIt--;
            break;
          }//a Selection name
        }
          }//the name is not a simple filter name : either Selection of _OR_.

      }//loop over the strings in "filterOrder"
      }//loop over all defined Selection

    //finally, configure the Selections
    //loop the selections instanciated
    //    for (std::map<std::string, FilterSelection>::iterator sIt=selections_.begin();sIt!=selections_.end();++sIt)
    //      const std::string & sName=sIt->first;
    //FilterSelection & selection =sIt->second;
    for (std::vector<FilterSelection>::iterator sIt=selections_.begin();sIt!=selections_.end();++sIt){
      const std::string & sName=sIt->name();
      FilterSelection & selection =*sIt;

      //parse the vector of filterNames
      std::vector<std::string> & listOfFilters=selectionFilters[sName];
      for (std::vector<std::string>::iterator fIt=listOfFilters.begin();fIt!=listOfFilters.end();++fIt)
    {
      std::string fOsName = *fIt;
      bool inverted=false;
      if (fOsName[0]=='!'){
        inverted=true;
        fOsName = fOsName.substr(1);
      }
      std::map<std::string, Filter*>::iterator filterInstance=filters_.find(fOsName);
      if (filterInstance==filters_.end()){
        // JR-2014 include the selection here, directly !
        bool replaceBySelection=false;
        //find an existing selection that match that name
        for ( std::vector<FilterSelection>::iterator sit=selections_.begin(); sit!= selections_.end() ; ++sit){
          if (fOsName == sit->name_){
        selection.filters_.push_back( SFilter(& (*sit), inverted));
        replaceBySelection=true;
          }
        }
        if (!replaceBySelection){
          //error
        edm::LogError("Selections")<<"cannot resolve: "<<fOsName;
        }
      }
      else{
        //actually increment the filter
        selection.filters_.push_back(SFilter(filterInstance->second,inverted));
      }
    }
    }

    for (iterator sIt = begin(); sIt!=end();++sIt)
      sIt->printDetailledPrintoutHeader();

  }

  iterator begin() {return selections_.begin(); }
  iterator end() { return selections_.end();}

  //print each selection
  void print(){ for (std::vector<FilterSelection>::iterator sIt=selections_.begin();sIt!=selections_.end();++sIt) sIt->print();}

 private:
  edm::ParameterSet filtersPSet_;
  std::map<std::string, Filter*> filters_; // the global collection of available filters to pick from

  edm::ParameterSet selectionPSet_;
  std::vector<FilterSelection> selections_;
};


#endif