ParticleGunModule.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 <generators/modules/ParticleGunModule.h>
#include <framework/gearbox/Unit.h>
#include <framework/datastore/StoreArray.h>
#include <boost/algorithm/string.hpp>
 
using namespace std;
using namespace Belle2;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(ParticleGun);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
ParticleGunModule::ParticleGunModule() : Module()
{
  //Set module properties
  setDescription(R"DOC(
Particle gun to generate simple tracks.
This module allows to generate simple events where all tracks have the same
momentum, angular and vertex distributions.  Several distributions are
available for momentum, phi, theta and vertex position generation:
 
fixed:
    Fixed value, only one parameter has to be specified
    ``[value]``
uniform:
    Uniform between two given values
    ``[min, max]``
uniformPt:
    Generate flat transverse momentum pt
    ``[min_pt, max_pt]``
uniformCos:
    Generate uniformly in the cosine, e.g. flat in cos(theta).  Parameters are
    still the minimum and maximum angle (**not the cosine of the angle**)
    ``[min_theta, max_theta]``
uniformLog:
    Generate uniformly in the logarithm. Parameters are still the normal
    values
    ``[min, max]``
uniformLogPt:
    Like uniformLog but for the transverse momentum.
normal:
    Normal (Gaussian) distributed
    ``[mean, width]``
normalPt:
    Generate normal distributed transverse momentum pt
    ``[mean_pt, width_pt]``
normalCos:
    Generate normal distributed cosine of the angle
    ``[mean, width]``
polyline:
    Generate according to a pdf given as polyline, first the sorted x
    coordinates and then the non-negative y coordinates
    ``[x1, x2, x3, ... xn, y1, y2, y3, ..., yn]``
polylinePt:
    Like polyline but for pt, not p
polylineCos:
    Like polyline, but for the cos(), not the absolute value
inversePt:
    Generate uniformly in the inverse of pt, that is uniform in track
    curvature
    ``[min_pt, max_pt]``
discrete:
    Discrete Spectrum given as a list of weights and values (useful for
    radioactive sources)
    ``[weight1, value1, weight2, value2, ...]``
discretePt:
    same as above but for transverse momentum
)DOC");
  setPropertyFlags(c_Input);
 
  //Set default values for parameters
  m_parameters.pdgCodes       = { -11, 11};
  m_parameters.momentumParams = {0.05, 3.0};
  m_parameters.phiParams      = {0.0, 360.0};
  m_parameters.thetaParams    = {17.0, 150.0};
  m_parameters.xVertexParams  = {0.0, 10 * Unit::um};
  m_parameters.yVertexParams  = {0.0, 59 * Unit::nm};
  m_parameters.zVertexParams  = {0.0, 190 * Unit::um};
  m_parameters.timeParams     = {0.0 * Unit::ns};
 
  //Parameter definition
  addParam("nTracks", m_parameters.nTracks,
           "The number of tracks to be generated per event. If <=0, one particle will "
           "be created for each entry in 'pdgCodes'. Otherwise N particles will be "
           "created and the Particle ID for each particle will be picked randomly "
           "from 'pdgCodes'", 1.0);
  addParam("pdgCodes", m_parameters.pdgCodes,
           "PDG codes for generated particles", m_parameters.pdgCodes);
  addParam("varyNTracks", m_parameters.varyNumberOfTracks,
           "If true, the number of tracks per event is varied using a Poisson "
           "distribution. Only used if 'nTracks'>0", false);
  addParam("momentumGeneration", m_momentumDist,
           "Momentum distribution: one of fixed, uniform, normal, polyline, uniformLog, uniformPt, "
           "normalPt, inversePt, polylinePt, uniformLogPt or discrete", string("uniform"));
  addParam("phiGeneration", m_phiDist,
           "Phi distribution: one of fixed, uniform, normal, normalCos, polyline, uniformCos, "
           "polylineCos or discrete", string("uniform"));
  addParam("thetaGeneration", m_thetaDist,
           "Theta distribution: one of fixed, uniform, normal, normalCos, polyline, uniformCos, "
           "polylineCos or discrete", string("uniform"));
  addParam("timeGeneration", m_timeDist,
           "Time distribution: one of fixed, uniform, normal, normalCos, polyline, uniformCos, "
           "polylineCos or discrete", string("fixed"));
  addParam("vertexGeneration", m_vertexDist,
           "Vertex (x,y,z) distribution: one of fixed, uniform, normal, polyline or "
           "discrete", string("fixed"));
  addParam("xVertexGeneration", m_xVertexDist,
           "X vertex distribution: same options as 'vertexGeneration'. If this parameter "
           "is not specified the value from 'vertexGeneration' is used", string(""));
  addParam("yVertexGeneration", m_yVertexDist,
           "Y vertex distribution: same options as 'vertexGeneration'. If this parameter "
           "is not specified the value from 'vertexGeneration' is used", string(""));
  addParam("zVertexGeneration", m_zVertexDist,
           "Z vertex distribution: same options as 'vertexGeneration'. If this parameter "
           "is not specified the value from 'vertexGeneration' is used", string(""));
  addParam("independentVertices", m_parameters.independentVertices,
           "If false, all tracks of one event will start from the same vertex, "
           "otherwise a new vertex is generated for every particle", false);
  addParam("fixedMomentumPerEvent", m_parameters.fixedMomentumPerEvent,
           "generates particle momentum according to the specified "
           "distribution and assigns this momentum to all particles generated "
           "for one event", false);
  addParam("momentumParams", m_parameters.momentumParams,
           "Parameters for the momentum generation. Meaning of the parameters "
           "depends on the chosen distribution", m_parameters.momentumParams);
  addParam("phiParams", m_parameters.phiParams,
           "Parameters for the phi generation in degrees. Meaning of the parameters "
           "depends on the chosen distribution", m_parameters.phiParams);
  addParam("thetaParams", m_parameters.thetaParams,
           "Parameters for the theta generation in degrees. Meaning of the parameters "
           "depends on the chosen distribution", m_parameters.thetaParams);
  addParam("xVertexParams", m_parameters.xVertexParams,
           "Parameters for the x vertex generation. Meaning of the parameters "
           "depends on the chosen distribution", m_parameters.xVertexParams);
  addParam("yVertexParams", m_parameters.yVertexParams,
           "Parameters for the y vertex generation. Meaning of the parameters "
           "depends on the chosen distribution", m_parameters.yVertexParams);
  addParam("zVertexParams", m_parameters.zVertexParams,
           "Parameters for the z vertex generation. Meaning of the parameters "
           "depends on the chosen distribution", m_parameters.zVertexParams);
  addParam("timeParams", m_parameters.timeParams,
           "Time offset", m_parameters.timeParams);
}
 
