SkimFilterModule.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/SkimFilter/SkimFilterModule.h>
#include <analysis/dataobjects/ParticleList.h>
#include <framework/core/Environment.h>
#include <framework/datastore/StoreObjPtr.h>
 
#include <TString.h>
 
using namespace Belle2;
 
// Register module in the framework
REG_MODULE(SkimFilter);
 
SkimFilterModule::SkimFilterModule() : Module()
{
  //Set module properties
  setDescription("Filter based on ParticleLists, by setting return value to true if at least one of the given lists is not empty.");
  setPropertyFlags(c_ParallelProcessingCertified);
  //Parameter definition
  addParam("particleLists", m_strParticleLists, "List of ParticleLists",
           std::vector<std::string>());
 
  // initializing the rest of private members
  m_nPass   = 0;
}
 
void SkimFilterModule::initialize()
{
 
  int nParticleLists = m_strParticleLists.size();
  B2INFO("Number of ParticleLists studied " << nParticleLists << " ");
 
  m_nPass = 0;
}
 
void SkimFilterModule::event()
{
 
  setReturnValue(0);
 
  // number of ParticleLists
  int nParticleLists = m_strParticleLists.size();
  bool pass = false;
  for (int iList = 0; iList < nParticleLists; ++iList) {
 
    StoreObjPtr<ParticleList> particlelist(m_strParticleLists[iList]);
    if (!particlelist) {
      B2INFO("ParticleList " << m_strParticleLists[iList] << " not found");
      continue;
    } else {
      if (particlelist->getListSize() == 0)continue;
      pass = true;
    }
 
  }
 
  if (pass) m_nPass++;
  //module condition
  setReturnValue(pass);
 
}
 
void SkimFilterModule::terminate()
{
  B2INFO("SkimFilter Summary: \n");
  std::ostringstream stream;
  stream <<  "\n=======================================================\n";
  stream <<  "Total Retention: " << Form("%6.4f\n", (float)m_nPass / (float)Environment::Instance().getNumberOfEvents());
  stream <<  "\n=======================================================\n";
  B2INFO(stream.str());
}