FlavorTaggerInfoFillerModule.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#include <analysis/modules/FlavorTaggerInfoFiller/FlavorTaggerInfoFillerModule.h>
#include <framework/core/ModuleParam.templateDetails.h>
#include <analysis/dataobjects/ParticleList.h>
#include <analysis/dataobjects/FlavorTaggerInfo.h>
#include <analysis/dataobjects/FlavorTaggerInfoMap.h>
#include <analysis/VariableManager/Manager.h>
 
using namespace std;
using namespace Belle2;
 
// Register module in the framework
REG_MODULE(FlavorTaggerInfoFiller);
 
FlavorTaggerInfoFillerModule::FlavorTaggerInfoFillerModule() : Module()
{
  //Set module properties
  setDescription("Creates a new flavorTaggerInfoMap DataObject for the specific methods. Saves there all the relevant information of the flavorTagger.");
  setPropertyFlags(c_ParallelProcessingCertified);
  //Parameter definition
  addParam("trackLevelParticleLists", m_trackLevelParticleLists, "Used Flavor Tagger trackLevel Categories of the lists ",
           vector<tuple<string, string>>());
  addParam("eventLevelParticleLists", m_eventLevelParticleLists, "Used Flavor Tagger eventLevel Categories of the lists ",
           vector<tuple<string, string, string>>());
  addParam("FANNmlp", m_FANNmlp, "Sets if FANN Combiner output will be saved or not", false);
  addParam("TMVAfbdt", m_TMVAfbdt, "Sets if FANN Combiner output will be saved or not", false);
  addParam("DNNmlp", m_DNNmlp, "Sets if DNN Tagger output will be saved or not", false);
  addParam("TFLATnn", m_TFLATnn, "Sets if TFLAT Tagger output will be saved or not", false);
  addParam("qpCategories", m_qpCategories, "Sets if individual categories output will be saved or not", false);
  addParam("istrueCategories", m_istrueCategories, "Sets if individual MC truth for each category is saved or not", false);
  addParam("targetProb", m_targetProb, "Sets if individual Categories output will be saved or not", false);
  addParam("trackPointers", m_trackPointers, "Sets if track pointers to target tracks are saved or not", false);
 
}
 
void FlavorTaggerInfoFillerModule::initialize()
{
  if (m_FANNmlp or m_TMVAfbdt) m_eventExtraInfo.isRequired();
}
 