ParticleGun::EDistribution ParticleGunModule::convertDistribution(std::string name)
{
  boost::to_lower(name);
  boost::trim(name);
  if (name == "fixed")          return ParticleGun::c_fixedValue;
  if (name == "uniform")        return ParticleGun::c_uniformDistribution;
  if (name == "uniformpt")      return ParticleGun::c_uniformPtDistribution;
  if (name == "uniformcos")     return ParticleGun::c_uniformCosDistribution;
  if (name == "uniformlog")     return ParticleGun::c_uniformLogDistribution;
  if (name == "uniformlogpt")   return ParticleGun::c_uniformLogPtDistribution;
  if (name == "normal")         return ParticleGun::c_normalDistribution;
  if (name == "normalpt")       return ParticleGun::c_normalPtDistribution;
  if (name == "normalcos")      return ParticleGun::c_normalCosDistribution;
  if (name == "discrete")       return ParticleGun::c_discreteSpectrum;
  if (name == "discretept")     return ParticleGun::c_discretePtSpectrum;
  if (name == "inversept")      return ParticleGun::c_inversePtDistribution;
  if (name == "polyline")       return ParticleGun::c_polylineDistribution;
  if (name == "polylinept")     return ParticleGun::c_polylinePtDistribution;
  if (name == "polylinecos")    return ParticleGun::c_polylineCosDistribution;
  B2ERROR("Unknown distribution '" << name << "', using fixed");
  return ParticleGun::c_fixedValue;
}
 
void ParticleGunModule::initialize()
{
  //Initialize MCParticle collection
  StoreArray<MCParticle> mcparticle;
  mcparticle.registerInDataStore();
 
  //Convert string representations to distribution values
  m_parameters.momentumDist = convertDistribution(m_momentumDist);
  m_parameters.phiDist      = convertDistribution(m_phiDist);
  m_parameters.thetaDist    = convertDistribution(m_thetaDist);
  m_parameters.xVertexDist  = convertDistribution(m_vertexDist);
  m_parameters.yVertexDist  = convertDistribution(m_vertexDist);
  m_parameters.zVertexDist  = convertDistribution(m_vertexDist);
  m_parameters.timeDist  = convertDistribution(m_timeDist);
  if (getParam<std::string>("xVertexGeneration").isSetInSteering()) {
    m_parameters.xVertexDist  = convertDistribution(m_xVertexDist);
  }
  if (getParam<std::string>("yVertexGeneration").isSetInSteering()) {
    m_parameters.yVertexDist  = convertDistribution(m_yVertexDist);
  }
  if (getParam<std::string>("zVertexGeneration").isSetInSteering()) {
    m_parameters.zVertexDist  = convertDistribution(m_zVertexDist);
  }
 
  //Convert degree to radian
  if (m_parameters.thetaDist != ParticleGun::c_polylineCosDistribution &&
      m_parameters.thetaDist != ParticleGun::c_normalCosDistribution) {
    for (double& angle : m_parameters.thetaParams) angle *= Unit::deg;
  }
  if (m_parameters.phiDist != ParticleGun::c_polylineCosDistribution &&
      m_parameters.phiDist != ParticleGun::c_normalCosDistribution) {
    for (double& angle : m_parameters.phiParams) angle *= Unit::deg;
  }
 
  //Assign parameters
  m_particleGun.setParameters(m_parameters);
}
 
void ParticleGunModule::event()
{
  try {
    m_particleGraph.clear();
    m_particleGun.generateEvent(m_particleGraph);
    m_particleGraph.generateList();
  } catch (runtime_error& e) {
    B2ERROR(e.what());
  }
}