PndPidCorrelator.h

Go to the documentation of this file.

//****************************************************************************
//*                   This file is part of PandaRoot.                        *
//*                                                                          *
//*            PandaRoot is distributed under the terms of the               *
//*              GNU General Public License (GPL) version 3,                 *
//*                 copied verbatim in the file "LICENSE".                   *
//*                                                                          *
//*  Copyright (C) 2006 - 2024 FAIR GmbH and copyright holders of PandaRoot  *
//*     The copyright holders are listed in the file "COPYRIGHTHOLDERS".     *
//*               The authors are listed in the file "AUTHORS".              *
//****************************************************************************

#ifndef PID_CORRELATOR_H
#define PID_CORRELATOR_H

// **************************************************************************
//  Author: Stefano Spataro e-mail: spataro@to.infn.it
//
//  pid correlator
//
// Created: 03-07-09
// Modified: 2020/21 by Sarah Gaiser (gaiser@hiskp.uni-bonn.de)
//
// **************************************************************************

#include "TString.h"
#include "TClonesArray.h"

#include "FairLogger.h"
#include "FairTask.h"
#include "FairRootManager.h"
#include "FairGeane.h"
#include "PndPropagator.h"

#include "PndTrack.h"
#include "PndPidCorrPar.h"
#include "PndPidCandidate.h"
#include "PndPidDetectorInfo.h"
#include "PndPidCalorimeterInfo.h"
#include "PndPidTrackInfo.h"
#include "PndPidTrackingSystemInfo.h"

class TGeant3;

class PndPidCorrelator : public FairTask {
 public:
  virtual void Exec(Option_t *option);
  virtual InitStatus Init();

  void Register();
  void Reset();

  PndPidCorrelator(const char *name, const char *title = "Pnd Task",
                   Bool_t use_default_setup = kTRUE);                 
  PndPidCorrelator(Bool_t use_default_setup = kTRUE);                 
  virtual ~PndPidCorrelator();                                        

  void SetOption(Option_t *option = " ")
  {
    fOption = option;
    fOption.ToLower();
  }
  void SetDebugMode(Bool_t debug) { fDebugMode = debug; };
  void SetDebugFilename(TString filename) { fDebugFile = filename; };
  void SetMdtRefit(Bool_t mdt) { fMdtRefit = mdt; };
  void SetTrackBranch(TString branch) { fTrackBranch = branch; };
  void SetOutputBranch(TString branch) { fTrackOutBranch = branch; };

  void SetIdeal(Bool_t id) { fIdeal = id; };
  void SetFast(Bool_t fast) { fFast = fast; };
  void SetCorrErrProp(Bool_t err) { fCorrErrorProp = err; };
  void SetPidHyp(Int_t pid) { fPidHyp = pid; };
  void SetIdealHyp(Bool_t opt = kTRUE) { fIdealHyp = opt; }
  void SetFlagCut(Bool_t opt = kTRUE) { fFlagCut = opt; };
  void SetBackPropagate(Bool_t opt = kTRUE) { fBackPropagate = opt; };

  void SetUsePropagator(Bool_t use_propagator = kTRUE) { fUsePropagator = use_propagator; };
  
  void SetPropagator(PndPropagator* propagator = nullptr);

  void SetCalorimeterInfo(PndPidCalorimeterInfo *detector_info);
  void SetBarrelDetectors(std::vector<PndPidDetectorInfo *> barrel_detectors);
  void AddBarrelDetector(PndPidDetectorInfo *detector_info);
  void SetForwardDetectors(std::vector<PndPidDetectorInfo *> forward_detectors);
  void AddForwardDetector(PndPidDetectorInfo *detector_info);
  void SetTrackingSystemInfo(PndPidTrackingSystemInfo *tracking_info);
  void SetTrackingDetectors(std::vector<PndPidTrackingDetectorInfo *> tracking_detectors);
  void AddTrackingDetector(PndPidTrackingDetectorInfo *detector_info);

  virtual void SetParContainers();
  virtual void Finish();

 protected:
  TClonesArray *fPidChargedCand = nullptr;       
  TClonesArray *fPidNeutralCand = nullptr;       

  std::map <Int_t, PndPidCandidate *> fCandidateBuffer;

  PndPidCorrPar *fCorrPar = new PndPidCorrPar(); 
  FairRootManager *fManager = FairRootManager::Instance();

  TString fTrackBranch = "";                     
  TString fTrackOutBranch = "";                  

  Int_t fPidHyp = 0;                             
  Bool_t fIdeal = kFALSE;                        
  Bool_t fIdealHyp = kFALSE;                     
  Bool_t fDoNeutralCand = kFALSE;                
  Bool_t fFast = kFALSE;                         
  Bool_t fFlagCut = kFALSE;                      
  Bool_t fMdtRefit = kFALSE;                     
  Bool_t fCorrErrorProp = kTRUE;                 

  Bool_t fDebugMode = kFALSE;                    
  TString fDebugDir = "";                        
  TString fDebugFile = "";                       
  TFile *fFileDebugNtuples = nullptr;           

  Bool_t fUsePropagator = kTRUE;                 
  Bool_t fBackPropagate = kTRUE;                 
  PndPropagator *fPropagator = nullptr;           

  PndPidDetectorParams::DetectorParams fDetectorParams;
  Int_t fEventCounter;                           
  static Bool_t fHasPrimary;

  Bool_t fUseDefaultDetectorSetup;                          
  PndPidTrackingSystemInfo *fTrackingSystemInfo = nullptr;              
  PndPidCalorimeterInfo *fCalorimeterInfo = nullptr;        

  std::vector<PndPidDetectorInfo *> fBarrelDetectors = {};  
  std::vector<PndPidDetectorInfo *> fForwardDetectors = {}; 

  // -------

  void DefaultDetectorSetup();
  void SetupDetectorParams();
  void ActivateNeutrals();

  void ConstructChargedCandidates();

  std::vector<PndPidDetectorInfo *> GetDetectors(const PndTrack::TrackType type);

  Bool_t CheckTrackProperties(PndTrack *track, const FairTrackParP &par);

  PndPidCandidate *AddChargedCandidate(PndPidCandidate *cand);

  Int_t FindPidHyp(Int_t pid_hyp);
  Int_t FindIdealPidHyp(const std::vector<FairLink> *mcTrackLinks);

  friend class PidCorrelatorHelper; 

  ClassDef(PndPidCorrelator, 4);
};

#endif