AWESOMEBasicModule.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.                  *
 **************************************************************************/
 
/* Own header. */
#include <online_book/awesome/modules/AWESOMEBasic/AWESOMEBasicModule.h>
 
/* Basf2 headers. */
#include <framework/logging/Logger.h>
 
/* --------- WARNING ------------------------------------------------------
 * If you have more complex parameter types in your class then simple int,
 * double or std::vector of those you might need to uncomment the following
 * include directive to avoid an undefined reference on compilation.
 * --------------------------------------------------------------------- */
// #include <framework/core/ModuleParam.templateDetails.h>
 
using namespace Belle2;
using namespace Belle2::AWESOME;
 
REG_MODULE(AWESOMEBasic);
 
AWESOMEBasicModule::AWESOMEBasicModule() :
  Module(),
  m_intParameter{0},
  m_doubleParameter{0},
  m_stringParameter{""}
{
  setDescription("Here you can enter a description of the module which can be displayed during runtime.");
  /* We can define parameters which can be set from the steering file. The arguments are:
   * name, reference to the variable where the value will be stored, description, default value.
   * If the default value is omitted the user has to specify this parameter, otherwise an error is produced. */
  addParam("intParameter", m_intParameter,
           "Useless parameter of type integer", 0);
  addParam("doubleParameter", m_doubleParameter,
           "Useless parameter of type double", 0.0);
  addParam("stringParameter", m_stringParameter,
           "Useless parameter of type string", std::string{""});
  addParam("doubleListParameter", m_doubleListParameter,
           "Useless parameter of type vector<double>", std::vector<double> {3, 0});
 
  //Valid parameter types are int, double, string, bool and vectors of any of those
}
 
void AWESOMEBasicModule::initialize()
{
  B2INFO("AWESOMEBasic: initialize.");
  m_MCParticles.isRequired();
  m_SimHits.isRequired();
  m_MCParticles.requireRelationTo(m_SimHits);
}
 
void AWESOMEBasicModule::beginRun()
{
  B2INFO("AWESOMEBasic: begin of new run.");
}
 
void AWESOMEBasicModule::event()
{
  B2INFO("AWESOMEBasic: event is being processed.");
  /* Let's try a simple loop over the simulated hits. */
  for (const AWESOMESimHit& hit : m_SimHits) {
    int mcArrayIndex = -1;
    int pdgCode = 0;
    /* We assume there is only a single MCParticle related to the hit. */
    MCParticle* mcParticle = hit.getRelated<MCParticle>();
    if (mcParticle) {
      mcArrayIndex = mcParticle->getArrayIndex();
      pdgCode = mcParticle->getPDG();
    }
    B2INFO("AWESOMESimHit #" << hit.getArrayIndex()
           << " has an energy deposition of " << hit.getEnergyDep()
           << " and is related to MCParticle #" << mcArrayIndex
           << " which has a PDG code " << pdgCode);
  }
  /* Now let's do it the other way round. */
  for (const MCParticle& mcParticle : m_MCParticles) {
    for (const AWESOMESimHit& hit : mcParticle.getRelationsWith<AWESOMESimHit>())
      B2INFO("MCParticle #" << mcParticle.getArrayIndex()
             << " which has a PDG code " << mcParticle.getPDG()
             << " created the AWESOMESimHit #" << hit.getArrayIndex()
             << " which has an energy deposition of " << hit.getEnergyDep());
  }
}
 
void AWESOMEBasicModule::endRun()
{
  B2INFO("AWESOMEBasic: end of run.");
  /* Here you can do some cleanup after each run. */
}
 
 
void AWESOMEBasicModule::terminate()
{
  B2INFO("AWESOMEBasic: terminate.");
  /* Here you can do some final cleanup. */
}