KLMEventT0EstimatorModule.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
 
/* KLM geometry & dataobjects */
#include <klm/bklm/geometry/GeometryPar.h>
#include <klm/eklm/geometry/GeometryData.h>
#include <klm/eklm/geometry/TransformData.h>
#include <klm/dataobjects/KLMHit2d.h>
#include <klm/dataobjects/KLMDigit.h>
#include <klm/dataobjects/bklm/BKLMHit1d.h>
#include <klm/dataobjects/KLMElementNumbers.h>
#include <klm/dataobjects/KLMMuidLikelihood.h>
 
/* KLM conditions */
#include <klm/dbobjects/KLMChannelStatus.h>
#include <klm/dbobjects/KLMTimeConstants.h>
#include <klm/dbobjects/KLMTimeCableDelay.h>
#include <klm/dbobjects/KLMEventT0HitResolution.h>
 
/* Tracking / analysis */
#include <mdst/dataobjects/Track.h>
#include <tracking/dataobjects/ExtHit.h>
#include <analysis/dataobjects/Particle.h>
#include <analysis/dataobjects/ParticleList.h>
 
/* Framework */
#include <framework/core/HistoModule.h>
#include <framework/datastore/StoreObjPtr.h>
#include <framework/datastore/StoreArray.h>
#include <framework/database/DBObjPtr.h>
#include <framework/datastore/RelationVector.h>
#include <framework/dataobjects/EventT0.h>
#include <framework/dataobjects/EventExtraInfo.h>
#include <framework/gearbox/Unit.h>
 
/* ROOT headers. */
#include <TDirectory.h>
#include <TH1D.h>
#include <TH1I.h>
 
/* C++ headers. */
#include <cmath>
#include <vector>
#include <map>
#include <string>
#include <utility>
 
namespace Belle2 {

  class KLMEventT0EstimatorModule : public HistoModule {
 
  public:
    KLMEventT0EstimatorModule();
    ~KLMEventT0EstimatorModule() override;

    KLMEventT0EstimatorModule(const KLMEventT0EstimatorModule&) = delete;

    KLMEventT0EstimatorModule& operator=(const KLMEventT0EstimatorModule&) = delete;

    void defineHisto() override;

    void initialize() override;

    void beginRun() override;

    void event() override;

    struct CategorySums {
      double sumW{0.0};   
      double sumWT{0.0};  
      int nHits{0};       
      int sumSector{0};   
      int sumSection{0};  
    };
 
  private:
    /* Local helpers. */

    using ExtMap  = std::multimap<unsigned int, Belle2::ExtHit>;

    using ExtPair = std::pair<Belle2::ExtHit*, Belle2::ExtHit*>;
 
    double m_ADCCut_BKLM_Scint_Min;  
    double m_ADCCut_BKLM_Scint_Max;  
    double m_ADCCut_EKLM_Scint_Min;  
    double m_ADCCut_EKLM_Scint_Max;  

    bool passesADCCut(double charge, int subdetector, int layer, bool inRPC) const;

    void collectExtrapolatedHits(const Track* track, ExtMap& scintMap, ExtMap& rpcMap);

    ExtPair matchExt(unsigned int key, ExtMap& v_ExtHits);

    double getHitSigma(int subdetector, int layer, bool inRPC) const;

    void accumulateEKLM(const RelationVector<KLMHit2d>&, const ExtMap&,
                        CategorySums& sums);

    void accumulateBKLMScint(RelationVector<KLMHit2d>&, const ExtMap&,
                             CategorySums& sums);

    void accumulateBKLMRPC(RelationVector<KLMHit2d>& klmHit2ds, const ExtMap& rpcMap,
                           CategorySums& sums);
 
    /* ---------- Parameters (set via addParam in constructor) ---------- */

    std::string m_MuonListName;

    bool m_useCDCTemporaryT0{true};

    bool m_ignoreBackward{false};

    std::string m_histDirName;

    std::string m_histSubdirUncorr{"uncorrected"};
 
    /* Geometry and conditions. */

    Belle2::bklm::GeometryPar* m_geoParB{nullptr};

    const Belle2::EKLM::GeometryData* m_geoParE{nullptr};

    Belle2::EKLM::TransformData* m_transformE{nullptr};

    const KLMElementNumbers* m_elementNum{&KLMElementNumbers::Instance()};

    DBObjPtr<KLMChannelStatus> m_channelStatus;

    DBObjPtr<KLMEventT0HitResolution> m_eventT0HitResolution;
 
    /* Inputs. */

    StoreObjPtr<ParticleList> m_MuonList;

    StoreArray<Track> m_tracks;

    StoreObjPtr<EventExtraInfo> m_eventExtraInfo;
 
    /* Working buffers. */

    ExtMap m_extScint;

    ExtMap m_extRPC;

    double m_seedT0{0.0};
 
    /* Monitoring histograms. */

    TH1D* m_hT0Trk_BKLM_Scint{nullptr};

    TH1D* m_hT0Trk_BKLM_RPC{nullptr};

    TH1D* m_hT0Trk_EKLM_Scint{nullptr};

    TH1D* m_hT0Evt_TrkAvg_BKLM_Scint{nullptr};

    TH1D* m_hT0Evt_TrkAvg_BKLM_RPC{nullptr};

    TH1D* m_hT0Evt_TrkAvg_EKLM_Scint{nullptr};

    TH1D* m_hT0Evt_TrkAvg_All{nullptr};

    TH1D* m_hT0Evt_TrkAvg_BKLM_Scint_SEM{nullptr};

    TH1D* m_hT0Evt_TrkAvg_BKLM_RPC_SEM{nullptr};

    TH1D* m_hT0Evt_TrkAvg_EKLM_Scint_SEM{nullptr};

    TH1D* m_hT0Evt_TrkAvg_All_SEM{nullptr};

    TH1I* m_hFinalSource{nullptr};
  };

} // namespace Belle2