SVDClusterizerModule.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 <framework/datastore/StoreArray.h>
#include <framework/database/DBObjPtr.h>
 
#include <svd/reconstruction/RawCluster.h>
#include <svd/reconstruction/SVDClusterTime.h>
#include <svd/reconstruction/SVDClusterCharge.h>
#include <svd/reconstruction/SVDClusterPosition.h>
 
#include <mdst/dataobjects/MCParticle.h>
#include <svd/dataobjects/SVDShaperDigit.h>
#include <svd/dataobjects/SVDCluster.h>
#include <svd/dataobjects/SVDTrueHit.h>
 
#include <svd/calibration/SVDPulseShapeCalibrations.h>
#include <svd/calibration/SVDNoiseCalibrations.h>
#include <svd/calibration/SVDClustering.h>
#include <svd/calibration/SVDMCClusterPositionFudgeFactor.h>
#include <svd/calibration/SVDMCClusterTimeFudgeFactor.h>
#include <svd/dbobjects/SVDRecoConfiguration.h>
#include <svd/dbobjects/SVDClusterTimeShifter.h>
#include <framework/dbobjects/HardwareClockSettings.h>
 
#include <TMath.h>
 
namespace Belle2 {
  namespace SVD {
 
    class SVDClusterizerModule : public Module {
 
    public:
 
      SVDClusterizerModule();
 
      void initialize() override;
 
      void beginRun() override;
 
      void event() override;
 
      void endRun() override;
 
    protected:
 
      //1. Collections and relations Names
      std::string m_svdEventInfoName;
      std::string m_storeShaperDigitsName;
      std::string m_storeClustersName;
      std::string m_storeTrueHitsName;
      std::string m_storeMCParticlesName;
 
      std::string m_relShaperDigitMCParticleName;
      std::string m_relClusterMCParticleName;
      std::string m_relClusterShaperDigitName;
      std::string m_relShaperDigitTrueHitName;
      std::string m_relClusterTrueHitName;
 
      StoreArray<SVDCluster> m_storeClusters;
      StoreArray<SVDShaperDigit> m_storeDigits;
      StoreArray<SVDTrueHit> m_storeTrueHits;
      StoreArray<MCParticle> m_storeMCParticles;
 
      // 2. Clustering
      double m_cutSeed = 5;
      double m_cutAdjacent = 3;
      double m_cutCluster = 0;
      bool m_useDB = true;
 
      // 3. Cluster Reconstruction Configuration:
      int m_numberOfAcquiredSamples = 0; 
      std::string m_timeRecoWith6SamplesAlgorithm = "not set";
      std::string m_timeRecoWith3SamplesAlgorithm = "not set";
      std::string m_chargeRecoWith6SamplesAlgorithm = "not set";
      std::string m_chargeRecoWith3SamplesAlgorithm = "not set";
      std::string m_positionRecoWith6SamplesAlgorithm = "not set";
      std::string m_positionRecoWith3SamplesAlgorithm = "not set";
 
      std::string m_stripTimeRecoWith6SamplesAlgorithm = "not set";
      std::string m_stripTimeRecoWith3SamplesAlgorithm = "not set";
      std::string m_stripChargeRecoWith6SamplesAlgorithm = "not set";
      std::string m_stripChargeRecoWith3SamplesAlgorithm = "not set";
 
      SVDClusterTime* m_time6SampleClass = nullptr; 
      SVDClusterTime* m_time3SampleClass = nullptr; 
      SVDClusterCharge* m_charge6SampleClass = nullptr; 
      SVDClusterCharge* m_charge3SampleClass = nullptr; 
      SVDClusterPosition* m_position6SampleClass = nullptr; 
      SVDClusterPosition* m_position3SampleClass = nullptr; 
      // 4. Calibration Objects
      bool m_returnRawClusterTime = false; 
      bool m_shiftSVDClusterTime = true; 
      DBObjPtr<HardwareClockSettings> m_hwClock;  
      DBObjPtr<SVDRecoConfiguration> m_recoConfig; 
      SVDNoiseCalibrations m_NoiseCal; 
      SVDClustering m_ClusterCal; 
      SVDMCClusterPositionFudgeFactor m_mcPositionFudgeFactor; 
      SVDMCClusterTimeFudgeFactor m_mcTimeFudgeFactor; 
      DBObjPtr<SVDClusterTimeShifter> m_svdClusterTimeShifter; 
      double applyLorentzShiftCorrection(double position, VxdID vxdID, bool isU);
 
      void finalizeCluster(Belle2::SVD::RawCluster& rawCluster);
 
      void writeClusterRelations(const Belle2::SVD::RawCluster& rawCluster);
 
      void alterClusterPosition();
 
      void alterClusterTime();
 
      void shiftSVDClusterTime();
 
    };// end class declarations
 
 
  } //end SVD namespace;
} // end namespace Belle2