MVAValueMapProducer.h

Go to the documentation of this file.

#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/stream/EDProducer.h"

#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/MakerMacros.h"

#include "FWCore/ParameterSet/interface/ParameterSet.h"

#include "DataFormats/Common/interface/ValueMap.h"
#include "DataFormats/Common/interface/View.h"

#include "RecoEgamma/EgammaTools/interface/AnyMVAEstimatorRun2Base.h"

#include <memory>
#include <vector>

template <class ParticleType> 
class MVAValueMapProducer : public edm::stream::EDProducer<> {

  public:
  
  explicit MVAValueMapProducer(const edm::ParameterSet&);
  ~MVAValueMapProducer();
  
  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);
  
  private:
  
  virtual void produce(edm::Event&, const edm::EventSetup&) override;

  template<typename T>
  void writeValueMap(edm::Event &iEvent,
             const edm::Handle<edm::View<ParticleType> > & handle,
             const std::vector<T> & values,
             const std::string    & label) const ;
  
  // for AOD case
  edm::EDGetToken src_;

  // for miniAOD case
  edm::EDGetToken srcMiniAOD_;

  // MVA estimator
  std::vector<std::unique_ptr<AnyMVAEstimatorRun2Base>> mvaEstimators_;

  // Value map names
  std::vector <std::string> mvaValueMapNames_;
  std::vector <std::string> mvaCategoriesMapNames_;

};

template <class ParticleType>
MVAValueMapProducer<ParticleType>::MVAValueMapProducer(const edm::ParameterSet& iConfig) 
{

  //
  // Declare consummables, handle both AOD and miniAOD case
  //
  src_        = mayConsume<edm::View<ParticleType> >(iConfig.getParameter<edm::InputTag>("src"));
  srcMiniAOD_ = mayConsume<edm::View<ParticleType> >(iConfig.getParameter<edm::InputTag>("srcMiniAOD"));

  // Loop over the list of MVA configurations passed here from python and
  // construct all requested MVA esimtators.
  const std::vector<edm::ParameterSet>& mvaEstimatorConfigs
    = iConfig.getParameterSetVector("mvaConfigurations");
  for( auto &imva : mvaEstimatorConfigs ){

    std::unique_ptr<AnyMVAEstimatorRun2Base> thisEstimator;
    thisEstimator.reset(NULL);
    if( !imva.empty() ) {
      const std::string& pName = imva.getParameter<std::string>("mvaName");
      // The factory below constructs the MVA of the appropriate type based
      // on the "mvaName" which is the name of the derived MVA class (plugin)
      AnyMVAEstimatorRun2Base *estimator = AnyMVAEstimatorRun2Factory::get()->create(pName, imva);
      // Declare all event content, such as ValueMaps produced upstream or other,
      // original event data pieces, that is needed (if any is implemented in the specific
      // MVA classes)
      //edm::ConsumesCollector &cc = consumesCollector();
      estimator->setConsumes( consumesCollector() );

      thisEstimator.reset(estimator);
      
    } else 
      throw cms::Exception(" MVA configuration not found: ")
    << " failed to find proper configuration for one of the MVAs in the main python script " << std::endl;

    // The unique pointer control is passed to the vector in the line below.
    // Don't use thisEstimator pointer beyond the next line.
    mvaEstimators_.emplace_back( thisEstimator.release() );

    //
    // Compose and save the names of the value maps to be produced
    //
    const auto& currentEstimator = mvaEstimators_.back();
    std::string thisValueMapName = currentEstimator->getName() + "Values";
    std::string thisCategoriesMapName = currentEstimator->getName() + "Categories";
    mvaValueMapNames_.push_back( thisValueMapName );
    mvaCategoriesMapNames_.push_back( thisCategoriesMapName );

    // Declare the maps to the framework
    produces<edm::ValueMap<float> >(thisValueMapName);  
    produces<edm::ValueMap<int> >(thisCategoriesMapName);  

  }


}

template <class ParticleType>
  MVAValueMapProducer<ParticleType>::~MVAValueMapProducer() {
}

template <class ParticleType>
void MVAValueMapProducer<ParticleType>::produce(edm::Event& iEvent, const edm::EventSetup& iSetup) {

  using namespace edm;
  
  edm::Handle<edm::View<ParticleType> > src;

  // Retrieve the collection of particles from the event.
  // If we fail to retrieve the collection with the standard AOD
  // name, we next look for the one with the stndard miniAOD name.
  iEvent.getByToken(src_, src);
  if( !src.isValid() ){
    iEvent.getByToken(srcMiniAOD_,src);
    if( !src.isValid() )
      throw cms::Exception(" Collection not found: ")
    << " failed to find a standard AOD or miniAOD particle collection " << std::endl;
  }

 
  // Loop over MVA estimators
  for( unsigned iEstimator = 0; iEstimator < mvaEstimators_.size(); iEstimator++ ){
    
    // Set up all event content, such as ValueMaps produced upstream or other,
    // original event data pieces, that is needed (if any is implemented in the specific
    // MVA classes)
    mvaEstimators_[iEstimator]->getEventContent( iEvent );

    std::vector<float> mvaValues;
    std::vector<int> mvaCategories;

    // Loop over particles
    for (size_t i = 0; i < src->size(); ++i){
      auto iCand = src->ptrAt(i);
      
      mvaValues.push_back( mvaEstimators_[iEstimator]->mvaValue(  iCand ) );
      mvaCategories.push_back( mvaEstimators_[iEstimator]->findCategory(  iCand ) );
    } // end loop over particles

    writeValueMap(iEvent, src, mvaValues, mvaValueMapNames_[iEstimator] );  
    writeValueMap(iEvent, src, mvaCategories, mvaCategoriesMapNames_[iEstimator] );  

  } // end loop over estimators
  

}

template<class ParticleType> template<typename T>
void MVAValueMapProducer<ParticleType>::writeValueMap(edm::Event &iEvent,
                            const edm::Handle<edm::View<ParticleType> > & handle,
                            const std::vector<T> & values,
                            const std::string    & label) const 
{
  using namespace edm; 
  using namespace std;
  auto_ptr<ValueMap<T> > valMap(new ValueMap<T>());
  typename edm::ValueMap<T>::Filler filler(*valMap);
  filler.insert(handle, values.begin(), values.end());
  filler.fill();
  iEvent.put(valMap, label);
}

template <class ParticleType>
  void MVAValueMapProducer<ParticleType>::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  //The following says we do not know what parameters are allowed so do no validation
  // Please change this to state exactly what you do use, even if it is no parameters
  edm::ParameterSetDescription desc;
  desc.setUnknown();
  descriptions.addDefault(desc);
}