void FlavorTaggerInfoFillerModule::event()
{
  auto* flavorTaggerInfo = m_roe->getRelatedTo<FlavorTaggerInfo>();
 
  Variable::Manager& manager = Variable::Manager::Instance();
 
 
  if (flavorTaggerInfo == nullptr) {
    B2ERROR("flavorTaggerInfoFiller: FlavorTaggerInfo does not exist");
    return;
  }
 
  flavorTaggerInfo -> setUseModeFlavorTagger("Expert");
 
  if (m_FANNmlp) {
    FlavorTaggerInfoMap* infoMapsFANN = flavorTaggerInfo -> getMethodMap("FANN");
    // For FANN, the output is mapped to be qr
    float qrCombined = m_eventExtraInfo->getExtraInfo("qrCombinedFANN");
    if (qrCombined < 1.1 && qrCombined > 1.0) qrCombined = 1.0;
    if (qrCombined > - 1.1 && qrCombined < -1.0) qrCombined = -1.0;
    float B0Probability = qrCombined / 2 + 0.5;
    float B0barProbability = 1 - B0Probability;
    infoMapsFANN->setQrCombined(qrCombined);
    infoMapsFANN->setB0Probability(B0Probability);
    infoMapsFANN->setB0barProbability(B0barProbability);
  }
 
  FlavorTaggerInfoMap* infoMapsFBDT = flavorTaggerInfo -> getMethodMap("FBDT");
 
  if (m_TMVAfbdt) {
    float B0Probability = m_eventExtraInfo->getExtraInfo("qrCombinedFBDT");
    float B0barProbability = 1 - B0Probability;
    float qrCombined = 2 * (B0Probability - 0.5);
    if (qrCombined < 1.1 && qrCombined > 1.0) qrCombined = 1.0;
    if (qrCombined > - 1.1 && qrCombined < -1.0) qrCombined = -1.0;
    infoMapsFBDT->setQrCombined(qrCombined);
    infoMapsFBDT->setB0Probability(B0Probability);
    infoMapsFBDT->setB0barProbability(B0barProbability);
  }
 
  if (m_DNNmlp) {
    FlavorTaggerInfoMap* infoMapsDNN = flavorTaggerInfo -> getMethodMap("DNN");
    const Particle* particle = m_roe->getRelatedFrom<Particle>();
    float B0Probability = particle->getExtraInfo("dnn_output");
    float B0barProbability = 1 - B0Probability;
    float qrCombined = 2 * (B0Probability - 0.5);
    if (qrCombined < 1.1 && qrCombined > 1.0) qrCombined = 1.0;
    if (qrCombined > - 1.1 && qrCombined < -1.0) qrCombined = -1.0;
    infoMapsDNN->setQrCombined(qrCombined);
    infoMapsDNN->setB0Probability(B0Probability);
    infoMapsDNN->setB0barProbability(B0barProbability);
  }
 
  if (m_TFLATnn) {
    FlavorTaggerInfoMap* infoMapsTFLAT = flavorTaggerInfo -> getMethodMap("TFLAT");
    const Particle* particle = m_roe->getRelatedFrom<Particle>();
    float B0Probability = particle->getExtraInfo("tflat_output");
    float B0barProbability = 1 - B0Probability;
    float qrCombined = 2 * (B0Probability - 0.5);
    if (qrCombined < 1.1 && qrCombined > 1.0) qrCombined = 1.0;
    if (qrCombined > - 1.1 && qrCombined < -1.0) qrCombined = -1.0;
    infoMapsTFLAT->setQrCombined(qrCombined);
    infoMapsTFLAT->setB0Probability(B0Probability);
    infoMapsTFLAT->setB0barProbability(B0barProbability);
  }
 
 
  if (m_targetProb) {
    for (auto& iTuple : m_trackLevelParticleLists) {
      string particleListName = get<0>(iTuple);
      string category = get<1>(iTuple);
      StoreObjPtr<ParticleList> particleList(particleListName);
 
 
      if (!particleList.isValid()) {
        B2INFO("ParticleList " << particleListName << " not found");
      } else {
        if (particleList -> getListSize() == 0) {
          infoMapsFBDT -> setProbTrackLevel(category, 0);
          if (m_trackPointers) infoMapsFBDT -> setTargetTrackLevel(category, nullptr);
        } else {
 
          for (unsigned int i = 0; i < particleList->getListSize(); ++i) {
            Particle* iParticle =  particleList ->getParticle(i);
            bool hasMaxProb = std::get<bool>(manager.getVariable("hasHighestProbInCat(" + particleListName + "," + "isRightTrack(" + category +
                                                                 "))")->function(iParticle));
            if (hasMaxProb == 1) {
              float targetProb = iParticle -> getExtraInfo("isRightTrack(" + category + ")");
              infoMapsFBDT->setProbTrackLevel(category, targetProb);
              if (m_trackPointers) {
                infoMapsFBDT-> setTargetTrackLevel(category, iParticle -> getTrack());
              }
              break;
            }
          }
        }
      }
    }
  }
 
  if (m_qpCategories) {
 
    for (auto& iTuple : m_eventLevelParticleLists) {
      string particleListName = get<0>(iTuple);
      string category = get<1>(iTuple);
      string qpCategoryVariable = get<2>(iTuple);
      StoreObjPtr<ParticleList> particleList(particleListName);
 
      if (!particleList.isValid()) {
        B2INFO("ParticleList " << particleListName << " not found");
      } else {
        if (particleList -> getListSize() == 0) {
          infoMapsFBDT -> setProbEventLevel(category, 0);
          infoMapsFBDT -> setQpCategory(category, 0);
          if (m_istrueCategories and m_mcparticles.isValid()) {
            infoMapsFBDT -> setHasTrueTarget(category, 0);
            infoMapsFBDT -> setIsTrueCategory(category, 0);
          }
          if (m_trackPointers) infoMapsFBDT -> setTargetEventLevel(category, nullptr);
        } else {
 
          for (unsigned int i = 0; i < particleList->getListSize(); ++i) {
            Particle* iParticle =  particleList ->getParticle(i);
            bool hasMaxProb = std::get<bool>(manager.getVariable("hasHighestProbInCat(" + particleListName + "," + "isRightCategory(" + category
                                                                 + "))")-> function(iParticle));
            if (hasMaxProb == 1) {
              float categoryProb = iParticle -> getExtraInfo("isRightCategory(" + category + ")");
              float qpCategory = std::get<double>(manager.getVariable(qpCategoryVariable)-> function(iParticle));
              infoMapsFBDT->setProbEventLevel(category, categoryProb);
              infoMapsFBDT -> setQpCategory(category, qpCategory);
              if (m_istrueCategories and m_mcparticles.isValid()) {
                float isTrueTarget = std::get<double>(manager.getVariable("hasTrueTarget(" + category + ")")-> function(nullptr));
                infoMapsFBDT -> setHasTrueTarget(category, isTrueTarget);
                float isTrueCategory = std::get<double>(manager.getVariable("isTrueCategory(" + category + ")")-> function(nullptr));
                infoMapsFBDT -> setIsTrueCategory(category, isTrueCategory);
              }
              if (m_trackPointers) {
                infoMapsFBDT-> setTargetEventLevel(category, iParticle -> getTrack());
              }
              break;
            }
          }
        }
      }
    }
  }
 
}
 
void FlavorTaggerInfoFillerModule::terminate()
{
}