SiStripMonitorTrack.h

Go to the documentation of this file.

#ifndef SiStripMonitorTrack_H
#define SiStripMonitorTrack_H

// system include files
#include <memory>
#include <fstream>
#include <iostream>
#include <vector>
#include <string>
#include <unordered_set>

// user include files
#include "FWCore/Utilities/interface/EDGetToken.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/EDAnalyzer.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Utilities/interface/InputTag.h"
#include "FWCore/ServiceRegistry/interface/Service.h"

#include "Geometry/TrackerGeometryBuilder/interface/TrackerGeometry.h"
#include "Geometry/CommonTopologies/interface/StripTopology.h"
#include "Geometry/CommonDetUnit/interface/GeomDetType.h"

#include "DataFormats/Common/interface/Handle.h"
#include "DataFormats/Common/interface/DetSetVector.h"
#include "DataFormats/Common/interface/DetSetNew.h"
#include "DataFormats/TrackingRecHit/interface/TrackingRecHit.h"
#include "DataFormats/SiStripCluster/interface/SiStripCluster.h"
#include "DataFormats/TrackReco/interface/Track.h"
#include "Geometry/TrackerGeometryBuilder/interface/StripGeomDetUnit.h"

#include "AnalysisDataFormats/SiStripClusterInfo/interface/SiStripClusterInfo.h"
#include "TrackingTools/PatternTools/interface/Trajectory.h"
#include "TrackingTools/PatternTools/interface/TrajTrackAssociation.h"
#include "CalibFormats/SiStripObjects/interface/SiStripDetCabling.h"

#include "DQM/SiStripCommon/interface/SiStripFolderOrganizer.h"
#include "DQMServices/Core/interface/DQMStore.h"
#include "DQMServices/Core/interface/MonitorElement.h"

#include "DataFormats/TrackerRecHit2D/interface/SiStripRecHit2D.h"

//******** Single include for the TkMap *************
#include "DQM/SiStripCommon/interface/TkHistoMap.h"
//***************************************************

#include <DQMServices/Core/interface/DQMEDAnalyzer.h>

class SiStripDCSStatus;
class GenericTriggerEventFlag;
class TrackerTopology;

//
// class declaration
//

class SiStripMonitorTrack : public DQMEDAnalyzer {
public:
  typedef TrackingRecHit::ConstRecHitPointer ConstRecHitPointer;
  enum RecHitType { Single=0, Matched=1, Projected=2, Null=3};
  explicit SiStripMonitorTrack(const edm::ParameterSet&);
  ~SiStripMonitorTrack() override;
  void dqmBeginRun(const edm::Run& run, const edm::EventSetup& es)  override;
  void analyze(const edm::Event&, const edm::EventSetup&) override;
  void bookHistograms(DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &) override;

private:
  enum ClusterFlags {
    OffTrack,
    OnTrack
  };

  struct Det2MEs;

  //booking
  void book(DQMStore::IBooker &, const TrackerTopology* tTopo, const TkDetMap* tkDetMap);
  void bookModMEs(DQMStore::IBooker &, const uint32_t );
  void bookLayerMEs(DQMStore::IBooker &, const uint32_t, std::string&);
  void bookRing(DQMStore::IBooker &, const uint32_t, std::string&);
  MonitorElement* handleBookMEs(DQMStore::IBooker &, std::string&, std::string&, std::string&, std::string&);
  void bookRingMEs(DQMStore::IBooker &, const uint32_t, std::string&);
  void bookSubDetMEs(DQMStore::IBooker &, std::string& name);
  MonitorElement * bookME1D(DQMStore::IBooker & , const char*, const char*);
  MonitorElement * bookME2D(DQMStore::IBooker & , const char*, const char*);
  MonitorElement * bookME3D(DQMStore::IBooker & , const char*, const char*);
  MonitorElement * bookMEProfile(DQMStore::IBooker & , const char*, const char*);
  MonitorElement * bookMETrend(DQMStore::IBooker & , const char*);
  // internal evaluation of monitorables
  void AllClusters(const edm::Event& ev, const edm::EventSetup& es);
  void trackStudyFromTrack(
    edm::Handle<reco::TrackCollection >   trackCollectionHandle,
    const edm::DetSetVector<SiStripDigi>& digilist,
    const edm::Event&                     ev,
    const edm::EventSetup&                es);
  void trackStudyFromTrajectory(
    edm::Handle<reco::TrackCollection >   trackCollectionHandle,
    const edm::DetSetVector<SiStripDigi>& digilist,
    const edm::Event&                     ev,
    const edm::EventSetup&                es);
  void trajectoryStudy(
    const reco::Track&                    track,
    const edm::DetSetVector<SiStripDigi>& digilist,
    const edm::Event&                     ev,
    const edm::EventSetup&                es,
    bool                                  track_ok);
  void trackStudy(const edm::Event& ev, const edm::EventSetup& es);
  bool trackFilter(const reco::Track& track);
  //  LocalPoint project(const GeomDet *det,const GeomDet* projdet,LocalPoint position,LocalVector trackdirection)const;
  void hitStudy(
    const edm::Event&                      ev,
    const edm::EventSetup&                 es,
    const edm::DetSetVector<SiStripDigi>&  digilist,
      const ProjectedSiStripRecHit2D*        projhit,
      const SiStripMatchedRecHit2D*          matchedhit,
      const SiStripRecHit2D*                 hit2D,
      const SiStripRecHit1D*                 hit1D,
              LocalVector                      localMomentum,
      const bool                             track_ok);
  bool clusterInfos(
    SiStripClusterInfo* cluster,
    const uint32_t detid,
    enum ClusterFlags flags,
    bool track_ok,
    LocalVector LV,
    const Det2MEs& MEs ,
    const TrackerTopology* tTopo,
    const SiStripGain*     stripGain,
    const SiStripQuality*  stripQuality,
    const edm::DetSetVector<SiStripDigi>& digilist
  );
  template <class T> void RecHitInfo(
    const T*                              tkrecHit,
          LocalVector                     LV,
    const edm::DetSetVector<SiStripDigi>& digilist,
    const edm::Event&                     ev,
    const edm::EventSetup&                es,
    bool  track_ok
  );
  
