ParticleLoaderModule.h

/**************************************************************************
 * 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.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/core/Module.h>
 
#include <analysis/DecayDescriptor/DecayDescriptor.h>
 
// framework - DataStore
#include <framework/datastore/StoreArray.h>
#include <framework/datastore/StoreObjPtr.h>
 
// dataobjects
#include <mdst/dataobjects/V0.h>
#include <mdst/dataobjects/Kink.h>
#include <mdst/dataobjects/ECLCluster.h>
#include <mdst/dataobjects/KLMCluster.h>
#include <mdst/dataobjects/MCParticle.h>
#include <mdst/dataobjects/Track.h>
#include <mdst/dataobjects/TrackFitResult.h>
#include <mdst/dataobjects/PIDLikelihood.h>
 
#include <analysis/dataobjects/RestOfEvent.h>
#include <analysis/dataobjects/Particle.h>
#include <analysis/dataobjects/ParticleExtraInfoMap.h>
 
#include <vector>
#include <tuple>
#include <string>
 
namespace Belle2 {

  class ParticleLoaderModule : public Module {

    typedef std::tuple<int, std::string, std::string, bool> PList;
    enum PListIndex {
      c_PListPDGCode, c_PListName, c_AntiPListName, c_IsPListSelfConjugated
    };
 
  public:

    ParticleLoaderModule();

    virtual void initialize() override;

    virtual void event() override;

    virtual void terminate() override;
 
  private:
 

    void mcParticlesToParticles();

    void mdstToParticle();

    void tracksToParticles();

    void eclAndKLMClustersToParticles();

    bool isValidECLCluster(const ECLCluster* cluster, const int pdgCode, bool onlyNeutral) const;

    void assignMCParticleFromECLCluster(Particle* newPart, const ECLCluster* cluster) const;

    void chargedClustersToParticles();

    void v0sToParticles();

    void kinksToParticles();

    void roeToParticles();

    void addROEToParticleList(RestOfEvent* roe, int mdstIndex, int pdgCode = 0, bool isSelfConjugatedParticle = true);

    void dummyToParticles();

    bool isValidPDGCode(const int pdgCode);

    void appendDaughtersRecursive(Particle* mother);
 
    StoreArray<Particle> m_particles; 
    StoreArray<MCParticle> m_mcparticles; 
    StoreArray<ECLCluster> m_eclclusters; 
    StoreArray<KLMCluster> m_klmclusters; 
    StoreArray<PIDLikelihood> m_pidlikelihoods; 
    StoreArray<Track> m_tracks; 
    StoreArray<TrackFitResult> m_trackfitresults; 
    StoreObjPtr<ParticleExtraInfoMap> m_particleExtraInfoMap; 
    StoreArray<RestOfEvent> m_roes; 
    StoreArray<V0> m_v0s; 
    StoreArray<Kink> m_kinks; 
 
    bool m_useMCParticles;  
 
    bool m_useROEs;  
 
    bool m_useDummy;  
 
    bool m_loadChargedCluster;  
    bool m_useOnlyMostEnergeticECLCluster;  
 
    DecayDescriptor m_decaydescriptor; 
    int m_properties; 
 
    std::vector<std::string> m_decayStrings; 
 
    std::vector<PList> m_MCParticles2Plists; 
    std::vector<PList> m_Tracks2Plists; 
    std::vector<PList> m_V02Plists; 
    std::vector<PList> m_Kink2Plists; 
    std::vector<PList> m_ROE2Plists; 
    std::vector<PList>
    m_ECLKLMClusters2Plists; 
    std::vector<PList> m_Dummies2Plists; 
    std::vector<PList> m_ChargedCluster2Plists; 
 
 
    bool m_writeOut;  
    bool m_skipInitial; 
    bool m_skipNonPrimary; 
    bool m_addDaughters; 
    bool m_skipNonPrimaryDaughters; 
    std::string m_roeMaskName; 
    std::string m_sourceParticleListName; 
    bool m_useMissing; 
    int m_trackHypothesis; 
 
    int m_dummyMDSTIndex;  
    double m_dummyCovMatrix;  
    bool m_dummyTreatAsInvisible; 
 
    bool m_enforceFitHypothesis =
      false; 
 
    std::vector<int> m_chargeZeroTrackCounts; 
    std::vector<int> m_sameChargeDaughtersV0Counts; 
  };

} // Belle2 namespace