MatchCosmics.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef ALICEO2_MATCH_COSMICS
#define ALICEO2_MATCH_COSMICS
 
#include <Rtypes.h>
#include <MathUtils/Primitive2D.h>
#include "ReconstructionDataFormats/TrackCosmics.h"
#include "ReconstructionDataFormats/GlobalTrackID.h"
#include "ReconstructionDataFormats/GlobalTrackAccessor.h"
#include "ReconstructionDataFormats/BaseCluster.h"
#include "DataFormatsITSMFT/TopologyDictionary.h"
#include "SimulationDataFormat/MCCompLabel.h"
#include "GlobalTracking/MatchCosmicsParams.h"
#include "CommonUtils/TreeStreamRedirector.h"
#include "TPCFastTransform.h"
 
#define _ALLOW_DEBUG_TREES_COSM // to allow debug and control tree output
 
namespace o2
{
namespace tpc
{
class VDriftCorrFact;
}
namespace gpu
{
class CorrectionMapsHelper;
}
namespace globaltracking
{
 
namespace o2d = o2::dataformats;
 
using GTrackID = o2d::GlobalTrackID;
using TBracket = o2::math_utils::Bracketf_t;
class RecoContainer;
 
class MatchCosmics
{
 public:
  static constexpr int Zero = 0;
  static constexpr int MinusOne = -1;
  static constexpr int MinusTen = -10;
  static constexpr int Validated = -2;
  static constexpr int Reject = MinusTen;
  enum RejFlag {
    Accept = 0,
    RejY,
    RejZ,
    RejSnp,
    RejTgl,
    RejQ2Pt,
    RejTime,
    RejProp,
    RejChi2,
    RejOther
  };
 
  using InfoAccessor = o2d::AbstractRefAccessor<int, GTrackID::NSources>; // there is no unique <Info> structure, so the default return type is dummy (int)
 
  struct MatchRecord {
    int id0 = MinusOne;  
    int id1 = MinusOne;  
    float chi2 = -1.f;   
    int next = MinusOne; 
  };
 
  struct TrackSeed : public o2::track::TrackParCov {
    TBracket tBracket;      
    GTrackID origID;        
    int matchID = MinusOne; 
  };
  void setTPCCorrMaps(o2::gpu::CorrectionMapsHelper* maph);
  void setTPCVDrift(const o2::tpc::VDriftCorrFact& v);
  void setITSROFrameLengthMUS(float fums) { mITSROFrameLengthMUS = fums; }
  void setITSDict(const o2::itsmft::TopologyDictionary* dict) { mITSDict = dict; }
  void process(const o2::globaltracking::RecoContainer& data);
  void setUseMC(bool mc) { mUseMC = mc; }
  void init();
  void end();
 
  auto getCosmicTracks() const { return mCosmicTracks; }
  auto getCosmicTracksLbl() const { return mCosmicTracksLbl; }
 
#ifdef _ALLOW_DEBUG_TREES_COSM
  enum DebugFlagTypes : UInt_t {
    MatchTreeAll = 0x1,         
    MatchTreeAccOnly = 0x1 << 1 
  };
  bool isDebugFlag(UInt_t flags) const { return mDBGFlags & flags; }
 
  UInt_t getDebugFlags() const { return mDBGFlags; }
 
  void setDebugFlag(UInt_t flag, bool on = true);
 
  void setDebugTreeFileName(std::string name)
  {
    if (!name.empty()) {
      mDebugTreeFileName = name;
    }
  }
 
  const std::string& getDebugTreeFileName() const { return mDebugTreeFileName; }
#endif
 
 private:
  void updateTimeDependentParams();
  RejFlag checkPair(int i, int j);
  void registerMatch(int i, int j, float chi2);
  void suppressMatch(int partner0, int partner1);
  void createSeeds(const o2::globaltracking::RecoContainer& data);
  bool validateMatch(int partner0);
  void selectWinners();
  void refitWinners(const o2::globaltracking::RecoContainer& data);
  std::vector<o2::BaseCluster<float>> prepareITSClusters(const o2::globaltracking::RecoContainer& data) const;
 
  std::vector<TrackSeed> mSeeds;
  std::vector<MatchRecord> mRecords;
  std::vector<int> mWinners;
  const o2::itsmft::TopologyDictionary* mITSDict = nullptr; // cluster patterns dictionary
  o2::gpu::CorrectionMapsHelper* mTPCCorrMapsHelper = nullptr;
  int mTFCount = 0;
  float mTPCVDriftRef = -1.; 
  float mTPCVDriftCorrFact = 1.; 
  float mTPCVDrift = -1.;    
  float mTPCDriftTimeOffset = 0.; 
  float mTPCTBinMUS = 0.; 
  float mBz = 0;          
  bool mFieldON = true;
  bool mUseMC = true;
  float mITSROFrameLengthMUS = 0.;
  float mQ2PtCutoff = 1e9;
  const MatchCosmicsParams* mMatchParams = nullptr;
 
  std::vector<o2d::TrackCosmics> mCosmicTracks;
  std::vector<o2::MCCompLabel> mCosmicTracksLbl;
 
#ifdef _ALLOW_DEBUG_TREES_COSM
  std::unique_ptr<o2::utils::TreeStreamRedirector> mDBGOut;
  UInt_t mDBGFlags = 0;
  std::string mDebugTreeFileName = "dbg_cosmics_match.root"; 
#endif
 
  ClassDefNV(MatchCosmics, 1);
};
 
} // namespace globaltracking
} // namespace o2
 
#endif