AliPhysics  5eaf189 (5eaf189)
AliAnalysisTaskEmcalEmbeddingHelper.h
Go to the documentation of this file.
1 #ifndef ALIANALYSISTASKEMCALEMBEDDINGHELPER_H
2 #define ALIANALYSISTASKEMCALEMBEDDINGHELPER_H
3 
16 /* Copyright(c) 1998-2016, ALICE Experiment at CERN, All rights reserved. *
17  * See cxx source for full Copyright notice */
18 
19 class TString;
20 class TChain;
21 class TFile;
22 class AliVEvent;
23 class AliVHeader;
24 class AliGenPythiaEventHeader;
25 class AliEmcalList;
26 
27 #include <iosfwd>
28 #include <vector>
29 #include <string>
30 
31 #include <TStopwatch.h>
32 #include <AliAnalysisTaskSE.h>
33 #include "AliEventCuts.h"
34 #include "AliYAMLConfiguration.h"
35 #include "THistManager.h"
36 
71  public:
72 
74  AliAnalysisTaskEmcalEmbeddingHelper(const char *name) ;
76 
81  void UserExec(Option_t *option) ;
83  void Terminate(Option_t *option) ;
84  /* @} */
85 
87 
92  AliVEvent* GetExternalEvent() const { return fExternalEvent ; }
93 
105  bool Initialize(bool removeDummyTask = false);
106 
107  // Get
108  Int_t GetPtHardBin() const { return fPtHardBin; }
109  Int_t GetNPtHardBins() const { return fNPtHardBins; }
110  TString GetTreeName() const { return fTreeName; }
113  TString GetFilePattern() const { return fFilePattern; }
117  bool GetCreateHistos() const { return fCreateHisto; }
118 
119  // Set
121  void SetPtHardBin(Int_t n) { fPtHardBin = n; }
125  void SetESD(const char * treeName = "esdTree") { fTreeName = treeName; }
127  void SetAOD(const char * treeName = "aodTree") { fTreeName = treeName; }
138  void SetFilePattern(const char * pattern) { fFilePattern = pattern; }
149  void SetCreateHistos(bool b) { fCreateHisto = b; }
151  void SetConfigurationPath(const char * path) { fConfigurationPath = path; }
152  /* @} */
153 
171  bool EmbeddedEventUsed() const { return fEmbeddedEventUsed; }
179  const AliEventCuts * GetInternalEventCuts() const { return (fUseInternalEventSelection ? &fInternalEventCuts : nullptr); }
182  AliEventCuts * GetInternalEventCuts();
184  void SetCentralityRange(double min, double max) { fCentMin = min; fCentMax = max; }
185  /* @} */
186 
191  UInt_t GetTriggerMask() const { return fTriggerMask; }
192  bool GetMCRejectOutliers() const { return fMCRejectOutliers; }
194  Double_t GetZVertexCut() const { return fZVertexCut; }
196 
197  void SetTriggerMask(UInt_t triggerMask) { fTriggerMask = triggerMask; }
200  void SetZVertexCut(Double_t zVertex) { fZVertexCut = zVertex; }
201  void SetMaxVertexDistance(Double_t distance) { fMaxVertexDist = distance; }
202  /* @} */
203 
208  AliVHeader * GetEventHeader() const { return fExternalHeader; }
209  AliGenPythiaEventHeader * GetPythiaHeader() const { return fPythiaHeader; }
210  double GetPythiaXSection() const { return fPythiaCrossSection; }
211  int GetPythiaTrials() const { return fPythiaTrials; }
212  double GetPythiaPtHard() const { return fPythiaPtHard; }
213  /* @} */
214 
221  std::string GetAutoConfigureBasePath() const { return fAutoConfigureBasePath; }
223  std::string GetAutoConfigureIdentifier() const { return fAutoConfigureIdentifier; }
224 
225  void SetAutoConfigurePtHardBins(bool configure = true) { fAutoConfigurePtHardBins = configure; }
226  void SetAutoConfigureBasePath(std::string path) { fAutoConfigureBasePath = path; }
228  void SetAutoConfigureIdentifier(std::string path) { fAutoConfigureIdentifier = path; }
229  /* @} */
230 
254 
255  // Printing
256  friend std::ostream & operator<<(std::ostream &in, const AliAnalysisTaskEmcalEmbeddingHelper &myTask);
257  void Print(Option_t* opt = "") const;
258  std::ostream & Print(std::ostream &in) const;
259  std::string toString(bool includeFileList = false) const;
260  /* @} */
261 
277  AliVEvent* InputEvent() const { return GetExternalEvent(); }
278  /* @} */
279 
280  protected:
282  bool GetFilenames() ;
284  bool IsRunInRunlist(const std::string & path) const;
285  bool InitializeYamlConfig();
287  std::string GenerateUniqueFileListFilename() const;
288  std::string RemoveTrailingSlashes(std::string filename) const;
290  void SetupEmbedding() ;
292  std::string ConstructFullPythiaXSecFilename(std::string inputFilename, const std::string & pythiaFilename, bool testIfExists) const;
293  Bool_t GetNextEntry() ;
298  Bool_t InitEvent() ;
299  void InitTree() ;
300  bool PythiaInfoFromCrossSectionFile(std::string filename);
301  // Helper functions
302  bool IsFileAccessible() const;
303  void ConnectToAliEn() const;
304  // LEGO Train utility
305  void RemoveDummyTask() const;
306 
312 
317 
323  bool fCreateHisto ;
325 
328  AliEventCuts fInternalEventCuts;
330  double fCentMin ;
331  double fCentMax ;
332 
337 
342  std::vector <std::string> fFilenames ;
343  std::string fConfigurationPath;
344  std::vector <std::string> fEmbeddedRunlist ;
345  std::string fPythiaXSecFilename;
346  std::vector <std::string> fPythiaCrossSectionFilenames;
347  TFile *fExternalFile ;
357  AliVEvent *fExternalEvent ;
358  AliVHeader *fExternalHeader ;
359  AliGenPythiaEventHeader *fPythiaHeader ;
360 
365  double fPythiaPtHard ;
366 
369 
371 
372  private:
375 
379 };
380 #endif
Bool_t fRandomEventNumberAccess
If true, it will start embedding from a random entry in the file rather than from the first...
Double_t fZVertexCut
Z vertex cut on embedded event.
const char * filename
Definition: TestFCM.C:1
void SetPrintTimingInfoToLog(bool b)
Set whether to print and plot execution time of InitTree()
void SetESD(const char *treeName="esdTree")
Set to embed from ESD.
double Double_t
Definition: External.C:58
Int_t fPtHardBin
ptHard bin for the given pythia production
bool fMCRejectOutliers
If true, MC outliers will be rejected.
double fPythiaCrossSection
! Pythia cross section for the current event (extracted from the pythia header).
Int_t fLowerEntry
! First entry of the current tree to be used for embedding
TString fFileListFilename
Name of the file list containing paths to files to embed.
int fPythiaTrialsFromFile
! Average number of trials extracted from a xsec file.
Bool_t fRandomFileAccess
If true, it will start embedding from a random file in the input files list.
TStopwatch fTimer
! Timer for the InitTree() function
Int_t fCurrentEntry
! Current entry in the current tree
TFile * fExternalFile
! External file used for embedding
Int_t fNPtHardBins
Total number of pt hard bins.
TChain * fChain
! External TChain (tree) containing the events available for embedding
void SetConfigurationPath(const char *path)
Set path to YAML configuration file.
bool fAutoConfigurePtHardBins
If true, attempt to auto configure pt hard bins. Only works on the LEGO train.
bool fInitializedConfiguration
Notes if the configuration has been initialized.
bool IsRunInRunlist(const std::string &path) const
AliVEvent * GetExternalEvent() const
Retrieve the embedded event from the embedding helper.
AliVHeader * fExternalHeader
! Header of the current external event
void SetFilePattern(const char *pattern)
Sets the file pattern to select AliEn files. This pattern is used as input to the alien_find command...
AliGenPythiaEventHeader * fPythiaHeader
! Pythia header of the current external event
void SetCentralityRange(double min, double max)
Set internal event centrality selection.
const AliEventCuts * GetInternalEventCuts() const
Event cuts object for accessing centrality, etc from another task if so inclined. ...
TString fInputFilename
Filename of input root files.
friend std::ostream & operator<<(std::ostream &in, const AliAnalysisTaskEmcalEmbeddingHelper &myTask)
std::vector< std::string > fEmbeddedRunlist
Good runlist for files to embed.
std::string fAutoConfigureBasePath
The base path to the auto configuration (for example, "/alice/cern.ch/user/a/alitrain/") ...
std::string fConfigurationPath
Path to YAML configuration.
int Int_t
Definition: External.C:63
std::string fPythiaXSecFilename
Name of the pythia x sec filename (either "pyxsec.root" or "pyxsec_hists.root")
unsigned int UInt_t
Definition: External.C:33
bool fInitializedEmbedding
! Notes where the TChain has been initialized for embedding
bool fUseInternalEventSelection
If true, apply internal event selection though AliEventCuts.
std::string toString(bool includeFileList=false) const
bool GetUseManualInternalEventSelection() const
Whether to use manual cuts for AliEventCuts.
Implementation of task to embed external events.
UInt_t fMaxNumberOfFiles
! Max number of files that are in the TChain
Double_t fMaxVertexDist
Max distance between Z vertex of internal and embedded event.
AliVEvent * fExternalEvent
! Current external event available for embedding
std::vector< std::string > fPythiaCrossSectionFilenames
Paths to the pythia xsection files.
void SetRandomFileAccess(Bool_t b)
Randomly select the first file to embed from the file list. Continues sequentially afterwards...
bool fPrintTimingInfoToLog
Flag to print time to execute InitTree(), for logging purposes.
TString fTreeName
Name of the ESD/AOD tree where the events are to be found.
void SetNPtHardBins(Int_t n)
Set the number of pt hard bins in the production to properly format the histograms.
Int_t fOffset
! Offset from fLowerEntry where the loop over the tree should start
bool fCreateHisto
If true, create QA histograms.
bool fEmbeddedEventUsed
! If true, the internal event was selected, so the embedded event is used. Defaults to true so other ...
Enhanced TList-derived class that implements correct merging for pt_hard binned production.
Definition: AliEmcalList.h:25
bool fWrappedAroundTree
! Notes whether we have wrapped around the tree, which is important if the offset into the tree is no...
Double_t fPtHardJetPtRejectionFactor
Factor which the pt hard bin is multiplied by to compare against pythia header jets pt...
PWG::Tools::AliYAMLConfiguration fYAMLConfig
Hanldes configuration from YAML.
double fPythiaPtHard
! Pt hard of the current event (extracted from the pythia header).
void SetFileListFilename(const char *filename)
Set the path to a file containing the list of files to embed.
AliGenPythiaEventHeader * GetPythiaHeader() const
static AliAnalysisTaskEmcalEmbeddingHelper * AddTaskEmcalEmbeddingHelper()
void SetPtHardBin(Int_t n)
Set the pt hard bin which will be added into the file pattern. Can also be omitted and set directly i...
THistManager fHistManager
Manages access to all histograms.
bool fInitializedNewFile
! Notes where the entry indices have been initialized for a new tree in the chain ...
static AliAnalysisTaskEmcalEmbeddingHelper * fgInstance
! Global instance of this class
UInt_t fFileNumber
! File number corresponding to the current tree
bool fUseManualInternalEventCuts
If true, manual event cuts mode will be used for AliEventCuts.
YAML configuration class for AliPhysics.
bool GetUseInternalEventSelection() const
Whether internal event selection is enabled.
Container class for histograms.
Definition: THistManager.h:99
std::string RemoveTrailingSlashes(std::string filename) const
AliAnalysisTaskEmcalEmbeddingHelper & operator=(const AliAnalysisTaskEmcalEmbeddingHelper &)
void SetCreateHistos(bool b)
Create QA histograms. These are necessary for proper scaling, so be careful disabling them! ...
double fCentMax
Maximum centrality for internal event selection.
const char Option_t
Definition: External.C:48
AliEmcalList * fOutput
! List which owns the output histograms to be saved
AliEventCuts fInternalEventCuts
If enabled, Handles internal event selection.
bool Bool_t
Definition: External.C:53
std::string fAutoConfigureIdentifier
How the auto configuration YAML file should be identified. (for example, "rehlersTrain") ...
void SetStartingFileIndex(Int_t n)
Select the file ID to start embedding from.
void SetAOD(const char *treeName="aodTree")
Set to embed from AOD.
void SetUseInternalEventSelection(bool b=true)
Enable internal event selection. Can also be enabled through the YAML configuration.
Int_t fUpperEntry
! Last entry of the current tree to be used for embedding
Int_t fFilenameIndex
Index of vector containing paths to files to embed.
double fPythiaCrossSectionFromFile
! Average pythia cross section extracted from a xsec file.
std::vector< std::string > fFilenames
Paths to the files to embed.
static AliAnalysisTaskEmcalEmbeddingHelper * ConfigureEmcalEmbeddingHelperOnLEGOTrain()
std::string fAutoConfigureTrainTypePath
The path associated with the train type (for example, "PWGJE/Jets_EMC_PbPb/")
TString fFilePattern
File pattern to select AliEn files using alien_find.
AliVEvent * InputEvent() const
SHOULD NOT BE USED! Use GetExternalEvent()! SHOULD NOT BE USED! Use GetExternalEvent()! Returns the e...
int fPythiaTrials
! Number of pythia trials for the current event (extracted from the pythia header).
double fCentMin
Minimum centrality for internal event selection.
Bool_t reject
static const AliAnalysisTaskEmcalEmbeddingHelper * GetInstance()
std::string ConstructFullPythiaXSecFilename(std::string inputFilename, const std::string &pythiaFilename, bool testIfExists) const