AODMcProducerHelpers.h

Go to the documentation of this file.

// Copyright 2023-2099 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.
 
 
#ifndef O2_AODMCPRODUCER_HELPERS
#define O2_AODMCPRODUCER_HELPERS
#include <SimulationDataFormat/MCEventHeader.h>
#include <SimulationDataFormat/MCTrack.h>
#include <Framework/AnalysisDataModel.h>
#include <Framework/FunctionalHelpers.h>
#include <Framework/TableBuilder.h>
#include <string>
#include <vector>
#include <unordered_map>
 
namespace o2::aodmchelpers
{
//==================================================================
template <typename Table>
struct TableCursor {
  using type = decltype(framework::FFL(std::declval<framework::TableBuilder>()
                                         .cursor<Table>()));
};
//==================================================================
using CollisionCursor = TableCursor<aod::McCollisions>::type;
using ParticleCursor = TableCursor<aod::StoredMcParticles_001>::type;
using XSectionCursor = TableCursor<aod::HepMCXSections>::type;
using PdfInfoCursor = TableCursor<aod::HepMCPdfInfos>::type;
using HeavyIonCursor = TableCursor<aod::HepMCHeavyIons>::type;
//==================================================================
enum HepMCUpdate {
  never,
  always,
  anyKey,
  allKeys
};
 
//==================================================================
bool hasKeys(o2::dataformats::MCEventHeader const& header,
             const std::vector<std::string>& keys,
             bool anyNotall = true);
//--------------------------------------------------------------------
template <typename T>
const T getEventInfo(o2::dataformats::MCEventHeader const& header,
                     std::string const& key,
                     T const& def)
{
  if (not header.hasInfo(key))
    return def;
 
  bool isValid = false;
  const T& val = header.getInfo<T>(key, isValid);
  if (not isValid)
    return def;
 
  return val;
}
//====================================================================
short updateMCCollisions(const CollisionCursor& cursor,
                         int bcId,
                         float time,
                         o2::dataformats::MCEventHeader const& header,
                         short generatorId = 0,
                         int sourceId = 0,
                         unsigned int mask = 0xFFFFFFF0);
//--------------------------------------------------------------------
bool updateHepMCXSection(const XSectionCursor& cursor,
                         int collisionID,
                         short generatorID,
                         o2::dataformats::MCEventHeader const& header,
                         HepMCUpdate when = HepMCUpdate::anyKey);
//--------------------------------------------------------------------
bool updateHepMCPdfInfo(const PdfInfoCursor& cursor,
                        int collisionID,
                        short generatorID,
                        o2::dataformats::MCEventHeader const& header,
                        HepMCUpdate when = HepMCUpdate::anyKey);
//--------------------------------------------------------------------
bool updateHepMCHeavyIon(const HeavyIonCursor& cursor,
                         int collisionID,
                         short generatorID,
                         o2::dataformats::MCEventHeader const& header,
                         HepMCUpdate when = HepMCUpdate::anyKey);
//--------------------------------------------------------------------
using TrackToIndex = std::unordered_map<int, int>;
//--------------------------------------------------------------------
void updateParticle(const ParticleCursor& cursor,
                    const TrackToIndex& toStore,
                    int collisionID,
                    o2::MCTrack const& track,
                    std::vector<MCTrack> const& tracks,
                    uint8_t flags = 0,
                    uint32_t weightMask = 0xFFFFFFF0,
                    uint32_t momentumMask = 0xFFFFFFF0,
                    uint32_t positionMask = 0xFFFFFFF0);
//--------------------------------------------------------------------
uint32_t updateParticles(const ParticleCursor& cursor,
                         int collisionID,
                         std::vector<MCTrack> const& tracks,
                         TrackToIndex& preselect,
                         uint32_t offset = 0,
                         bool filter = false,
                         bool background = false,
                         uint32_t weightMask = 0xFFFFFFF0,
                         uint32_t momentumMask = 0xFFFFFFF0,
                         uint32_t positionMask = 0xFFFFFFF0);
} // namespace o2::aodmchelpers
 
#endif /* O2_AODMCPRODUCER_HELPERS */
// Local Variables:
//   mode: C++
// End: