AliAnalysisTaskEmcalClustersRef.h

Go to the documentation of this file.

/************************************************************************************
 * Copyright (C) 2017, Copyright Holders of the ALICE Collaboration                 *
 * All rights reserved.                                                             *
 *                                                                                  *
 * Redistribution and use in source and binary forms, with or without               *
 * modification, are permitted provided that the following conditions are met:      *
 *     * Redistributions of source code must retain the above copyright             *
 *       notice, this list of conditions and the following disclaimer.              *
 *     * Redistributions in binary form must reproduce the above copyright          *
 *       notice, this list of conditions and the following disclaimer in the        *
 *       documentation and/or other materials provided with the distribution.       *
 *     * Neither the name of the <organization> nor the                             *
 *       names of its contributors may be used to endorse or promote products       *
 *       derived from this software without specific prior written permission.      *
 *                                                                                  *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND  *
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED    *
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE           *
 * DISCLAIMED. IN NO EVENT SHALL ALICE COLLABORATION BE LIABLE FOR ANY              *
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES       *
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;     *
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND      *
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS    *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                     *
 ************************************************************************************/
#ifndef ALIANALYSISTASKEMCALCLUSTERSREF_H
#define ALIANALYSISTASKEMCALCLUSTERSREF_H

#include "AliAnalysisTaskEmcalTriggerBase.h"
#include "AliCutValueRange.h"
#include <TCustomBinning.h>
#include <TString.h>
#include <vector>

class TClonesArray;

namespace EMCalTriggerPtAnalysis {

class AliAnalysisTaskEmcalClustersRef : public AliAnalysisTaskEmcalTriggerBase {
public:

  enum EnergyDefinition_t {
    kDefaultEnergy,       
    kNonLinCorrEnergy,    
    kHadCorrEnergy        
  };

  enum TriggerCluster_t {
    kTrgClusterANY,
    kTrgClusterCENT,
    kTrgClusterCENTNOTRD,
    kTrgClusterCENTBOTH,
    kTrgClusterOnlyCENT,
    kTrgClusterOnlyCENTNOTRD,
    kTrgClusterCALO,
    kTrgClusterCALOFAST,
    kTrgClusterCALOBOTH,
    kTrgClusterOnlyCALO,
    kTrgClusterOnlyCALOFAST,
    kTrgClusterN
  };

  AliAnalysisTaskEmcalClustersRef();

  AliAnalysisTaskEmcalClustersRef(const char *name);

  virtual ~AliAnalysisTaskEmcalClustersRef();

  void EnableSumw2(Bool_t doEnable) { fEnableSumw2 = doEnable; }

  void SetEnergyDefinition(EnergyDefinition_t edef) { fEnergyDefinition = edef; }

  void SetClusterTimeRange(double mintime, double maxtime) { fClusterTimeRange.SetLimits(mintime, maxtime); }

  void SetCentralityRange(double min, double max) { fCentralityRange.SetLimits(min, max); fRequestCentrality = true; }

  void SetUserCentralityEstimator(TString centest) { fCentralityEstimator = centest; }

  void SetBunchCrossingIndex(Int_t bunchCrossingIndex) { fBunchCrossingIndex = bunchCrossingIndex; };

  void SetFillMultiplicityHistograms(Bool_t doFill) { fDoFillMultiplicityHistograms = doFill; }

  void SetUsedFiredClusters(Bool_t doUse) { fUseFiredTriggers = doUse; }

  void SetUseExclusiveTriggers(Bool_t doUse) { fUseExclusiveTriggers = doUse; }

  void AddRequiredTriggerOverlap(const char *trigger);

  void AddExcludedTriggerOverlap(const char *trigger);

  static AliAnalysisTaskEmcalClustersRef *AddTaskEmcalClustersRef(const TString &nClusters = "usedefault", const TString &suffix = "");

  static AliAnalysisTaskEmcalClustersRef *AddTaskEmcalClustersRefDefault(const TString &nClusters = "usedefault");

protected:

  virtual void CreateUserObjects() {}

  virtual void CreateUserHistos();

  virtual bool IsUserEventSelected();

  virtual bool Run();

  virtual void UserFillHistosAfterEventSelection();

  void GetPatchBoundaries(AliEMCALTriggerPatchInfo &o, Double_t *boundaries) const;

  void FillClusterHistograms(const TString &triggerclass, double energy, double transversenergy, double eta, double phi, double clustertime, int ncell, int trgcluster, const TList *triggerpatches, int energycomp);

  std::vector<AliEMCALTriggerPatchInfo *> CorrelateToTrigger(Double_t etaclust, Double_t phiclust, const TList &triggerpatches) const;


  AliCutValueRange<double>            fCentralityRange;           
  Bool_t                              fRequestCentrality;         
  Double_t                            fEventCentrality;           
  TString                             fCentralityEstimator;       
  Char_t                              fBunchCrossingIndex;        

  EnergyDefinition_t                  fEnergyDefinition;          
  Bool_t                              fEnableSumw2;               
  Bool_t                              fDoFillMultiplicityHistograms;    
  Bool_t                              fUseFiredTriggers;          
  Bool_t                              fUseExclusiveTriggers;      
  AliCutValueRange<double>            fClusterTimeRange;          
  std::vector<TriggerCluster_t>       fTriggerClusters;           
  TObjArray                           fRequiredOverlaps;          
  TObjArray                           fExcludedOverlaps;          

private:

  class EnergyBinning : public TCustomBinning {
  public:
    EnergyBinning();
    virtual ~EnergyBinning() {}
  };

  int CountTracklets(double etamin, double etamax, double phimin, double phimax);
  int CountEmcalClusters(double ecut);
  int GetEMCALCellOccupancy(double ecut);

  AliAnalysisTaskEmcalClustersRef(const AliAnalysisTaskEmcalClustersRef &);
  AliAnalysisTaskEmcalClustersRef &operator=(const AliAnalysisTaskEmcalClustersRef &);

  ClassDef(AliAnalysisTaskEmcalClustersRef, 1);
};

} /* namespace EMCalTriggerPtAnalysis */

#endif /* ALIANALYSISTASKEMCALCLUSTERSREF_H */