  bool fillControlViewHistos(const edm::Event& ev, const edm::EventSetup& es);
  void return2DME(MonitorElement* input1,MonitorElement* input2, int binx, int biny, double value);

  // fill monitorables
//  void fillModMEs(SiStripClusterInfo* cluster,std::string name, float cos, const uint32_t detid, const LocalVector LV);
//  void fillMEs(SiStripClusterInfo*,const uint32_t detid, float,enum ClusterFlags,  const LocalVector LV, const Det2MEs& MEs);

  inline void fillME(MonitorElement* ME,float value1){if (ME!=nullptr)ME->Fill(value1);}
  inline void fillME(MonitorElement* ME,float value1,float value2){if (ME!=nullptr)ME->Fill(value1,value2);}
  inline void fillME(MonitorElement* ME,float value1,float value2,float value3){if (ME!=nullptr)ME->Fill(value1,value2,value3);}
  inline void fillME(MonitorElement* ME,float value1,float value2,float value3,float value4){if (ME!=nullptr)ME->Fill(value1,value2,value3,value4);}

  Det2MEs findMEs(const TrackerTopology* tTopo, const uint32_t detid);

  // ----------member data ---------------------------
private:
  edm::ParameterSet conf_;
  std::string histname;
  LocalVector LV;
  float iOrbitSec , iLumisection;

  std::string topFolderName_;

  //******* TkHistoMaps
  std::unique_ptr<TkHistoMap> tkhisto_StoNCorrOnTrack, tkhisto_NumOnTrack, tkhisto_NumOffTrack;
  std::unique_ptr<TkHistoMap> tkhisto_ClChPerCMfromOrigin, tkhisto_ClChPerCMfromTrack;
  std::unique_ptr<TkHistoMap> tkhisto_NumMissingHits, tkhisto_NumberInactiveHits, tkhisto_NumberValidHits;
  std::unique_ptr<TkHistoMap> tkhisto_NoiseOnTrack, tkhisto_NoiseOffTrack, tkhisto_ClusterWidthOnTrack, tkhisto_ClusterWidthOffTrack;
  //******** TkHistoMaps
  int numTracks;

  struct ModMEs{
    MonitorElement* ClusterStoNCorr = nullptr;
    MonitorElement* ClusterGain = nullptr;
    MonitorElement* ClusterCharge = nullptr;
    MonitorElement* ClusterChargeRaw = nullptr;
    MonitorElement* ClusterChargeCorr = nullptr;
    MonitorElement* ClusterWidth = nullptr;
    MonitorElement* ClusterPos = nullptr;
    MonitorElement* ClusterPGV = nullptr;
    MonitorElement* ClusterChargePerCMfromTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromOrigin = nullptr;
  };

