GeneratorHepMC.cxx

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#include "SimulationDataFormat/MCUtils.h"
#include "Generators/GeneratorHepMC.h"
#include "Generators/GeneratorHepMCParam.h"
#include "SimulationDataFormat/MCEventHeader.h"
#include "SimConfig/SimConfig.h"
#include "HepMC3/ReaderFactory.h"
#include "HepMC3/GenEvent.h"
#include "HepMC3/GenParticle.h"
#include "HepMC3/GenVertex.h"
#include "HepMC3/FourVector.h"
#include "HepMC3/Version.h"
#include "TParticle.h"
 
#include <fairlogger/Logger.h>
#include "FairPrimaryGenerator.h"
#include <cmath>
#include <sstream>
 
namespace o2
{
namespace eventgen
{
 
/*****************************************************************/
/*****************************************************************/
 
GeneratorHepMC::GeneratorHepMC()
  : GeneratorHepMC("ALICEo2", "ALICEo2 HepMC Generator")
{
}
 
/*****************************************************************/
 
GeneratorHepMC::GeneratorHepMC(const Char_t* name, const Char_t* title)
  : Generator(name, title)
{
  mEvent = new HepMC3::GenEvent();
  mInterface = reinterpret_cast<void*>(mEvent);
  mInterfaceName = "hepmc";
}
 
/*****************************************************************/
 
GeneratorHepMC::~GeneratorHepMC()
{
  LOG(info) << "Destructing GeneratorHepMC";
  if (mReader) {
    mReader->close();
  }
  if (mEvent) {
    delete mEvent;
  }
  if (not mCmd.empty()) {
    // Must be executed before removing the temporary file
    // otherwise the current child process might still be writing on it
    // causing unwanted stdout messages which could slow down the system
    terminateCmd();
  }
  removeTemp();
}
 
/*****************************************************************/
void GeneratorHepMC::setup(const GeneratorFileOrCmdParam& param0,
                           const GeneratorHepMCParam& param,
                           const conf::SimConfig& config)
{
  if (not param.fileName.empty()) {
    LOG(warn) << "The use of the key \"HepMC.fileName\" is "
              << "deprecated, use \"GeneratorFileOrCmd.fileNames\" instead";
  }
 
  GeneratorFileOrCmd::setup(param0, config);
  if (not param.fileName.empty()) {
    setFileNames(param.fileName);
  }
 
  mVersion = param.version;
  mPrune = param.prune;
  setEventsToSkip(param.eventsToSkip);
 
  // we are skipping ahead in the HepMC stream now
  for (int i = 0; i < mEventsToSkip; ++i) {
    generateEvent();
  }
 
  if (param.version != 0 and mCmd.empty()) {
    LOG(warn) << "The key \"HepMC.version\" is no longer needed when "
              << "reading from files. The format version of the input files "
              << "are automatically deduced. However, it is mandatory when reading "
              << "from a pipe containing HepMC2 data.";
  }
}
 
/*****************************************************************/
void GeneratorHepMC::setup(const FileOrCmdGenConfig& param0,
                           const HepMCGenConfig& param,
                           const conf::SimConfig& config)
{
  if (not param.fileName.empty()) {
    LOG(warn) << "The use of the key \"HepMC.fileName\" is "
              << "deprecated, use \"GeneratorFileOrCmd.fileNames\" instead";
  }
 
  GeneratorFileOrCmd::setup(param0, config);
  if (not param.fileName.empty()) {
    setFileNames(param.fileName);
  }
 
  mVersion = param.version;
  mPrune = param.prune;
  setEventsToSkip(param.eventsToSkip);
 
  // we are skipping ahead in the HepMC stream now
  for (int i = 0; i < mEventsToSkip; ++i) {
    generateEvent();
  }
 
  if (param.version != 0 and mCmd.empty()) {
    LOG(warn) << "The key \"HepMC.version\" is no longer needed when "
              << "reading from files. The format version of the input files "
              << "are automatically deduced. However, it is mandatory when reading "
              << "from a pipe containing HepMC2 data.";
  }
}
 
/*****************************************************************/
Bool_t GeneratorHepMC::generateEvent()
{
  LOG(debug) << "Generating an event";
  int tries = 0;
  constexpr int max_tries = 3;
  do {
    LOG(debug) << " try # " << tries;
    if (not mReader and not makeReader()) {
      return false;
    }
 
    mEvent->clear();
    mReader->read_event(*mEvent);
    if (not mReader->failed()) {
      mEvent->set_units(HepMC3::Units::GEV, HepMC3::Units::MM);
      LOG(debug) << "Read one event " << mEvent->event_number();
      return true;
    } else {
      LOG(error) << "Event reading from HepMC failed ...";
    }
    tries++;
  } while (tries < max_tries);
 
  LOG(error) << "HepMC event gen failed (Does the file/stream have enough events)?";
 
  return false;
}
 
/*****************************************************************/
void GeneratorHepMC::pruneEvent(Select select)
{
  HepMC3::GenEvent& event = *mEvent;
 
  auto particles = event.particles();
  auto vertices = event.vertices();
  std::list<HepMC3::GenParticlePtr> toRemove;
 
  LOG(debug) << "HepMC events has " << particles.size()
             << " particles and " << vertices.size()
             << " vertices" << std::endl;
 
  size_t nSelect = 0;
  for (size_t i = 0; i < particles.size(); ++i) {
    auto particle = particles[i];
    if (select(particle)) {
      nSelect++;
      continue;
    }
 
    // Remove particle from the event
    toRemove.push_back(particle);
    LOG(debug) << " Remove " << std::setw(3) << particle->id();
 
    auto endVtx = particle->end_vertex();
    auto prdVtx = particle->production_vertex();
    if (endVtx) {
      // Disconnect this particle from its out going vertex
      endVtx->remove_particle_in(particle);
      LOG(debug) << " end " << std::setw(3) << endVtx->id();
 
      if (prdVtx and prdVtx->id() != endVtx->id()) {
        auto outbound = endVtx->particles_out();
        auto inbound = endVtx->particles_in();
        LOG(debug) << " prd " << std::setw(3) << prdVtx->id() << " "
                   << std::setw(3) << outbound.size() << " out "
                   << " "
                   << std::setw(3) << inbound.size() << " in ";
 
        // Other out-bound particles of the end vertex are attached as
        // out-going to the production vertex of this particle.
        for (auto outgoing : outbound) {
          // This should also detach the particle from its old
          // end-vertex.
          if (outgoing) {
            auto ee = outgoing->end_vertex();
            if (not ee or ee->id() != prdVtx->id()) {
              prdVtx->add_particle_out(outgoing);
            }
            LOG(debug) << "  " << std::setw(3) << outgoing->id();
          }
        }
 
        // Other incoming particles to the end vertex of this
        // particles are attached incoming particles to the production
        // vertex of this particle.
        for (auto incoming : inbound) {
          if (incoming) {
            auto pp = incoming->production_vertex();
            if (not pp or pp->id() != prdVtx->id()) {
              prdVtx->add_particle_in(incoming);
            }
 
            LOG(debug) << "  " << std::setw(3) << incoming->id();
          }
        }
      }
    }
    if (prdVtx) {
      prdVtx->remove_particle_out(particle);
    }
  }
 
  LOG(debug) << "Selected " << nSelect << " particles\n"
             << "Removing " << toRemove.size() << " particles";
  size_t oldSize = particles.size();
  for (auto particle : toRemove) {
    event.remove_particle(particle);
  }
 
  std::list<HepMC3::GenVertexPtr> remVtx;
  for (auto vtx : event.vertices()) {
    if (not vtx or
        (vtx->particles_out().empty() and
         vtx->particles_in().empty())) {
      remVtx.push_back(vtx);
    }
  }
  LOG(debug) << "Removing " << remVtx.size() << " vertexes";
  for (auto vtx : remVtx) {
    event.remove_vertex(vtx);
  }
 
  LOG(debug) << "HepMC events was pruned from " << oldSize
             << " particles to " << event.particles().size()
             << " particles and " << event.vertices().size()
             << " vertices";
}
 
/*****************************************************************/
 
Bool_t GeneratorHepMC::importParticles()
{
  if (mPrune) {
    auto select = [](HepMC3::ConstGenParticlePtr particle) {
      switch (particle->status()) {
        case 1: // Final st
        case 2: // Decayed
        case 4: // Beam
          return true;
      }
      // To also keep diffractive particles
      // if (particle->pid() == 9902210) return true;
      return false;
    };
    pruneEvent(select);
  }
 
  mParticles.clear();
  auto particles = mEvent->particles();
  for (int i = 0; i < particles.size(); ++i) {
 
    auto particle = particles.at(i);
    auto momentum = particle->momentum();
    auto vertex = particle->production_vertex()->position();
    auto parents = particle->parents();
    auto children = particle->children();
 
    auto m1 = parents.empty() ? -1 : parents.front()->id() - 1;
    auto m2 = parents.empty() ? -1 : parents.back()->id() - 1;
 
    auto d1 = children.empty() ? -1 : children.front()->id() - 1;
    auto d2 = children.empty() ? -1 : children.back()->id() - 1;
 
    mParticles.push_back(TParticle(particle->pid(),            // Particle type
                                   particle->status(),         // Status code
                                   m1,                         // First mother
                                   m2,                         // Second mother
                                   d1,                         // First daughter
                                   d2,                         // Last daughter
                                   momentum.x(),               // X-momentum
                                   momentum.y(),               // Y-momentum
                                   momentum.z(),               // Z-momentum
                                   momentum.t(),               // Energy
                                   vertex.x(),                 // Production X
                                   vertex.y(),                 // Production Y
                                   vertex.z(),                 // Production Z
                                   vertex.t()));               // Production time
    o2::mcutils::MCGenHelper::encodeParticleStatusAndTracking( //
      mParticles.back(),                                       // Add to back
      particle->status() == 1);                                // only final state are to be propagated
 
  } 
  return kTRUE;
}
 
namespace
{
template <typename AttributeType, typename TargetType>
bool putAttributeInfoImpl(o2::dataformats::MCEventHeader* eventHeader,
                          const std::string& name,
                          const std::shared_ptr<HepMC3::Attribute>& a)
{
  if (auto* p = dynamic_cast<AttributeType*>(a.get())) {
    eventHeader->putInfo<TargetType>(name, p->value());
    return true;
  }
  return false;
}
 
void putAttributeInfo(o2::dataformats::MCEventHeader* eventHeader,
                      const std::string& name,
                      const std::shared_ptr<HepMC3::Attribute>& a)
{
  using IntAttribute = HepMC3::IntAttribute;
  using LongAttribute = HepMC3::LongAttribute;
  using FloatAttribute = HepMC3::FloatAttribute;
  using DoubleAttribute = HepMC3::DoubleAttribute;
  using StringAttribute = HepMC3::StringAttribute;
  using CharAttribute = HepMC3::CharAttribute;
  using LongLongAttribute = HepMC3::LongLongAttribute;
  using LongDoubleAttribute = HepMC3::LongDoubleAttribute;
  using UIntAttribute = HepMC3::UIntAttribute;
  using ULongAttribute = HepMC3::ULongAttribute;
  using ULongLongAttribute = HepMC3::ULongLongAttribute;
  using BoolAttribute = HepMC3::BoolAttribute;
 
  if (putAttributeInfoImpl<IntAttribute, int>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<LongAttribute, int>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<FloatAttribute, float>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<DoubleAttribute, float>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<StringAttribute, std::string>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<CharAttribute, char>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<LongLongAttribute, int>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<LongDoubleAttribute, float>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<UIntAttribute, int>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<ULongAttribute, int>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<ULongLongAttribute, int>(eventHeader, name, a)) {
    return;
  }
  if (putAttributeInfoImpl<BoolAttribute, bool>(eventHeader, name, a)) {
    return;
  }
}
} // namespace
 
/*****************************************************************/
 
void GeneratorHepMC::updateHeader(o2::dataformats::MCEventHeader* eventHeader)
{
  using Key = o2::dataformats::MCInfoKeys;
 
  eventHeader->putInfo<std::string>(Key::generator, "hepmc");
  eventHeader->putInfo<int>(Key::generatorVersion, HEPMC3_VERSION_CODE);
 
  auto xSection = mEvent->cross_section();
  auto pdfInfo = mEvent->pdf_info();
  auto hiInfo = mEvent->heavy_ion();
 
  // Workaround for a bug in HepMC3 (3.3.1 on 23/02/2026): GenHeavyIon::from_string() for the "v0"
  // format skips reading user_cent_estimate, but to_string() always writes it.
  // This shifts all subsequent fields by one, causing a istringstream failure and and heavy_ion()
  // to return null even when the attribute is present and well-formed.
  // For now we use this manual parser in case the infos are available
  if (!hiInfo) {
    auto attStr = mEvent->attribute_as_string("GenHeavyIon");
    if (!attStr.empty() && attStr[0] == 'v') {
      std::istringstream is(attStr);
      std::string version;
      is >> version;
      if (version == "v0") {
        auto hi = std::make_shared<HepMC3::GenHeavyIon>();
        double spectNeutrons, spectProtons, eccentricity, userCentEst;
        is >> hi->Ncoll_hard >> hi->Npart_proj >> hi->Npart_targ >> hi->Ncoll >> spectNeutrons >> spectProtons                                                           // deprecated v0 fields
          >> hi->N_Nwounded_collisions >> hi->Nwounded_N_collisions >> hi->Nwounded_Nwounded_collisions >> hi->impact_parameter >> hi->event_plane_angle >> eccentricity // deprecated v0 field
          >> hi->sigma_inel_NN >> hi->centrality >> userCentEst                                                                                                          // GenHeavyIon::to_string always writes this, but GenHeavyIon::from_string skips it for v0 (HepMC3 bug to fix)
          >> hi->Nspec_proj_n >> hi->Nspec_targ_n >> hi->Nspec_proj_p >> hi->Nspec_targ_p;
        if (!is.fail()) {
          LOG(debug) << "GenHeavyIon: using manual v0 parser (workaround for HepMC3 from_string bug)";
          hiInfo = hi;
        } else {
          LOG(warn) << "GenHeavyIon: manual v0 parser also failed on: [" << attStr << "]";
        }
      }
    }
  }
 
  // Set default cross-section
  if (xSection) {
    eventHeader->putInfo<float>(Key::xSection, xSection->xsec());
    eventHeader->putInfo<float>(Key::xSectionError, xSection->xsec_err());
    eventHeader->putInfo<int>(Key::acceptedEvents,
                              xSection->get_accepted_events());
    eventHeader->putInfo<int>(Key::attemptedEvents,
                              xSection->get_attempted_events());
  }
 
  // Set weights and cross sections
  size_t iw = 0;
  for (auto w : mEvent->weights()) {
    std::string post = (iw > 0 ? "_" + std::to_string(iw) : "");
    eventHeader->putInfo<float>(Key::weight + post, w);
    if (xSection) {
      eventHeader->putInfo<float>(Key::xSection, xSection->xsec(iw));
      eventHeader->putInfo<float>(Key::xSectionError, xSection->xsec_err(iw));
    }
    iw++;
  }
 
  // Set the PDF information
  if (pdfInfo) {
    eventHeader->putInfo<int>(Key::pdfParton1Id, pdfInfo->parton_id[0]);
    eventHeader->putInfo<int>(Key::pdfParton2Id, pdfInfo->parton_id[1]);
    eventHeader->putInfo<float>(Key::pdfX1, pdfInfo->x[0]);
    eventHeader->putInfo<float>(Key::pdfX2, pdfInfo->x[1]);
    eventHeader->putInfo<float>(Key::pdfScale, pdfInfo->scale);
    eventHeader->putInfo<float>(Key::pdfXF1, pdfInfo->xf[0]);
    eventHeader->putInfo<float>(Key::pdfXF2, pdfInfo->xf[1]);
    eventHeader->putInfo<int>(Key::pdfCode1, pdfInfo->pdf_id[0]);
    eventHeader->putInfo<int>(Key::pdfCode2, pdfInfo->pdf_id[1]);
  }
 
  // Set heavy-ion information
  if (hiInfo) {
    eventHeader->SetB(hiInfo->impact_parameter); // sets the impact parameter to the FairMCEventHeader field for quick access in the AO2D
    eventHeader->putInfo<float>(Key::impactParameter,
                                hiInfo->impact_parameter);
    eventHeader->putInfo<int>(Key::nPart,
                              hiInfo->Npart_proj + hiInfo->Npart_targ);
    eventHeader->putInfo<int>(Key::nPartProjectile, hiInfo->Npart_proj);
    eventHeader->putInfo<int>(Key::nPartTarget, hiInfo->Npart_targ);
    eventHeader->putInfo<int>(Key::nColl, hiInfo->Ncoll);
    eventHeader->putInfo<int>(Key::nCollHard, hiInfo->Ncoll_hard);
    eventHeader->putInfo<int>(Key::nCollNNWounded,
                              hiInfo->N_Nwounded_collisions);
    eventHeader->putInfo<int>(Key::nCollNWoundedN,
                              hiInfo->Nwounded_N_collisions);
    eventHeader->putInfo<int>(Key::nCollNWoundedNwounded,
                              hiInfo->Nwounded_Nwounded_collisions);
    eventHeader->putInfo<double>(Key::planeAngle, hiInfo->event_plane_angle);
    eventHeader->putInfo<float>(Key::sigmaInelNN, hiInfo->sigma_inel_NN);
    eventHeader->putInfo<float>(Key::centrality, hiInfo->centrality);
    eventHeader->putInfo<int>(Key::nSpecProjectileProton, hiInfo->Nspec_proj_p);
    eventHeader->putInfo<int>(Key::nSpecProjectileNeutron, hiInfo->Nspec_proj_n);
    eventHeader->putInfo<int>(Key::nSpecTargetProton, hiInfo->Nspec_targ_p);
    eventHeader->putInfo<int>(Key::nSpecTargetNeutron, hiInfo->Nspec_targ_n);
  }
 
  for (auto na : mEvent->attributes()) {
    std::string name = na.first;
    if (name == "GenPdfInfo" ||
        name == "GenCrossSection" ||
        name == "GenHeavyIon") {
      continue;
    }
 
    for (auto ia : na.second) {
      int no = ia.first;
      auto at = ia.second;
      std::string post = (no == 0 ? "" : std::to_string(no));
 
      putAttributeInfo(eventHeader, name + post, at);
    }
  }
}
 
/*****************************************************************/
 
bool GeneratorHepMC::makeReader()
{
  // Reset the reader smart pointer
  LOG(debug) << "Reseting the reader";
  mReader.reset();
 
  // Check that we have any file names left
  if (mFileNames.size() < 1) {
    LOG(debug) << "No more files to read, return false";
    return false;
  }
 
  // If we have file names left, pop the top of the list (LIFO)
  auto filename = mFileNames.front();
  mFileNames.pop_front();
 
  LOG(debug) << "Next file to read: \"" << filename << "\" "
             << mFileNames.size() << " left";
 
  if (not mCmd.empty()) {
    // For FIFO reading, we assume straight ASCII output always.
    // Unfortunately, the HepMC3::deduce_reader `stat`s the filename
    // which isn't supported on a FIFO, so we have to use the reader
    // directly.  Here, we allow for version 2 formats if the user
    // specifies that
    LOG(info) << "Creating ASCII reader of " << filename;
    if (mVersion == 2) {
      mReader = std::make_shared<HepMC3::ReaderAsciiHepMC2>(filename);
    } else {
      mReader = std::make_shared<HepMC3::ReaderAscii>(filename);
    }
  } else {
    LOG(info) << "Deduce a reader of " << filename;
    mReader = HepMC3::deduce_reader(filename);
  }
 
  bool ret = bool(mReader) and not mReader->failed();
  LOG(info) << "Reader is " << mReader.get() << " " << ret;
  return ret;
}
 
/*****************************************************************/
 
Bool_t GeneratorHepMC::Init()
{
  Generator::Init();
 
  // If a EG command line is given, then we make a fifo on a temporary
  // file, and directs the EG to write to that fifo.  We will then set
  // up the HepMC3 reader to read from that fifo.
  //
  //    o2-sim -g hepmc --configKeyValues "HepMC.progCmd=<cmd>" ...
  //
  // where <cmd> is the command line to run an event generator.  The
  // event generator should output HepMC event records to standard
  // output.  Nothing else, but the HepMC event record may be output
  // to standard output.  If the EG has other output to standard
  // output, then a filter can be set-up.  For example
  //
  //    crmc -n 3 -o hepmc3 -c /optsw/inst/etc/crmc.param -f /dev/stdout \
  //      | sed -n 's/^\‍(HepMC::\|[EAUWVP] \‍)/\1/p'
  //
  // What's more, the event generator program _must_ accept the
  // following command line argument
  //
  //    `-n NEVENTS` to set the number of events to produce.
  //
  // Optionally, the command line should also accept
  //
  //    `-s SEED`   to set the random number seed
  //    `-b FM`     to set the maximum impact parameter to sample
  //    `-o OUTPUT` to set the output file name
  //
  // All of this can conviniently be achieved via a wrapper script
  // around the actual EG program.
  if (not mCmd.empty()) {
    if (mFileNames.empty()) {
      // Set filename to be a temporary name
      if (not makeTemp(false)) {
        return false;
      }
    } else {
      // Use the first filename as output for cmd line
      if (not makeTemp(true)) {
        return false;
      }
    }
 
    // Make a fifo
    if (not makeFifo()) {
      return false;
    }
 
    // Build command line, rediret stdout to our fifo and put
    std::string cmd = makeCmdLine();
    LOG(debug) << "EG command line is \"" << cmd << "\"";
 
    // Execute the command line
    if (not executeCmdLine(cmd)) {
      LOG(fatal) << "Failed to spawn \"" << cmd << "\"";
      return false;
    }
  } else {
    // If no command line was given, ensure that all files are present
    // on the system.  Note, in principle, HepMC3 can read from remote
    // files
    //
    //    root://           XRootD served
    //    http[s]://        Web served
    //    gsidcap://        DCap served
    //
    // These will all be handled in HepMC3 via ROOT's TFile protocol
    // and the files are assumed to contain a TTree named
    // `hepmc3_tree` and that tree has the branches
    //
    //    `hepmc3_event`  with object of type `HepMC3::GenEventData`
    //    `GenRunInfo`    with object of type `HepMC3::GenRunInfoData`
    //
    // where the last branch is optional.
    //
    // However, here we will assume system local files.  If _any_ of
    // the listed files do not exist, then we fail.
    if (not ensureFiles()) {
      return false;
    }
  }
 
  // Create reader for current (first) file
  return true;
}
 
/*****************************************************************/
/*****************************************************************/
 
} /* namespace eventgen */
} /* namespace o2 */