TauCombinedTES Class Reference

#include <TauCombinedTES.h>

Inheritance diagram for TauCombinedTES:

Collaboration diagram for TauCombinedTES:

Public Member Functions
	TauCombinedTES (const std::string &name="TauCombinedTES")
virtual StatusCode	initialize () override
	Tool initializer.
virtual StatusCode	executeTool (xAOD::TauJet &xTau, const EventContext &ctx) const override
	Execute - called for each tau candidate.
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, CaloConstCellContainer &, boost::dynamic_bitset<> &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, const xAOD::VertexContainer *) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::VertexContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::TauTrackContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::CaloClusterContainer &, xAOD::PFOContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::PFOContainer &, xAOD::PFOContainer &, const xAOD::CaloClusterContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::PFOContainer &, xAOD::PFOContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::PFOContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::ParticleContainer &, xAOD::PFOContainer &) const override
virtual StatusCode	eventInitialize () override
	Event initializer - called at the beginning of each event.
virtual StatusCode	eventFinalize () override
	Event finalizer - called at the end of each event.
virtual StatusCode	finalize () override
	Finalizer.
std::string	find_file (const std::string &fname) const
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
bool	inTrigger () const
bool	inAOD () const
bool	inEleRM () const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
Gaudi::Property< bool >	m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}
Gaudi::Property< bool >	m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}
Gaudi::Property< bool >	m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}
Gaudi::Property< std::string >	m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}

Private Types
enum	Binning { DecayModeBinning = 5 , EtaBinning = 5 }
	Binning in the calibraction graph/hist. More...
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
TLorentzVector	getCombinedP4 (const xAOD::TauJet &tau) const
	Get the weighted four momentum of calo TES and PanTau.
bool	isValid (const xAOD::TauJet &tau) const
	Whether the tau candidate is valid for the calculation.
int	getEtaIndex (float eta) const
	Get the index of eta in the calibration histogram.
xAOD::TauJetParameters::DecayMode	getDecayMode (const xAOD::TauJet &tau) const
	Get the decay mode of the tau candidate.
int	getDecayModeIndex (xAOD::TauJetParameters::DecayMode decayMode) const
	Get the index of decay mode in the calibration histogram.
double	getCorrelation (int decayModeIndex, int etaIndex) const
	Get correlation coefficient between the calo TES and PanTau.
double	getCaloResolution (double et, int decayModeIndex, int etaIndex) const
	Get the resolution of Et at the calo TES.
double	getPanTauResolution (double et, int decayModeIndex, int etaIndex) const
	Get the resolution of Et at PanTau.
double	getCaloCalEt (double et, int decayModeIndex, int etaIndex) const
	Get the Et at the calo TES after calibration correction.
double	getPanTauCalEt (double panTauEt, int decayModeIndex, int etaIndex) const
	Get the Et at PanTau after calibration correction.
double	getWeight (double caloSigma, double panTauSigma, double correlatioon) const
	Get the weight of calo TES.
double	getCompatibilitySigma (double caloSigma, double panTauSigma, double correlation) const
	Get the compatibility sigma of calo TES and PanTau.
double	getCombinedEt (double caloEt, double et_substructure, xAOD::TauJetParameters::DecayMode decayMode, float eta) const
	Get the combined Et of calo TES and PanTau.
double	getNsigmaCompatibility (double caloEt, int decayModeIndex) const
	Get the allowed difference between calo TES and PanTau.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::string >	m_calFileName {this, "WeightFileName", ""}
const std::array< std::string, DecayModeBinning >	m_decayModeNames = {"1p0n","1p1n","1pXn","3p0n","3pXn"}
	Decay mode binning in the calibration graph/hist.
const std::array< std::string, EtaBinning >	m_etaBinNames = {"0", "1", "2", "3", "4"}
	Eta binning in the calibration graph.
std::array< std::array< std::unique_ptr< TGraph >, EtaBinning >, DecayModeBinning >	m_caloRelBias
	Calibration graph: mean of bias/caloEt as a function of caloEt.
