ATLAS Offline Software
Interfaces/PMGAnalysisInterfaces/PMGAnalysisInterfaces/IPMGCrossSectionTool.h
Go to the documentation of this file.
1 // Dear emacs, this is -*- c++ -*-
2 
3 /*
4  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
5 */
6 
7 #ifndef PMGANALYSISINTERFACES_IPMGCROSSSECTIONTOOL_H
8 #define PMGANALYSISINTERFACES_IPMGCROSSSECTIONTOOL_H
9 
10 // Infrastructure include(s):
11 #include "AsgTools/IAsgTool.h"
12 
13 #include <vector>
14 
15 namespace PMGTools {
16 
17  // store all information for certain DSID in structure
18  struct AllSampleInfo{
19  int dsid = 0;
20  std::string containerName;
21  double amiXSec = 0;
22  double filterEff = 0;
23  double kFactor = 0;
24  double XSecUncUP = 0;
25  double XSecUncDOWN = 0;
26  double br = 0;
29  };
30 
31 
32  class IPMGCrossSectionTool : public virtual asg::IAsgTool {
33 
34  // Declare the interface that the class provides
36 
37  public:
38 
40  virtual bool readInfosFromFiles(std::vector<std::string>) = 0;
41 
43  virtual bool readInfosFromDir(const std::string& inputDir) = 0;
44 
46  virtual double getFilterEff(const int dsid) const = 0;
47 
49  virtual std::string getSampleName(const int dsid) const = 0;
50 
52  virtual double getAMIXsection(const int dsid) const = 0;
53 
55  virtual double getXsectionUncertainty(const int dsid) const = 0;
56 
58  virtual double getXsectionUncertaintyUP(const int dsid) const = 0;
59 
61  virtual double getXsectionUncertaintyDOWN(const int dsid) const = 0;
62 
63  // :: below is for future use?
65  //virtual double getBR(const int dsid) const = 0;
66 
68  virtual double getKfactor(const int dsid) const = 0;
69 
71  virtual double getSampleXsection(const int dsid) const = 0;
72 
74  virtual std::vector<int> getLoadedDSIDs() const = 0;
75 
76  }; // class IPMGCrossSectionTool
77 
78 } // namespace PMGTools
79 
80 #endif //> !PMGANALYSISINTERFACES_IPMGCROSSSECTIONTOOL_H
PMGTools::IPMGCrossSectionTool
Definition: AnalysisCommon/PMGTools/PMGTools/IPMGCrossSectionTool.h:28
TestSUSYToolsAlg.inputDir
string inputDir
Definition: TestSUSYToolsAlg.py:76
PMGTools::AllSampleInfo::kFactor
double kFactor
Definition: AnalysisCommon/PMGTools/PMGTools/IPMGCrossSectionTool.h:23
asg::IAsgTool
Base class for the dual-use tool interface classes.
Definition: IAsgTool.h:41
PMGTools::IPMGCrossSectionTool::getSampleXsection
virtual double getSampleXsection(const int dsid) const =0
return the sample cross-section for DSID
PMGTools::AllSampleInfo::br
double br
Definition: Interfaces/PMGAnalysisInterfaces/PMGAnalysisInterfaces/IPMGCrossSectionTool.h:26
PMGTools::IPMGCrossSectionTool::getXsectionUncertainty
virtual double getXsectionUncertainty(const int dsid) const =0
return the cross-section uncertainty for DSID
PMGTools::AllSampleInfo::higherOrderXsecSample
double higherOrderXsecSample
Definition: Interfaces/PMGAnalysisInterfaces/PMGAnalysisInterfaces/IPMGCrossSectionTool.h:28
PMGTools::IPMGCrossSectionTool::getXsectionUncertaintyDOWN
virtual double getXsectionUncertaintyDOWN(const int dsid) const =0
return the cross-section uncertainty for DSID
PMGTools::AllSampleInfo::containerName
std::string containerName
Definition: AnalysisCommon/PMGTools/PMGTools/IPMGCrossSectionTool.h:20
PMGTools::IPMGCrossSectionTool::readInfosFromFiles
virtual bool readInfosFromFiles(std::vector< std::string >)=0
read infos from file, store them in the structure and make a vector that keeps all of them
PMGTools::IPMGCrossSectionTool::getXsectionUncertaintyUP
virtual double getXsectionUncertaintyUP(const int dsid) const =0
return the cross-section uncertainty for DSID
PMGTools::AllSampleInfo::XSecUncUP
double XSecUncUP
Definition: Interfaces/PMGAnalysisInterfaces/PMGAnalysisInterfaces/IPMGCrossSectionTool.h:24
PMGTools::IPMGCrossSectionTool::getLoadedDSIDs
virtual std::vector< int > getLoadedDSIDs() const =0
get a list of the DSID for the loaded samples
PMGTools::AllSampleInfo::XSecUncDOWN
double XSecUncDOWN
Definition: Interfaces/PMGAnalysisInterfaces/PMGAnalysisInterfaces/IPMGCrossSectionTool.h:25
PMGTools::IPMGCrossSectionTool::readInfosFromDir
virtual bool readInfosFromDir(const std::string &inputDir)=0
read infos from all files in dir
Generate_dsid_ranseed.dsid
dsid
Definition: Generate_dsid_ranseed.py:6
PMGTools::IPMGCrossSectionTool::getFilterEff
virtual double getFilterEff(const int dsid) const =0
return filter efficiency for DSID
PMGTools
Tool providing sample cross-sections and k-factors etc.
Definition: AnalysisCommon/PMGTools/PMGTools/IPMGCrossSectionTool.h:15
ASG_TOOL_INTERFACE
#define ASG_TOOL_INTERFACE(CLASSNAME)
Definition: AsgToolMacros.h:40
IAsgTool.h
PMGTools::AllSampleInfo::higherOrderXsecTotal
double higherOrderXsecTotal
Definition: Interfaces/PMGAnalysisInterfaces/PMGAnalysisInterfaces/IPMGCrossSectionTool.h:27
PMGTools::AllSampleInfo::filterEff
double filterEff
Definition: AnalysisCommon/PMGTools/PMGTools/IPMGCrossSectionTool.h:22
PMGTools::AllSampleInfo::dsid
int dsid
Definition: AnalysisCommon/PMGTools/PMGTools/IPMGCrossSectionTool.h:19
PMGTools::IPMGCrossSectionTool::getSampleName
virtual std::string getSampleName(const int dsid) const =0
return the sample name for DSID
PMGTools::IPMGCrossSectionTool::getKfactor
virtual double getKfactor(const int dsid) const =0
return the branching ratio for DSID
PMGTools::AllSampleInfo::amiXSec
double amiXSec
Definition: Interfaces/PMGAnalysisInterfaces/PMGAnalysisInterfaces/IPMGCrossSectionTool.h:21
PMGTools::IPMGCrossSectionTool::getAMIXsection
virtual double getAMIXsection(const int dsid) const =0
return the AMI cross-section for DSID