  struct LayerMEs{
    MonitorElement* ClusterGain = nullptr;
    MonitorElement* ClusterStoNCorrOnTrack = nullptr;
    MonitorElement* ClusterChargeCorrOnTrack = nullptr;
    MonitorElement* ClusterChargeOnTrack = nullptr;
    MonitorElement* ClusterChargeOffTrack = nullptr;
    MonitorElement* ClusterChargeRawOnTrack = nullptr;
    MonitorElement* ClusterChargeRawOffTrack = nullptr;
    MonitorElement* ClusterNoiseOnTrack = nullptr;
    MonitorElement* ClusterNoiseOffTrack = nullptr;
    MonitorElement* ClusterWidthOnTrack = nullptr;
    MonitorElement* ClusterWidthOffTrack = nullptr;
    MonitorElement* ClusterPosOnTrack = nullptr;
    MonitorElement* ClusterPosOffTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromOriginOnTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromOriginOffTrack = nullptr;
  };
  struct RingMEs{
    MonitorElement* ClusterGain = nullptr;
    MonitorElement* ClusterStoNCorrOnTrack = nullptr;
    MonitorElement* ClusterChargeCorrOnTrack = nullptr;
    MonitorElement* ClusterChargeOnTrack = nullptr;
    MonitorElement* ClusterChargeOffTrack = nullptr;
    MonitorElement* ClusterChargeRawOnTrack = nullptr;
    MonitorElement* ClusterChargeRawOffTrack = nullptr;
    MonitorElement* ClusterNoiseOnTrack = nullptr;
    MonitorElement* ClusterNoiseOffTrack = nullptr;
    MonitorElement* ClusterWidthOnTrack = nullptr;
    MonitorElement* ClusterWidthOffTrack = nullptr;
    MonitorElement* ClusterPosOnTrack = nullptr;
    MonitorElement* ClusterPosOffTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromOriginOnTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromOriginOffTrack = nullptr;
  };
  struct SubDetMEs{
    int totNClustersOnTrack = 0;
    int totNClustersOffTrack = 0;
    MonitorElement* nClustersOnTrack = nullptr;
    MonitorElement* nClustersTrendOnTrack = nullptr;
    MonitorElement* nClustersOffTrack = nullptr;
    MonitorElement* nClustersTrendOffTrack = nullptr;
    MonitorElement* ClusterGain = nullptr;
    MonitorElement* ClusterStoNCorrOnTrack = nullptr;
    MonitorElement* ClusterStoNCorrThinOnTrack = nullptr;
    MonitorElement* ClusterStoNCorrThickOnTrack = nullptr;
    MonitorElement* ClusterChargeCorrOnTrack = nullptr;
    MonitorElement* ClusterChargeCorrThinOnTrack = nullptr;
    MonitorElement* ClusterChargeCorrThickOnTrack = nullptr;
    MonitorElement* ClusterChargeOnTrack = nullptr;
    MonitorElement* ClusterChargeOffTrack = nullptr;
    MonitorElement* ClusterChargeRawOnTrack = nullptr;
    MonitorElement* ClusterChargeRawOffTrack = nullptr;
    MonitorElement* ClusterStoNOffTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromOriginOnTrack = nullptr;
    MonitorElement* ClusterChargePerCMfromOriginOffTrack = nullptr;
  };
  std::map<std::string, ModMEs>       ModMEsMap;
  std::map<std::string, LayerMEs>     LayerMEsMap;
  std::map<std::string, RingMEs>      RingMEsMap;
  std::map<std::string, SubDetMEs>    SubDetMEsMap;

  struct Det2MEs {
      struct LayerMEs *iLayer;
      struct RingMEs *iRing;
      struct SubDetMEs *iSubdet;
  };

  edm::ESHandle<TrackerGeometry> tkgeom_;
  edm::ESHandle<SiStripDetCabling> SiStripDetCabling_;

  edm::ParameterSet Parameters;
  edm::InputTag Cluster_src_;

  edm::EDGetTokenT<edm::DetSetVector<SiStripDigi> > digiToken_;
  edm::EDGetTokenT<edmNew::DetSetVector<SiStripCluster> > clusterToken_;
  edm::EDGetTokenT<reco::TrackCollection> trackToken_;

  bool Mod_On_;
  bool Trend_On_;
  bool OffHisto_On_;
  bool HistoFlag_On_;
  bool ring_flag;
  bool TkHistoMap_On_;
  bool clchCMoriginTkHmap_On_;

  std::string TrackProducer_;
  std::string TrackLabel_;

  std::unordered_set<const SiStripCluster*> vPSiStripCluster;
  bool tracksCollection_in_EventTree;
  bool trackAssociatorCollection_in_EventTree;
  edm::EventNumber_t eventNb;
  int firstEvent;

  bool   applyClusterQuality_;
  double sToNLowerLimit_;
  double sToNUpperLimit_;
  double widthLowerLimit_;
  double widthUpperLimit_;

  SiStripDCSStatus* dcsStatus_;
  GenericTriggerEventFlag* genTriggerEventFlag_;
  SiStripFolderOrganizer folderOrganizer_;
  
  // control view plots
  MonitorElement* ClusterStoNCorr_OnTrack_TIBTID = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_TOB    = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_TECM   = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_TECP   = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_FECCratevsFECSlot = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_FECSlotVsFECRing_TIBTID = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_FECSlotVsFECRing_TOB    = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_FECSlotVsFECRing_TECM   = nullptr;
  MonitorElement* ClusterStoNCorr_OnTrack_FECSlotVsFECRing_TECP   = nullptr;
  
  MonitorElement* ClusterCount_OnTrack_FECCratevsFECSlot = nullptr;
  MonitorElement* ClusterCount_OnTrack_FECSlotVsFECRing_TIBTID = nullptr;
  MonitorElement* ClusterCount_OnTrack_FECSlotVsFECRing_TOB    = nullptr;
  MonitorElement* ClusterCount_OnTrack_FECSlotVsFECRing_TECM   = nullptr;
  MonitorElement* ClusterCount_OnTrack_FECSlotVsFECRing_TECP   = nullptr;

};
#endif