ATLAS Offline Software
TauSmearingTool.cxx
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 // EDM include(s):
8 
9 // Local include(s):
12 
13 #include <algorithm>
14 
15 namespace TauAnalysisTools
16 {
17 
18 TauSmearingTool::TauSmearingTool( const std::string& sName )
19  : asg::AsgMetadataTool( sName )
20  , m_tCommonSmearingTool(sName+"_CommonSmearingTool", this)
21 {
22 }
23 
25 {
26 }
27 
29 {
30  ATH_MSG_INFO( "Initializing TauSmearingTool" );
31 
33  ATH_MSG_WARNING("Truth match check will be skipped. This is ONLY FOR TESTING PURPOSE!");
34 
35  if (m_sInputFilePath.empty()) {
36  std::string sDirectory = "TauAnalysisTools/" + std::string(sSharedFilesVersion) + "/Smearing/";
37 
38  if(m_sRecommendationTag == "2025-prerec") {
39 
40  if (m_sCampaign!="mc23" && m_sCampaign!="mc20"){
41  ATH_MSG_ERROR("unknown campaign (mc20|mc23):" << m_sCampaign);
42  return StatusCode::FAILURE;
43  }
44 
45  if(m_useFastSim) {
46  ATH_MSG_WARNING("No fast-sim recommendation for tau smearing is available, using full sim");
47  }
48 
49  if (m_sCampaign=="mc23") {
50  m_sInputFilePath = sDirectory+"TES_TrueHadTau_RNN_mc23_v1.root";
51  } else {
52  m_sInputFilePath = sDirectory+"TES_TrueHadTau_RNN_mc20_v1.root";
53  }
54 
55  } else if (m_sRecommendationTag == "2022-prerec") {
56 
57  ATH_MSG_WARNING("2022-prerec tag are pre-recommendations superseeded by 2025-prerec");
58 
59  if (m_sCampaign!="mc21" && m_sCampaign!="mc20"){
60  ATH_MSG_ERROR("unknown campaign (mc20|mc21):" << m_sCampaign);
61  return StatusCode::FAILURE;
62  }
63 
64  if (m_sGenerator!="PoPy" && m_sCampaign!="Sherpa"){
65  ATH_MSG_ERROR("unknown generator tag (PoPy|Sherpa):" << m_sCampaign);
66  return StatusCode::FAILURE;
67  }
68 
69  if(m_useFastSim) {
70  ATH_MSG_WARNING("No fast-sim recommendation for tau smearing is available, using full sim");
71  }
72 
73  if (m_sGenerator == "PoPy" && m_sCampaign=="mc20") m_sInputFilePath = sDirectory+"TES_TrueHadTau_PoPy8_mc20-prerec_v2.root";
74  if (m_sCampaign=="mc21") {
75  m_sInputFilePath = sDirectory+"TES_TrueHadTau_PoPy8_mc21-prerec_v2.root";
76  if (m_sGenerator=="Sherpa")ATH_MSG_WARNING("No Sherpa mc21 recommendations available yet, using PoPy8!");
77  }
78  if (m_sGenerator == "Sherpa" && m_sCampaign=="mc20") m_sInputFilePath = sDirectory+"TES_TrueHadTau_Sherpa2211-prerec_v2.root";
79  }
80  else {
81  ATH_MSG_ERROR("unknown recommendation tag " << m_sRecommendationTag);
82  return StatusCode::FAILURE;
83  }
84  }
86  ATH_CHECK(m_tCommonSmearingTool.setProperty("InputFilePath", m_sInputFilePath));
87  ATH_CHECK(m_tCommonSmearingTool.setProperty("SkipTruthMatchCheck", m_bSkipTruthMatchCheck));
88  ATH_CHECK(m_tCommonSmearingTool.setProperty("ApplyFading", m_bApplyFading));
89  ATH_CHECK(m_tCommonSmearingTool.setProperty("MVATESQualityCheck", m_bMVATESQualityCheck));
90  ATH_CHECK(m_tCommonSmearingTool.setProperty("ApplyInsituCorrection", m_bApplyInsituCorrection));
91  ATH_CHECK(m_tCommonSmearingTool.setProperty("OutputLevel", this->msg().level()));
92  ATH_CHECK(m_tCommonSmearingTool.initialize());
93 
94  // Add the affecting systematics to the global registry
96  if (!registry.registerSystematics(*this)) {
97  ATH_MSG_ERROR ("Unable to register the systematics");
98  return StatusCode::FAILURE;
99  }
100 
101  return StatusCode::SUCCESS;
102 }
103 
104 // auto detection of simulation flavour, used to cross check configuration of tool
105 //______________________________________________________________________________
107 {
108  if (inputMetaStore()->contains<xAOD::FileMetaData>("FileMetaData")) {
109  const xAOD::FileMetaData* fmd = nullptr;
110  ATH_CHECK( inputMetaStore()->retrieve( fmd, "FileMetaData" ) );
111  std::string simType("");
112  bool result = fmd->value( xAOD::FileMetaData::simFlavour , simType );
113  // if no result -> no simFlavor metadata, so must be data
114  if(result) std::transform(simType.begin(), simType.end(), simType.begin(), ::toupper);
115 
116  if( simType.find("ATLFAST3") != std::string::npos && !m_useFastSim){
117  ATH_MSG_WARNING("Input file is AF3 sample but you are _not_ using AF3 corrections and uncertainties, you should set \"useFastSim\" to \"true\"");
118  } else if (simType.find("FULLG4")!=std::string::npos && m_useFastSim){
119  ATH_MSG_WARNING("Input file is full simulation but you are using AF3 corrections and uncertainties, you should set \"useFastSim\" to \"false\"");
120  }
121  }
122 
123  return StatusCode::SUCCESS;
124 }
125 
127 {
128  return m_tCommonSmearingTool->applyCorrection(xTau);
129 }
130 
132 {
133  return m_tCommonSmearingTool->correctedCopy(input, output);
134 }
135 
138 {
139  return m_tCommonSmearingTool->isAffectedBySystematic( systematic );
140 }
141 
144 {
145  return m_tCommonSmearingTool->affectingSystematics();
146 }
147 
150 {
151  return m_tCommonSmearingTool->recommendedSystematics();
152 }
153 
155 {
156  return m_tCommonSmearingTool->applySystematicVariation( sSystematicSet );
157 }
158 
159 
160 } // namespace TauAnalysisTools
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
python.Dso.registry
registry
Definition: Control/AthenaServices/python/Dso.py:158
TauAnalysisTools
Definition: TruthCollectionMakerTau.h:16
TauAnalysisTools::TauSmearingTool::~TauSmearingTool
~TauSmearingTool()
Definition: TauSmearingTool.cxx:24
TauAnalysisTools::TauSmearingTool::m_bSkipTruthMatchCheck
Gaudi::Property< bool > m_bSkipTruthMatchCheck
Definition: TauSmearingTool.h:73
get_generator_info.result
result
Definition: get_generator_info.py:21
TauAnalysisTools::TauSmearingTool::correctedCopy
virtual CP::CorrectionCode correctedCopy(const xAOD::TauJet &input, xAOD::TauJet *&output) const
Create a corrected copy from a constant tau.
Definition: TauSmearingTool.cxx:131
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
asg
Definition: DataHandleTestTool.h:28
CP::SystematicSet
Class to wrap a set of SystematicVariations.
Definition: SystematicSet.h:31
asg::AsgMetadataTool::inputMetaStore
MetaStorePtr_t inputMetaStore() const
Accessor for the input metadata store.
Definition: AsgMetadataTool.cxx:93
TauAnalysisTools::CommonSmearingTool
Definition: CommonSmearingTool.h:44
CP::SystematicVariation
Definition: SystematicVariation.h:47
ASG_MAKE_ANA_TOOL
#define ASG_MAKE_ANA_TOOL(handle, type)
create the tool in the given tool handle
Definition: AnaToolHandle.h:690
xAOD::FileMetaData_v1::value
bool value(MetaDataType type, std::string &val) const
Get a pre-defined string value out of the object.
Definition: FileMetaData_v1.cxx:195
xAOD::FileMetaData_v1::simFlavour
@ simFlavour
Fast or Full sim [string].
Definition: FileMetaData_v1.h:76
TauAnalysisTools::TauSmearingTool::m_bMVATESQualityCheck
Gaudi::Property< bool > m_bMVATESQualityCheck
Definition: TauSmearingTool.h:75
TauAnalysisTools::TauSmearingTool::affectingSystematics
virtual CP::SystematicSet affectingSystematics() const
returns: the list of all systematics this tool can be affected by
Definition: TauSmearingTool.cxx:143
TauAnalysisTools::TauSmearingTool::applyCorrection
virtual CP::CorrectionCode applyCorrection(xAOD::TauJet &xTau) const
Apply the correction on a modifyable object.
Definition: TauSmearingTool.cxx:126
SharedFilesVersion.h
TauAnalysisTools::TauSmearingTool::m_sRecommendationTag
Gaudi::Property< std::string > m_sRecommendationTag
Definition: TauSmearingTool.h:70
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
TauAnalysisTools::TauSmearingTool::m_tCommonSmearingTool
asg::AnaToolHandle< ITauSmearingTool > m_tCommonSmearingTool
Definition: TauSmearingTool.h:67
SystematicRegistry.h
TauSmearingTool.h
TauAnalysisTools::TauSmearingTool::recommendedSystematics
virtual CP::SystematicSet recommendedSystematics() const
returns: the list of all systematics this tool recommends to use
Definition: TauSmearingTool.cxx:149
TauAnalysisTools::TauSmearingTool::m_bApplyFading
Gaudi::Property< bool > m_bApplyFading
Definition: TauSmearingTool.h:74
TauAnalysisTools::TauSmearingTool::m_bApplyInsituCorrection
Gaudi::Property< bool > m_bApplyInsituCorrection
Definition: TauSmearingTool.h:76
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
TauAnalysisTools::TauSmearingTool::applySystematicVariation
virtual StatusCode applySystematicVariation(const CP::SystematicSet &systConfig)
effects: configure this tool for the given list of systematic variations.
Definition: TauSmearingTool.cxx:154
xAOD::TauJet_v3
Class describing a tau jet.
Definition: TauJet_v3.h:41
Amg::transform
Amg::Vector3D transform(Amg::Vector3D &v, Amg::Transform3D &tr)
Transform a point from a Trasformation3D.
Definition: GeoPrimitivesHelpers.h:156
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
xAOD::FileMetaData_v1
Class holding file-level metadata about an xAOD file.
Definition: FileMetaData_v1.h:34
TauAnalysisTools::TauSmearingTool::TauSmearingTool
TauSmearingTool(const std::string &sName)
Create a proper constructor for Athena.
Definition: TauSmearingTool.cxx:18
TauAnalysisTools::TauSmearingTool::m_sInputFilePath
Gaudi::Property< std::string > m_sInputFilePath
Definition: TauSmearingTool.h:69
TauAnalysisTools::TauSmearingTool::isAffectedBySystematic
virtual bool isAffectedBySystematic(const CP::SystematicVariation &systematic) const
returns: whether this tool is affected by the given systematis
Definition: TauSmearingTool.cxx:137
TauAnalysisTools::TauSmearingTool::m_sCampaign
Gaudi::Property< std::string > m_sCampaign
Definition: TauSmearingTool.h:71
TauAnalysisTools::TauSmearingTool::beginInputFile
virtual StatusCode beginInputFile()
Function called when a new input file is opened.
Definition: TauSmearingTool.cxx:106
FileMetaData.h
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
CP::SystematicRegistry
This module implements the central registry for handling systematic uncertainties with CP tools.
Definition: SystematicRegistry.h:25
TauAnalysisTools::TauSmearingTool::m_sGenerator
Gaudi::Property< std::string > m_sGenerator
Definition: TauSmearingTool.h:72
CP::CorrectionCode
Return value from object correction CP tools.
Definition: CorrectionCode.h:31
TauAnalysisTools::TauSmearingTool::m_useFastSim
Gaudi::Property< bool > m_useFastSim
Definition: TauSmearingTool.h:77
TauAnalysisTools::TauSmearingTool::initialize
virtual StatusCode initialize()
Function initialising the tool.
Definition: TauSmearingTool.cxx:28
CP::SystematicRegistry::getInstance
static SystematicRegistry & getInstance()
Get the singleton instance of the registry for the curren thread.
Definition: SystematicRegistry.cxx:25