larsim/larsim/EventWeight/Base/WeightManager.h

Go to the documentation of this file.

/**
 * \file WeightManager.h
 *
 *
 * \brief Allows to interface to EventWeight calculators
 *
 * @author Marco Del Tutto <marco.deltutto@physics.ox.ac.uk>
 */

#ifndef WEIGHTMANAGER_H
#define WEIGHTMANAGER_H

#include "art/Framework/Principal/fwd.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "nurandom/RandomUtils/NuRandomService.h"
#include "lardataobj/Simulation/sim.h"
#include "fhiclcpp/ParameterSet.h"

#include "Weight_t.h"
#include "MCEventWeight.h"
#include "WeightCalc.h"
#include "WeightCalcFactory.h"

namespace evwgh {
  /**
     \class WeightManager
  */
  class WeightManager {

  public:

    /// Default constructor
    WeightManager(const std::string name="WeightManager");

    /// Default destructor
    ~WeightManager(){}

    /// Name getter
    const std::string& Name() const;

    /**
      * @brief Configuration function
      * @param cfg the input parameters for settings
      * @param the enging creator for the random seed (usually passed with *this)
       CONFIGURE FUNCTION: created the weights algorithms in the following way: \n
       0) Looks at the weight_functions fcl parameter to get the name of the calculators   \n
       1) Creates the Calculators requested in step 0, and assigne a different random seed to each one \n
       3) The future call WeightManager::Run will run the calculators           \n
    */
    template <typename Module>
    size_t Configure(fhicl::ParameterSet const & cfg, Module& module);

    /**
      * @brief Core function (previous call to Configure is needed)
      * @param e the art event
      * @param inu the index of the simulated neutrino in the event
       CORE FUNCTION: executes algorithms to assign a weight to the event as requested users. \n
       WeightManager::Configure needs to be called first \n
       The execution takes following steps:             \n
       0) Loos over all the previously emplaced calculators \n
       1) For each of them calculates the weights (more weight can be requested per calculator) \n
       3) Returns a map from "calculator name" to vector of weights calculated which is available inside MCEventWeight
     */
    MCEventWeight Run(art::Event &e, const int inu);

    /**
      * @brief Returns the map between calculator name and Weight_t product
      */
    std::map<std::string, Weight_t*> GetWeightCalcMap() { return fWeightCalcMap; }

    /// Reset
    void Reset()
    { _configured = false; }

    void PrintConfig();


  private:
    std::map<std::string, Weight_t*> fWeightCalcMap; ///< A set of custom weight calculators
    bool _configured{false}; ///< Readiness flag
    std::string _name; ///< Name
  };

  template <typename Module>
  size_t WeightManager::Configure(fhicl::ParameterSet const & p, Module& module)
  {

    ::art::ServiceHandle<rndm::NuRandomService> seedservice;

    // Get list of weight functions
    auto const rw_func = p.get<std::vector<std::string>>("weight_functions");

    // Loop over all the functions and register them
    auto const module_label = p.get<std::string>("module_label");
    for (auto const& func : rw_func) {
      auto const ps_func = p.get<fhicl::ParameterSet>(func);
      std::string func_type = ps_func.get<std::string>("type");

      WeightCalc* wcalc=WeightCalcFactory::Create(func_type+"WeightCalc");
      if (wcalc == nullptr)
        throw cet::exception(__FUNCTION__) << "Function " << func << " requested in fcl file has not been registered!" << std::endl;
      if (fWeightCalcMap.find(func) != fWeightCalcMap.end())
        throw cet::exception(__FUNCTION__) << "Function " << func << " has been requested multiple times in fcl file!" << std::endl;

      // Create random engine for each rw function (name=func) (and seed it with random_seed set in the fcl)
      CLHEP::HepRandomEngine& engine = seedservice->createEngine(module, "HepJamesRandom", func, ps_func, "random_seed");
      wcalc->SetName(func);
      wcalc->Configure(p, engine);
      Weight_t* winfo=new Weight_t();
      winfo->fWeightCalcType=func_type;
      winfo->fWeightCalc=wcalc;
      winfo->fNmultisims=ps_func.get<int>("number_of_multisims", 0);

      fWeightCalcMap.emplace(func, winfo);
}

    _configured = true;
    return fWeightCalcMap.size();
  }

}

#endif