KLMDQM2Module.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 headers. */
#include <klm/bklm/geometry/GeometryPar.h>
#include <klm/dataobjects/bklm/BKLMElementNumbers.h>
#include <klm/dataobjects/eklm/EKLMElementNumbers.h>
#include <klm/dataobjects/KLMDigit.h>
#include <klm/dataobjects/KLMElementNumbers.h>
#include <klm/dataobjects/KLMPlaneArrayIndex.h>
#include <klm/dbobjects/KLMChannelStatus.h>
 
/* Basf2 headers. */
#include <analysis/dataobjects/ParticleList.h>
#include <framework/core/HistoModule.h>
#include <framework/database/DBObjPtr.h>
#include <framework/datastore/StoreArray.h>
#include <framework/datastore/StoreObjPtr.h>
#include <mdst/dataobjects/SoftwareTriggerResult.h>
#include <tracking/dataobjects/ExtHit.h>
 
/* ROOT headers. */
#include <TH1F.h>
 
/* C++ headers. */
#include <map>
#include <string>
 
 
namespace Belle2 {
  class KLMDQM2Module : public HistoModule {
 
  public:

    struct HitData {

      int subdetector;

      int section;

      int layer;

      int sector;

      int plane;

      int strip;

      double localPosition;

      const ExtHit* hit;

      const KLMDigit* digit;
 
    };

    KLMDQM2Module();

    ~KLMDQM2Module() override;

    void defineHisto() override;

    virtual void initialize() override;

    virtual void beginRun() override;

    virtual void event() override;
 
 
 
  private:
 
    /*******************************************/
    /*******************************************/
    //PRE-DEFINED FUNCTIONS
    /*******************************************/
    /*******************************************/
 

    void findMatchingDigit(struct HitData* hitData);

    bool collectDataTrack(const Particle* muon, TH1F* matchedHitsBKLM,
                          TH1F* allExtHitsBKLM, TH1F* matchedHitsEKLM,
                          TH1F* allExtHitsEKLM, TH1F* matchedHitsBKLMSec,
                          TH1F* allExtHitsBKLMSec, TH1F* matchedHitsEKLMSec,
                          TH1F* allExtHitsEKLMSec);

    void addHit(std::map<KLMPlaneNumber, struct HitData>& hitMap,
                KLMPlaneNumber planeGlobal, struct HitData* hitData);

    bool triggerFlag();
 
    /*******************************************/
    /*******************************************/
    //INPUT RELATED
    /*******************************************/
    /*******************************************/

    const KLMElementNumbers* m_ElementNumbers;

    const EKLMElementNumbers* m_eklmElementNumbers;

    const KLMPlaneArrayIndex* m_PlaneArrayIndex;

    const bklm::GeometryPar* m_GeometryBKLM;

    StoreArray<KLMDigit> m_Digits;

    StoreObjPtr<SoftwareTriggerResult> m_softwareTriggerResult;

    StoreArray<ExtHit> m_extHits;

    StoreObjPtr<ParticleList> m_MuonList;

    DBObjPtr<KLMChannelStatus> m_ChannelStatus;
 
    /*******************************************/
    /*******************************************/
    //MODULE PARAMETERS
    /*******************************************/
    /*******************************************/

    std::string m_MuonListName;

    double m_AllowedDistance1D;

    int m_MinimalMatchingDigits;

    int m_MinimalMatchingDigitsOuterLayers;

    double m_MinimalMomentumNoOuterLayers;

    bool m_RemoveUnusedMuons;

    bool m_IgnoreBackwardPropagation;

    std::string m_HistogramDirectoryName;

    std::string m_SoftwareTriggerName;
 
    /*******************************************/
    /*******************************************/
    //OUTPUT RELATED
    /*******************************************/
    /*******************************************/

    TH1F* m_MatchedHitsBKLM;

    TH1F* m_AllExtHitsBKLM;

    TH1F* m_MatchedHitsEKLM;

    TH1F* m_AllExtHitsEKLM;

    TH1F* m_MatchedHitsBKLMSector;

    TH1F* m_AllExtHitsBKLMSector;

    TH1F* m_MatchedHitsEKLMSector;

    TH1F* m_AllExtHitsEKLMSector;
 
 
    /*******************************************/
    /*******************************************/
    //OTHER USEFUL VARIABLES
    /*******************************************/
    /*******************************************/

    const int m_PlaneNumBKLM = BKLMElementNumbers::getMaximalLayerGlobalNumber(); // 15 layers per octant, forward and backward

    const int m_PlaneNumEKLM = EKLMElementNumbers::getMaximalPlaneGlobalNumber(); // 12 or 14 layers per quadrant, forward and backward
 
  };

}