std::array< std::array< double, EtaBinning >, DecayModeBinning >	m_caloRelBiasMaxEt
	Maximum Et of m_caloRelBias.
std::array< std::array< std::unique_ptr< TGraph >, EtaBinning >, DecayModeBinning >	m_caloRes
	Calibration graph: resolution at Calo TES as a function of caloEt.
std::array< std::array< double, EtaBinning >, DecayModeBinning >	m_caloResMaxEt
	Maximum Et of m_caloRes.
std::array< std::array< std::unique_ptr< TGraph >, EtaBinning >, DecayModeBinning >	m_panTauRelBias
	Calibration graph: mean of bias/panTauEt as a funtion of panTauEt.
std::array< std::array< double, EtaBinning >, DecayModeBinning >	m_panTauRelBiasMaxEt
	Maximum Et of m_panTauRelBias.
std::array< std::array< std::unique_ptr< TGraph >, EtaBinning >, DecayModeBinning >	m_panTauRes
	Calibration graph: resolution at PanTau as a function of panTauEt.
std::array< std::array< double, EtaBinning >, DecayModeBinning >	m_panTauResMaxEt
	Maximum Et of m_panTauRes.
std::array< std::unique_ptr< TH1F >, DecayModeBinning >	m_correlationHists
	Calibration histogram: correlation coefficient of calo TES and PanTau.
std::array< std::unique_ptr< TF1 >, DecayModeBinning >	m_nSigmaCompatibility
	Maximum tolerence in unit of combined sigma, as a function of calo Et.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 21 of file TauCombinedTES.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Member Enumeration Documentation

Binning

enum TauCombinedTES::Binning

private

Binning in the calibraction graph/hist.

Enumerator
DecayModeBinning
EtaBinning

Definition at line 81 of file TauCombinedTES.h.

{DecayModeBinning = 5, EtaBinning = 5};

Constructor & Destructor Documentation

TauCombinedTES()

TauCombinedTES::TauCombinedTES

(

const std::string &

name = "TauCombinedTES"

)

Definition at line 13 of file TauCombinedTES.cxx.

                                                    :
  TauRecToolBase(name) {
}

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

eventFinalize()

StatusCode TauRecToolBase::eventFinalize ( )

overridevirtualinherited

Event finalizer - called at the end of each event.

Implements ITauToolBase.

Definition at line 123 of file TauRecToolBase.cxx.

                                         {
  return StatusCode::SUCCESS;
}

eventInitialize()

StatusCode TauRecToolBase::eventInitialize ( )

overridevirtualinherited

Event initializer - called at the beginning of each event.

Implements ITauToolBase.

Definition at line 36 of file TauRecToolBase.cxx.

                                          {
  return StatusCode::SUCCESS;
}

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

