Major update of the HFE package (comments inside the code

[u/mrichter/AliRoot.git] / PWG3 / hfe / AliHFEpid.h

/**************************************************************************
* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
*                                                                        *
* Author: The ALICE Off-line Project.                                    *
* Contributors are mentioned in the code where appropriate.              *
*                                                                        *
* Permission to use, copy, modify and distribute this software and its   *
* documentation strictly for non-commercial purposes is hereby granted   *
* without fee, provided that the above copyright notice appears in all   *
* copies and that both the copyright notice and this permission notice   *
* appear in the supporting documentation. The authors make no claims     *
* about the suitability of this software for any purpose. It is          *
* provided "as is" without express or implied warranty.                  *
**************************************************************************/
//
// Steering class for electron identification
// Combines detector PID objects
// For more information please check the implementation file
//
#ifndef ALIHFEPID_H
#define ALIHFEPID_H

#ifndef ROOT_TNamed
#include <TNamed.h>
#endif

#ifndef ALIHFEPIDBASE_H
#include "AliHFEpidBase.h"
#endif

#include <climits>

class AliAODpidUtil;
class AliESDpid;
class AliHFEcontainer;
class AliHFEpidBase;
class AliHFEpidQAmanager;
class AliHFEvarManager;
class AliVParticle;
class AliMCParticle;

class TList;

class AliHFEpid : public TNamed{
 public:
    enum{
      kUndefined = UINT_MAX 
    };
    enum EDETtype_t {
      kMCpid = 0,
      kESDpid = 1,
      kITSpid = 2,
      kTPCpid = 3,
      kTRDpid = 4,
      kTOFpid = 5,
      kNdetectorPID = 6
    };
    AliHFEpid();
    AliHFEpid(const Char_t *name);
    AliHFEpid(const AliHFEpid &c);
    AliHFEpid &operator=(const AliHFEpid &c);
    void Copy(TObject &o) const;
    ~AliHFEpid();
    
    Bool_t InitializePID();
    Bool_t IsSelected(AliHFEpidObject *track, AliHFEcontainer *cont = NULL, const Char_t *contname = "trackContainer", AliHFEpidQAmanager *qa = NULL);

    Bool_t HasMCData() const { return TestBit(kHasMCData); };

    void AddDetector(TString detector, UInt_t position);
    void SetESDpid(AliESDpid *pid);
    void SetAODpid(AliAODpidUtil *pid);
    void SetVarManager(AliHFEvarManager *vm) { fVarManager = vm; }
    void SetHasMCData(Bool_t hasMCdata = kTRUE) { SetBit(kHasMCData, hasMCdata); };

    UInt_t GetNumberOfPIDdetectors() const { return fNPIDdetectors; }
    Bool_t HasDetector(EDETtype_t det) const { return IsDetectorOn(det); }
    AliHFEpidBase *GetDetPID(EDETtype_t det) const { return det < kNdetectorPID ? fDetectorPID[det] : NULL; }

    void PrintStatus() const;
    const Char_t *SortedDetectorName(Int_t det) const {
      if(det < kNdetectorPID) return fgkDetectorName[fSortedOrder[det]]; 
      else return fgkDetectorName[kNdetectorPID + 1];
    }    
    //-----Configure PID detectors with predefined stettings------
    void ConfigureTPCasymmetric(Double_t pmin = 0.1, Double_t pmax = 20., Double_t sigmamin = -0.2, Double_t sigmamax = 5.);
    void ConfigureTPCrejectionSimple();
    void ConfigureTPCrejection();
    void ConfigureTPCstrategyParis();
    //------------------------------------------------------------

  protected:
    Bool_t MakePidTpcTof(AliHFEpidObject *track);

  private:
    enum{
      kHasMCData = BIT(14)
    };
    enum{
      kCombinedTPCTRD=0
    };
    enum{
      kTRDSignal = 0,
      kITSSignal = 1
    };

    void AddCommonObject(TObject * const o);
    void ClearCommonObjects();
    //-----Switch on/off detectors in PID sequence------
    void SwitchOnDetector(UInt_t det){ 
      if(det < kNdetectorPID) SETBIT(fEnabledDetectors, det);
    }
    void SwitchOffDetector(UInt_t det){
      if(det < kNdetectorPID) CLRBIT(fEnabledDetectors, det);
    }
    Bool_t IsDetectorOn(UInt_t det) const {
      return det < kNdetectorPID ? TESTBIT(fEnabledDetectors, det): kFALSE;
    }
    //--------------------------------------------------

    static const Char_t *fgkDetectorName[kNdetectorPID + 1]; // PID Detector Names
    AliHFEpidBase *fDetectorPID[kNdetectorPID];     //   Detector PID classes
    UInt_t fDetectorOrder[kNdetectorPID];           //   Position requested by the user
    UInt_t fSortedOrder[kNdetectorPID];             //   Sorted array of detectorIDs
    UInt_t fEnabledDetectors;                       //   Enabled Detectors
    UInt_t fNPIDdetectors;                          //   Number of PID detectors
    AliHFEvarManager *fVarManager;                  //!  HFE Var Manager
    TObjArray *fCommonObjects;                      //   Garbage Collector

  ClassDef(AliHFEpid, 1)      // Steering class for Electron ID
};

#endif