executeTool() [1/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , CaloConstCellContainer & , boost::dynamic_bitset<> &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 49 of file TauRecToolBase.cxx.

                                                      {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [2/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , const xAOD::VertexContainer *  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 54 of file TauRecToolBase.cxx.

                                                         {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [3/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::CaloClusterContainer & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 66 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [4/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::ParticleContainer & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 86 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [5/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 82 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [6/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::PFOContainer & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 77 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
} 

executeTool() [7/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::PFOContainer & , xAOD::PFOContainer & , const xAOD::CaloClusterContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 71 of file TauRecToolBase.cxx.

                                                               {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [8/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::TauTrackContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 62 of file TauRecToolBase.cxx.

                                                     {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [9/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::VertexContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 58 of file TauRecToolBase.cxx.

                                                                    {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [10/10]

StatusCode TauCombinedTES::executeTool ( xAOD::TauJet & xTau, const EventContext & ctx ) const

overridevirtual

Execute - called for each tau candidate.

Reimplemented from TauRecToolBase.

Definition at line 118 of file TauCombinedTES.cxx.

                                                    {
 
  TLorentzVector combinedP4(tau.p4(xAOD::TauJetParameters::TauEnergyScale));
 
  // Parameterization is only valid for |eta| < 2.5, and decay modes of 1p0n, 1p1n, 1pXn, 3p0n, 3pXn
  // If these variables of the given tau candidate are outside the range, we just use calo TES
  if(isValid(tau)) {
    combinedP4 = getCombinedP4(tau);
  }
 
  static const SG::Accessor<float> decPtCombined("ptCombined");
  static const SG::Accessor<float> decEtaCombined("etaCombined");
  static const SG::Accessor<float> decPhiCombined("phiCombined");
  static const SG::Accessor<float> decMCombined("mCombined");
 
  decPtCombined(tau) = combinedP4.Pt();
  decEtaCombined(tau) = combinedP4.Eta();
  decPhiCombined(tau) = combinedP4.Phi();
  decMCombined(tau) = combinedP4.M();
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

StatusCode TauRecToolBase::finalize ( )

overridevirtualinherited

Finalizer.

Implements ITauToolBase.

Reimplemented in PanTau::PanTauProcessor.

Definition at line 127 of file TauRecToolBase.cxx.

                                   {
  return StatusCode::SUCCESS;
}

find_file()

std::string TauRecToolBase::find_file ( const std::string & fname ) const

inherited

Definition at line 19 of file TauRecToolBase.cxx.

                                                                {
  std::string full_path;
  //offline calib files are in GroupData
  //online calib files are in release
  full_path = PathResolverFindCalibFile(m_tauRecToolsTag+"/"+fname);
  if(full_path.empty()) full_path = PathResolverFindCalibFile(fname);
  return full_path;
}

getCaloCalEt()

double TauCombinedTES::getCaloCalEt ( double et, int decayModeIndex, int etaIndex ) const

private

Get the Et at the calo TES after calibration correction.

Definition at line 209 of file TauCombinedTES.cxx.

                                        {
  // ratio stored in the calibration graph equals (caloEt-truthEt)/caloEt
  double ratio = 0.0;
 
  // FIXME: If caloEt is larger than max et, could we use the ratio at
  // max et, instead of setting it to zero
  if (caloEt <= m_caloRelBiasMaxEt.at(decayModeIndex).at(etaIndex)) {
    ratio = m_caloRelBias.at(decayModeIndex).at(etaIndex)->Eval(caloEt);
  }
 
  double caloCalEt = caloEt - ratio * caloEt;
 
  return caloCalEt;
}

getCaloResolution()

double TauCombinedTES::getCaloResolution ( double et, int decayModeIndex, int etaIndex ) const

private

Get the resolution of Et at the calo TES.

Definition at line 246 of file TauCombinedTES.cxx.

                                                                                          {
  double x = std::min(et, m_caloResMaxEt.at(decayModeIndex).at(etaIndex));
  double resolution = m_caloRes.at(decayModeIndex).at(etaIndex)->Eval(x);
 
  return resolution;
}

getCombinedEt()

double TauCombinedTES::getCombinedEt ( double caloEt, double et_substructure, xAOD::TauJetParameters::DecayMode decayMode, float eta ) const

private

Get the combined Et of calo TES and PanTau.

Definition at line 296 of file TauCombinedTES.cxx.

                                      {
  // Obtain the index of calibration graph
  int decayModeIndex = getDecayModeIndex(decayMode);
  int etaIndex = getEtaIndex(eta);
 
  // Obtain the calibration parameter based on the index
  // -- Correlation between calo TES and PanTau
  double correlation = getCorrelation(decayModeIndex, etaIndex);
 
  // -- Sigma of the difference between reconstruted et and truth et at calo TES
  double caloSigma = caloEt * getCaloResolution(caloEt, decayModeIndex, etaIndex);
  if (0. == caloSigma) {
    ATH_MSG_WARNING("Calo TES: Et resolution at " << caloEt << " is 0");
    m_caloRes.at(decayModeIndex)[etaIndex]->Print("all");
    return 0.;
  }
 
  // -- Sigma of the difference between reconstruted et and truth et at PanTau
  double panTauSigma = panTauEt * getPanTauResolution(panTauEt, decayModeIndex, etaIndex);
  if (0. == panTauSigma) {
    ATH_MSG_WARNING("PanTau: Et resolution at " << panTauEt << " is 0");
    m_panTauRes.at(decayModeIndex).at(etaIndex)->Print("all");
    return 0.;
  }
 
  // -- Et at calo TES with bias corrected
  double caloCalEt = getCaloCalEt(caloEt, decayModeIndex, etaIndex);
 
  // -- Et at PanTau with bias corrected
  double panTauCalEt = getPanTauCalEt(panTauEt, decayModeIndex, etaIndex);
 
  // Combination of calo TES and PanTau
  // FIXME: A more consistent way would be calculating the weight use bias corrected Et as input
  double weight = getWeight(caloSigma, panTauSigma, correlation);
  double weightedEt = weight * caloCalEt + (1 - weight) * panTauCalEt;
  double compatibilitySigma = getCompatibilitySigma(caloSigma, panTauSigma, correlation);
 
  // If the difference of calo TES and PanTau is too large, the combined result
  // may not be reliable
  // FIXME: A more consistent way would be calculating the NsigmaCompatibility use caloCalEt
  double deltaEt = caloCalEt - panTauCalEt;
  if (std::abs(deltaEt) > getNsigmaCompatibility(caloEt, decayModeIndex) * compatibilitySigma) {
    // FIXME: Why not use caloCalEt here ?
    weightedEt = caloEt;
  }
 
  ATH_MSG_DEBUG("Intermediate results\n" <<
                "coff: " << correlation << " sigma(calo): " << caloSigma << " sigma(constituent): " << panTauSigma <<
                "\ncalibrated et(calo): " << caloCalEt << " calibrated et(constituent): " << panTauCalEt <<
                "\nweight:" << weight << " combined et: " << weightedEt << " compatibility sigma: " << compatibilitySigma);
 
  return weightedEt;
}

getCombinedP4()

TLorentzVector TauCombinedTES::getCombinedP4 ( const xAOD::TauJet & tau ) const

private

Get the weighted four momentum of calo TES and PanTau.

Definition at line 355 of file TauCombinedTES.cxx.

                                                                        {
  TLorentzVector caloP4 = tau.p4(xAOD::TauJetParameters::TauEnergyScale);
  TLorentzVector panTauP4 = tau.p4(xAOD::TauJetParameters::PanTauCellBased);
 
  ATH_MSG_DEBUG("Four momentum at calo TES, pt: " << caloP4.Pt() << " eta: " << caloP4.Eta() <<
                " phi: " << caloP4.Phi() << " mass: " << caloP4.M());
  ATH_MSG_DEBUG("Four momentum at PanTau, pt: " << panTauP4.Pt() << " eta: " << panTauP4.Eta() <<
                " phi: " << panTauP4.Phi() << " mass: " << panTauP4.M());
 
  xAOD::TauJetParameters::DecayMode decayMode = getDecayMode(tau);
 
  double combinedEt = getCombinedEt(caloP4.Et(), panTauP4.Et(), decayMode, caloP4.Eta());
 
  // Et is the combination of calo TES and PanTau, but eta and phi is from PanTau
  TLorentzVector combinedP4;
  combinedP4.SetPtEtaPhiM(combinedEt, panTauP4.Eta(), panTauP4.Phi(), 0.);
 
  ATH_MSG_DEBUG("Combined four momentum, pt: " << combinedP4.Pt() << " eta: " << combinedP4.Eta() <<
                " phi: " << combinedP4.Phi() << " mass: " << combinedP4.M());
 
  return combinedP4;
}

getCompatibilitySigma()

double TauCombinedTES::getCompatibilitySigma ( double caloSigma, double panTauSigma, double correlation ) const

private

Get the compatibility sigma of calo TES and PanTau.

Definition at line 276 of file TauCombinedTES.cxx.

                                                   {
  double compatibilitySigma2 = std::pow(caloSigma, 2) + std::pow(panTauSigma, 2) - 2 * correlation * caloSigma * panTauSigma;
 
  return std::sqrt(compatibilitySigma2);
}

getCorrelation()

double TauCombinedTES::getCorrelation ( int decayModeIndex, int etaIndex ) const

private

Get correlation coefficient between the calo TES and PanTau.

Definition at line 203 of file TauCombinedTES.cxx.

                                                                            {
  return m_correlationHists.at(decayModeIndex)->GetBinContent(etaIndex);
}

getDecayMode()

xAOD::TauJetParameters::DecayMode TauCombinedTES::getDecayMode ( const xAOD::TauJet & tau ) const

private

Get the decay mode of the tau candidate.

Definition at line 170 of file TauCombinedTES.cxx.

                                                                                      {
  int decayMode = xAOD::TauJetParameters::DecayMode::Mode_Error;
  tau.panTauDetail(xAOD::TauJetParameters::PanTauDetails::PanTau_DecayMode, decayMode);
 
  return static_cast<xAOD::TauJetParameters::DecayMode>(decayMode);
}

getDecayModeIndex()

int TauCombinedTES::getDecayModeIndex ( xAOD::TauJetParameters::DecayMode decayMode ) const

private

Get the index of decay mode in the calibration histogram.

Definition at line 179 of file TauCombinedTES.cxx.

                                                                                   {
  return static_cast<int>(decayMode);
}

getEtaIndex()

int TauCombinedTES::getEtaIndex ( float eta ) const

private

Get the index of eta in the calibration histogram.

Definition at line 144 of file TauCombinedTES.cxx.

                                               {
  // It would be better to retrieve eta bins from the calibration file, e.g. for upgrade studies!
  float abseta = std::abs(eta);
      
  if (abseta < 0.3) {
    return 0;
  }
  if (abseta < 0.8) {
    return 1;
  }
  if (abseta < 1.3) {
    return 2;
  }
  if (abseta < 1.6) {
    return 3;
  }
  // slightly extend the tau eta range, as |eta|<2.5 applies to the seed jet
  if (abseta < 2.6) {
    return 4;
  }
 
  return 99;
}

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getNsigmaCompatibility()

double TauCombinedTES::getNsigmaCompatibility ( double caloEt, int decayModeIndex ) const

private

Get the allowed difference between calo TES and PanTau.

Definition at line 286 of file TauCombinedTES.cxx.

                                                                                 {
  double nsigma = m_nSigmaCompatibility.at(decayModeIndex)->Eval(et);
 
  if (nsigma < 0.) return 0.;
 
  return nsigma;
}

getPanTauCalEt()

double TauCombinedTES::getPanTauCalEt ( double panTauEt, int decayModeIndex, int etaIndex ) const

private

Get the Et at PanTau after calibration correction.

Definition at line 228 of file TauCombinedTES.cxx.

                                          {
  // ratio stored in the calibration graph equals (panTauEt-truthEt)/panTauEt
  double ratio = 0.0;
 
  // Substructure is badly determined at high pt, as track momentum is pooryly measured
  if (panTauEt <= m_panTauRelBiasMaxEt.at(decayModeIndex).at(etaIndex)) {
    ratio = m_panTauRelBias.at(decayModeIndex).at(etaIndex)->Eval(panTauEt);
  }
 
  double panTauCalEt = panTauEt - ratio * panTauEt;
 
  return panTauCalEt;
}

getPanTauResolution()

double TauCombinedTES::getPanTauResolution ( double et, int decayModeIndex, int etaIndex ) const

private

Get the resolution of Et at PanTau.

Definition at line 255 of file TauCombinedTES.cxx.

                                                                                            {
  double x = std::min(et, m_panTauResMaxEt.at(decayModeIndex).at(etaIndex));
  double resolution = m_panTauRes.at(decayModeIndex).at(etaIndex)->Eval(x);
 
  return resolution;
}

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

getWeight()

double TauCombinedTES::getWeight ( double caloSigma, double panTauSigma, double correlatioon ) const

private

Get the weight of calo TES.

Definition at line 264 of file TauCombinedTES.cxx.

                                           {
  double cov = correlation * caloSigma * panTauSigma;
  double caloWeight = std::pow(panTauSigma, 2) - cov;
  double panTauWeight = std::pow(caloSigma, 2) - cov;
  
  double weight = (caloWeight + panTauWeight !=0.) ? caloWeight/(caloWeight + panTauWeight) : 0.;
  // enforce that the weight is within [0,1]
  return std::clamp(weight, 0., 1.);
}

inAOD()

bool TauRecToolBase::inAOD ( ) const

inlineprotectedinherited

Definition at line 116 of file TauRecToolBase.h.

{ return m_in_AOD; }

inEleRM()

bool TauRecToolBase::inEleRM ( ) const

inlineprotectedinherited

Definition at line 117 of file TauRecToolBase.h.

{ return m_in_EleRM; }

initialize()

StatusCode TauCombinedTES::initialize ( void )

overridevirtual

Tool initializer.

Reimplemented from TauRecToolBase.

Definition at line 19 of file TauCombinedTES.cxx.

                                      {
 
  std::string calFilePath = find_file(m_calFileName);
  std::unique_ptr<TFile> calFile(TFile::Open(calFilePath.c_str(), "READ"));
  ATH_MSG_INFO("Using calibration file: " << calFilePath);
 
  // 1D array with decay mode as index
  TH1F* hist = nullptr;
  TF1* tf1 = nullptr;
  std::string histName = "";
  for (size_t decayModeIndex = 0; decayModeIndex < DecayModeBinning; ++ decayModeIndex) {
    histName = "CorrelationCoeff_tauRec_" + m_decayModeNames[decayModeIndex];
    hist = dynamic_cast<TH1F*> (calFile->Get(histName.c_str()));
    if(hist) {
      hist->SetDirectory(nullptr);
      m_correlationHists[decayModeIndex] = std::unique_ptr<TH1F>(hist);
      ATH_MSG_DEBUG("Adding corr hist: " << histName);
    }
    else {
      ATH_MSG_FATAL("Failed to get an object with name " << histName);
      return StatusCode::FAILURE;
    }
 
    histName = "nSigmaCompatibility_" + m_decayModeNames[decayModeIndex];
    tf1 = dynamic_cast<TF1*> (calFile->Get(histName.c_str()));
    if(tf1) {
      m_nSigmaCompatibility[decayModeIndex] = std::unique_ptr<TF1>(tf1);
      ATH_MSG_DEBUG("Adding compatibility TF1: " << histName);
    }
    else {
      ATH_MSG_FATAL("Failed to get an object with name " << histName);
      return StatusCode::FAILURE;
    }
  }
 
  // 2D array with (eta, decay mode) as index
  TGraph* graph = nullptr;
  std::string graphName="";
  for (size_t decayModeIndex = 0; decayModeIndex < DecayModeBinning; ++decayModeIndex) {
    for (size_t etaIndex = 0; etaIndex < EtaBinning; ++etaIndex) {
      // Calo TES: relative bias
      graphName = "tauRec/Graph_from_MeanEt_tauRec_" + m_decayModeNames[decayModeIndex] + "_" + m_etaBinNames[etaIndex];
      graph = dynamic_cast<TGraph*> (calFile->Get(graphName.c_str()));
      if(graph) {
        m_caloRelBiasMaxEt[decayModeIndex][etaIndex] = TMath::MaxElement(graph->GetN(), graph->GetX());
        m_caloRelBias[decayModeIndex][etaIndex] = std::unique_ptr<TGraph>(graph);
        ATH_MSG_DEBUG("Adding graph: " << graphName);
      }
      else {
        ATH_MSG_FATAL("Failed to get an object with name " << graphName);
        return StatusCode::FAILURE;
      }
 
      // Calo TES: resolution
      graphName = "tauRec/Graph_from_ResolutionEt_tauRec_" + m_decayModeNames[decayModeIndex] + "_" + m_etaBinNames[etaIndex];
      graph = dynamic_cast<TGraph*> (calFile->Get(graphName.c_str()));
      if(graph){
        m_caloResMaxEt[decayModeIndex][etaIndex] = TMath::MaxElement(graph->GetN(), graph->GetX());
        m_caloRes[decayModeIndex][etaIndex] = std::unique_ptr<TGraph>(graph);
        ATH_MSG_DEBUG("Adding graph: " << graphName);
      }
      else {
        ATH_MSG_FATAL("Failed to get an object with name " << graphName);
        return StatusCode::FAILURE;
      }
 
      // PanTau: relative bias
      graphName = "ConstituentEt/Graph_from_MeanEt_ConstituentEt_" + m_decayModeNames[decayModeIndex] + "_" + m_etaBinNames[etaIndex];
      graph = dynamic_cast<TGraph*> (calFile->Get(graphName.c_str()));
      if(graph){
        m_panTauRelBiasMaxEt[decayModeIndex][etaIndex] = TMath::MaxElement(graph->GetN(), graph->GetX());
        m_panTauRelBias[decayModeIndex][etaIndex] = std::unique_ptr<TGraph>(graph);
        ATH_MSG_DEBUG("Adding graph: " << graphName);
      }
      else {
        ATH_MSG_FATAL("Failed to get an object with name " << graphName);
        return StatusCode::FAILURE;
      }
 
      // PanTau: resolution
      graphName = "ConstituentEt/Graph_from_ResolutionEt_ConstituentEt_" + m_decayModeNames[decayModeIndex] + "_" + m_etaBinNames[etaIndex];
      graph = dynamic_cast<TGraph*> (calFile->Get(graphName.c_str()));
      if(graph){
        m_panTauResMaxEt[decayModeIndex][etaIndex] = TMath::MaxElement(graph->GetN(), graph->GetX());
        m_panTauRes[decayModeIndex][etaIndex] = std::unique_ptr<TGraph>(graph);
        ATH_MSG_DEBUG("Adding graph: " << graphName);
      }
      else {
        ATH_MSG_FATAL("Failed to get an object with name " << graphName);
        return StatusCode::FAILURE;
      }
    }
  }
  calFile->Close();
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

inTrigger()

bool TauRecToolBase::inTrigger ( ) const

inlineprotectedinherited

Definition at line 115 of file TauRecToolBase.h.

{ return m_in_trigger; }

isValid()

bool TauCombinedTES::isValid ( const xAOD::TauJet & tau ) const

private

Whether the tau candidate is valid for the calculation.

Definition at line 185 of file TauCombinedTES.cxx.

                                                        {
  xAOD::TauJetParameters::DecayMode decayMode = getDecayMode(tau);
  if (decayMode < xAOD::TauJetParameters::Mode_1p0n || decayMode > xAOD::TauJetParameters::Mode_3pXn) {
    ATH_MSG_DEBUG("Decay mode is not supported !");
    return false;
  }
 
  int etaIndex = getEtaIndex(tau.etaTauEnergyScale());
  if (etaIndex > 4) {
    ATH_MSG_DEBUG("Eta is out of the supported range !");
    return false;
  }
 
  return true;
}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 368 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_calFileName

Gaudi::Property<std::string> TauCombinedTES::m_calFileName {this, "WeightFileName", ""}

private

Definition at line 35 of file TauCombinedTES.h.

{this, "WeightFileName", ""};

m_caloRelBias

std::array<std::array<std::unique_ptr<TGraph>, EtaBinning>, DecayModeBinning> TauCombinedTES::m_caloRelBias

private

Calibration graph: mean of bias/caloEt as a function of caloEt.

Definition at line 90 of file TauCombinedTES.h.

m_caloRelBiasMaxEt

std::array<std::array<double, EtaBinning>, DecayModeBinning> TauCombinedTES::m_caloRelBiasMaxEt

private

Maximum Et of m_caloRelBias.

Definition at line 93 of file TauCombinedTES.h.

m_caloRes

std::array<std::array<std::unique_ptr<TGraph>, EtaBinning>, DecayModeBinning> TauCombinedTES::m_caloRes

private

Calibration graph: resolution at Calo TES as a function of caloEt.

Definition at line 96 of file TauCombinedTES.h.

m_caloResMaxEt

std::array<std::array<double, EtaBinning>, DecayModeBinning> TauCombinedTES::m_caloResMaxEt

private

Maximum Et of m_caloRes.

Definition at line 99 of file TauCombinedTES.h.

m_correlationHists

std::array<std::unique_ptr<TH1F>, DecayModeBinning> TauCombinedTES::m_correlationHists

private

Calibration histogram: correlation coefficient of calo TES and PanTau.

Definition at line 114 of file TauCombinedTES.h.

m_decayModeNames

const std::array<std::string, DecayModeBinning> TauCombinedTES::m_decayModeNames = {"1p0n","1p1n","1pXn","3p0n","3pXn"}

private

Decay mode binning in the calibration graph/hist.

Definition at line 84 of file TauCombinedTES.h.

{"1p0n","1p1n","1pXn","3p0n","3pXn"}; 

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

m_etaBinNames

const std::array<std::string, EtaBinning> TauCombinedTES::m_etaBinNames = {"0", "1", "2", "3", "4"}

private

Eta binning in the calibration graph.

Definition at line 87 of file TauCombinedTES.h.

{"0", "1", "2", "3", "4"}; 

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

m_in_AOD

Gaudi::Property<bool> TauRecToolBase::m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}

protectedinherited

Definition at line 105 of file TauRecToolBase.h.

{this, "inAOD",       false,                     "Indicate if the tool is running on AOD"};

m_in_EleRM

Gaudi::Property<bool> TauRecToolBase::m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}

protectedinherited

Definition at line 106 of file TauRecToolBase.h.

{this, "inEleRM",       false,                     "Indicate if the tool is running on EleRM routine"};

m_in_trigger

Gaudi::Property<bool> TauRecToolBase::m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}

protectedinherited

Definition at line 104 of file TauRecToolBase.h.

{this, "inTrigger",   false,                     "Indicate if the tool is running on trigger"};

m_nSigmaCompatibility

std::array<std::unique_ptr<TF1>, DecayModeBinning> TauCombinedTES::m_nSigmaCompatibility

private

Maximum tolerence in unit of combined sigma, as a function of calo Et.

Definition at line 117 of file TauCombinedTES.h.

m_panTauRelBias

std::array<std::array<std::unique_ptr<TGraph>, EtaBinning>, DecayModeBinning> TauCombinedTES::m_panTauRelBias

private

Calibration graph: mean of bias/panTauEt as a funtion of panTauEt.

Definition at line 102 of file TauCombinedTES.h.

m_panTauRelBiasMaxEt

std::array<std::array<double, EtaBinning>, DecayModeBinning> TauCombinedTES::m_panTauRelBiasMaxEt

private

Maximum Et of m_panTauRelBias.

Definition at line 105 of file TauCombinedTES.h.

m_panTauRes

std::array<std::array<std::unique_ptr<TGraph>, EtaBinning>, DecayModeBinning> TauCombinedTES::m_panTauRes

private

Calibration graph: resolution at PanTau as a function of panTauEt.

Definition at line 108 of file TauCombinedTES.h.

m_panTauResMaxEt

std::array<std::array<double, EtaBinning>, DecayModeBinning> TauCombinedTES::m_panTauResMaxEt

private

Maximum Et of m_panTauRes.

Definition at line 111 of file TauCombinedTES.h.

m_tauRecToolsTag

Gaudi::Property<std::string> TauRecToolBase::m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}

protectedinherited

Definition at line 107 of file TauRecToolBase.h.

{this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

The documentation for this class was generated from the following files:

• TauCombinedTES.h
• TauCombinedTES.cxx