met::METSystematicsTool Class Reference

#include <METSystematicsTool.h>

Inheritance diagram for met::METSystematicsTool:

Collaboration diagram for met::METSystematicsTool:

Public Member Functions
	METSystematicsTool (const std::string &name)
StatusCode	softTrkSystInitialize ()
StatusCode	softCaloSystInitialize ()
StatusCode	jetTrkSystInitialize ()
StatusCode	initialize ()
	Dummy implementation of the initialisation function.
CP::CorrectionCode	applyCorrection (xAOD::MissingET &inputMet, const xAOD::MissingETAssociationHelper &helper) const
CP::CorrectionCode	correctedCopy (const xAOD::MissingET &met, xAOD::MissingET *&outputmet, const xAOD::MissingETAssociationHelper &helper) const
bool	isAffectedBySystematic (const CP::SystematicVariation &var) const
	Declare the interface that this class provides.
CP::SystematicSet	affectingSystematics () const
	the list of all systematics this tool can be affected by
CP::SystematicSet	recommendedSystematics () const
	the list of all systematics this tool recommends to use
StatusCode	applySystematicVariation (const CP::SystematicSet &set)
	effects: configure this tool for the given list of systematic variations.
StatusCode	sysApplySystematicVariation (const CP::SystematicSet &)
	effects: configure this tool for the given list of systematic variations.
void	setRandomSeed (unsigned long seed) 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
const SystematicSet &	appliedSystematics () const
	returns: the list of systematics that have been applied to this tool.
std::string	appliedSystematicsString () const
	returns: a string representation of appliedSystematics() guarantee: strong failures: out of memory II rationale: this is meant to be used when printing out the applied systematics for debugging purposes (or when embedding them in a string).
void	testInvariant () const
	effects: test the invariance of this object guarantee: no-fail
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
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.
StatusCode	addAffectingSystematic (const SystematicVariation &systematic, bool recommended)
	effects: add a systematic to the list of registered systematics.
StatusCode	addRecommendedSystematic (const SystematicVariation &systematic)
	effects: add a systematic to the list of recommended systematics failures: unsupported systematic
void	addAffectingSystematics (const SystematicSet &systematics)
	effects: add a SystematicSet to the registered systematics.
StatusCode	addRecommendedSystematics (const SystematicSet &systematics)
	effects: add a SystematicSet to the recommended systematics.

Protected Attributes
SystematicSet	m_affectingSystematics
	description: members directly corresponding to accessors
SystematicSet	m_recommendedSystematics

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	FRIEND_TEST (METSystTest, TestDefaultHistosFilled)
	FRIEND_TEST (METSystTest, TestJetTrkHistosFilled)
	FRIEND_TEST (METSystTest, TestAddAffectingSystematic)
	FRIEND_TEST (METSystTest, TestProjectST)
	FRIEND_TEST (METSystTest, TestProjectST2)
	METSystematicsTool ()
CP::CorrectionCode	internalSoftTermApplyCorrection (xAOD::MissingET &softMet, xAOD::MissingETContainer const *METcont, xAOD::EventInfo const &eInfo) const
CP::CorrectionCode	calcJetTrackMETWithSyst (xAOD::MissingET &jettrkmet, const xAOD::MissingETAssociationHelper &helper) const
CP::CorrectionCode	calcJetTrackMETWithSyst (xAOD::MissingET &jettrkmet, const xAOD::MissingETAssociationHelper &helper, const xAOD::Jet *jet) const
CP::CorrectionCode	getCorrectedJetTrackMET (xAOD::MissingET &jettrkmet, const xAOD::MissingETAssociationHelper &helper) const
TRandom3 *	getTLSRandomGen () const
int	getNPV () const
xAOD::EventInfo const *	getDefaultEventInfo () const
StatusCode	addMETAffectingSystematics ()
StatusCode	extractHistoPath (std::string &histfile, std::string &systpath, std::string &configdir, std::string &suffix, SystType const &type)
missingEt	calcPtHard (xAOD::MissingETContainer const *const cont) const
missingEt	variedSoftTerm (missingEt const &softTerms, missingEt const &ptHard, double varPara, double varPerp) const
missingEt	projectST (missingEt const &softTerms, missingEt const &ptHard) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SystApplied	m_appliedSystEnum {NONE}
Gaudi::Property< std::string >	m_configPrefix {this, "ConfigPrefix", "METUtilities/R22_PreRecs", ""}
Gaudi::Property< std::string >	m_configSoftTrkFile {this, "ConfigSoftTrkFile", "TrackSoftTerms-pflow_Dec24.config", ""}
Gaudi::Property< std::string >	m_configJetTrkFile {this, "ConfigJetTrkFile", "", ""}
Gaudi::Property< std::string >	m_configSoftCaloFile {this, "ConfigSoftCaloFile", "", ""}
Gaudi::Property< bool >	m_useDevArea {this, "UseDevArea", false, ""}
std::unique_ptr< TH3D >	m_trk_shiftpara_pthard_njet_mu {}
std::unique_ptr< TH3D >	m_trk_resopara_pthard_njet_mu {}
std::unique_ptr< TH3D >	m_trk_resoperp_pthard_njet_mu {}
std::unique_ptr< TH3D >	m_calo_shiftpara_pthard_njet_mu {}
std::unique_ptr< TH3D >	m_calo_resopara_pthard_njet_mu {}
std::unique_ptr< TH3D >	m_calo_resoperp_pthard_njet_mu {}
std::unique_ptr< TH2D >	m_jet_systRpt_pt_eta {}
boost::thread_specific_ptr< TRandom3 >	m_rand_tls
int	m_units {-1}
SG::ReadHandleKey< xAOD::VertexContainer >	m_VertexContKey {this, "VertexContainer", "PrimaryVertices", ""}
SG::ReadHandleKey< xAOD::MissingETContainer >	m_TruthContKey {this, "TruthContainer", "MET_Truth", ""}
SG::ReadHandleKey< xAOD::EventInfo >	m_EventInfoKey {this, "EventInfo", "EventInfo", ""}
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
SystematicSet *	m_appliedSystematics
	description: pointer to currenty applied systematics
std::unordered_map< SystematicSet, SystematicSet >	m_systFilterMap
	map of cached systematics filtering

Detailed Description

Definition at line 84 of file METSystematicsTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

METSystematicsTool() [1/2]

met::METSystematicsTool::METSystematicsTool

(

const std::string &

name

)

Definition at line 31 of file METSystematicsTool.cxx.

    : asg::AsgTool::AsgTool(name)
  {
    ATH_MSG_DEBUG (__PRETTY_FUNCTION__ );
 
    applySystematicVariation(CP::SystematicSet()).ignore();
  }

METSystematicsTool() [2/2]

met::METSystematicsTool::METSystematicsTool ( )

private

Member Function Documentation

addAffectingSystematic()

StatusCode CP::SystematicsTool::addAffectingSystematic ( const SystematicVariation & systematic, bool recommended )

protectedinherited

effects: add a systematic to the list of registered systematics.

It will optionally also add this sytematic to the recommended set. side effects: this will add the systematic to the global list of systematics, if not already there guarantee: strong failures: out of memory II

Definition at line 111 of file SystematicsTool.cxx.

                                                                                     {
 
      RCU_READ_INVARIANT( this );
 
      SystematicRegistry& reg = SystematicRegistry::getInstance();
      reg.registerSystematic( systematic );
      m_affectingSystematics.insert( systematic );
      if( recommended ) {
         if( addRecommendedSystematic(systematic) != StatusCode::SUCCESS ) {
            return StatusCode::FAILURE;
         }
      }
      return StatusCode::SUCCESS;
   }

addAffectingSystematics()

void CP::SystematicsTool::addAffectingSystematics ( const SystematicSet & systematics )

protectedinherited

effects: add a SystematicSet to the registered systematics.

Definition at line 141 of file SystematicsTool.cxx.

                                                               {
 
      RCU_READ_INVARIANT( this );
 
      SystematicRegistry& reg = SystematicRegistry::getInstance();
      m_affectingSystematics.insert( systematics );
      reg.registerSystematics( systematics );
   }

addMETAffectingSystematics()

StatusCode met::METSystematicsTool::addMETAffectingSystematics ( )

private

Definition at line 39 of file METSystematicsTool.cxx.

                                                           {
    ATH_MSG_VERBOSE (__PRETTY_FUNCTION__ );
 
    if(!m_configSoftTrkFile.empty()){
      if( !(addAffectingSystematic( softTrkAffSyst::MET_SoftTrk_ScaleUp  , true /*recommended */ ) &&
            addAffectingSystematic( softTrkAffSyst::MET_SoftTrk_ScaleDown, true /*recommended */ ) &&
            addAffectingSystematic( softTrkAffSyst::MET_SoftTrk_ResoPara , true /*recommended */ ) &&
            addAffectingSystematic( softTrkAffSyst::MET_SoftTrk_ResoPerp , true /*recommended */ ) &&
            addAffectingSystematic( softTrkAffSyst::MET_SoftTrk_ResoCorr , false /*not recommended */) ) ) {
        ATH_MSG_ERROR("failed to properly add softTrk affecting systematics " );
        return StatusCode::FAILURE;
      }
    }
    if(!m_configSoftCaloFile.empty()){
      if( !(addAffectingSystematic( softCaloAffSyst::MET_SoftCalo_ScaleUp  , true ) &&
            addAffectingSystematic( softCaloAffSyst::MET_SoftCalo_ScaleDown, true ) &&
            addAffectingSystematic( softCaloAffSyst::MET_SoftCalo_ResoPara , true ) &&
            addAffectingSystematic( softCaloAffSyst::MET_SoftCalo_ResoPerp , true ) &&
            addAffectingSystematic( softCaloAffSyst::MET_SoftCalo_ResoCorr , false )) ) {
        ATH_MSG_ERROR("failed to properly add softCalo affecting systematics " );
        return StatusCode::FAILURE;
      }
    }
    if(!m_configJetTrkFile.empty()){
      if( !(addAffectingSystematic( jetTrkAffSyst::MET_JetTrk_ScaleUp  , true /*recommended */ ) &&
            addAffectingSystematic( jetTrkAffSyst::MET_JetTrk_ScaleDown, true /*recommended */ ) ) ){
        ATH_MSG_ERROR("failed to properly add jetTrk affecting systematics " );
        return StatusCode::FAILURE;
      }
    }
 
    ATH_MSG_INFO( "AffectingSystematics are:" );
    for(const auto& syst : m_affectingSystematics) {
      ATH_MSG_INFO( syst.name() );
    }
 
    ATH_MSG_DEBUG("These systematics are set based on your config files: " );
    ATH_MSG_DEBUG("ConfigSoftTrkFile: " << m_configSoftTrkFile );
    ATH_MSG_DEBUG("ConfigSoftCaloFile: "<< m_configSoftCaloFile);
    ATH_MSG_DEBUG("ConfigSoftJetFile: " << m_configJetTrkFile  );
 
    return StatusCode::SUCCESS;
  }

addRecommendedSystematic()

StatusCode CP::SystematicsTool::addRecommendedSystematic ( const SystematicVariation & systematic )

protectedinherited

effects: add a systematic to the list of recommended systematics failures: unsupported systematic

Definition at line 127 of file SystematicsTool.cxx.

                                                                     {
 
      RCU_READ_INVARIANT( this );
 
      SystematicRegistry& reg = SystematicRegistry::getInstance();
      m_recommendedSystematics.insert( systematic );
      if( reg.addSystematicToRecommended( systematic ) !=
          StatusCode::SUCCESS ) {
         return StatusCode::FAILURE;
      }
      return StatusCode::SUCCESS;
   }

addRecommendedSystematics()

StatusCode CP::SystematicsTool::addRecommendedSystematics ( const SystematicSet & systematics )

protectedinherited

effects: add a SystematicSet to the recommended systematics.

Definition at line 151 of file SystematicsTool.cxx.

                                                                 {
 
      RCU_READ_INVARIANT( this );
 
      SystematicRegistry& reg = SystematicRegistry::getInstance();
      m_recommendedSystematics.insert( systematics );
      if( reg.addSystematicsToRecommended( systematics ) !=
          StatusCode::SUCCESS ) {
         return StatusCode::FAILURE;
      }
      return StatusCode::SUCCESS;
   }

affectingSystematics()

CP::SystematicSet met::METSystematicsTool::affectingSystematics ( ) const

inlinevirtual

the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 125 of file METSystematicsTool.h.

{                     return CP::SystematicsTool::affectingSystematics  ()      ;}

appliedSystematics()

const SystematicSet & CP::SystematicsTool::appliedSystematics ( ) const

inherited

returns: the list of systematics that have been applied to this tool.

this is not including systematics that were applied, but do not affect this tool guarantee: no-fail

Definition at line 54 of file SystematicsTool.cxx.

                                             {
 
      RCU_READ_INVARIANT( this );
      if(m_appliedSystematics == 0){
         std::cerr << "SystematicsTool::appliedSystematics WARNING: "
                   << "no systematic configuration has been applied yet. "
                   << "Returning NULL" << std::endl;
         static const SystematicSet dummy;
         return dummy;
      }
      return *m_appliedSystematics;
   }

appliedSystematicsString()

std::string CP::SystematicsTool::appliedSystematicsString ( ) const

inherited

returns: a string representation of appliedSystematics() guarantee: strong failures: out of memory II rationale: this is meant to be used when printing out the applied systematics for debugging purposes (or when embedding them in a string).

Definition at line 67 of file SystematicsTool.cxx.

                                                              {
 
      RCU_READ_INVARIANT( this );
      return m_appliedSystematics->name();
   }

applyCorrection()

CP::CorrectionCode met::METSystematicsTool::applyCorrection ( xAOD::MissingET & inputMet, const xAOD::MissingETAssociationHelper & helper ) const

virtual

Implements IMETSystematicsTool.

Definition at line 236 of file METSystematicsTool.cxx.

                                                                                {
 
    //if asking for jet track systematics, the user needs to give a met association helper (with a map)  as well
    //if using a different jetContainer, you can give it as an option to applyCorrection
    ATH_MSG_VERBOSE (__PRETTY_FUNCTION__ );
 
    if( getDefaultEventInfo() == nullptr) {
      ATH_MSG_WARNING("event info is empty, returning without applying correction");
      return CP::CorrectionCode::Error;
    }
 
    if(! getDefaultEventInfo()->eventType( xAOD::EventInfo::IS_SIMULATION ) ){
      ATH_MSG_WARNING("This tool should be applied to MC only.  Return without changing the input MET object");
      return CP::CorrectionCode::Error;
    }
 
    if( MissingETBase::Source::isSoftTerm(inputMet.source())){
 
      xAOD::MissingETContainer const * METcont = dynamic_cast<xAOD::MissingETContainer const*>(inputMet.container());
      if(METcont == nullptr){
        ATH_MSG_WARNING("MissingET object not owned by a container. Returning without applying correction" );
        return CP::CorrectionCode::Error;
      }
 
      return internalSoftTermApplyCorrection(inputMet, METcont, *getDefaultEventInfo());
    }
 
    if(MissingETBase::Source::isJetTerm  (inputMet.source())
                        ){
      if( helper.map() == nullptr) {
        ATH_MSG_WARNING("The MissingETAssociationMap for the given MissingETAssociationHelper is null.  Returning without applying correction ");
        return CP::CorrectionCode::Error;
      }
 
      return getCorrectedJetTrackMET(inputMet, helper);
    }
 
    ATH_MSG_WARNING("METSystematicsTool received a MissingET object it can't correct.  You should only pass soft MET terms or jet track MET terms.");
    return CP::CorrectionCode::Error;
  }

applySystematicVariation()

StatusCode met::METSystematicsTool::applySystematicVariation ( const CP::SystematicSet & systConfig )

inlinevirtual

effects: configure this tool for the given list of systematic variations.

any requested systematics that are not affecting this tool will be silently ignored (unless they cause other errors). failures: systematic unknown failures: requesting multiple variations on the same systematic (e.g. up & down) failures: requesting an unsupported variation on an otherwise supported systematic (e.g. a 2 sigma variation and the tool only supports 1 sigma variations) failures: unsupported combination of supported systematic failures: other tool specific errors

Implements CP::ISystematicsTool.

Definition at line 127 of file METSystematicsTool.h.

{         return CP::SystematicsTool::applySystematicVariation(set) ;}

calcJetTrackMETWithSyst() [1/2]

CP::CorrectionCode met::METSystematicsTool::calcJetTrackMETWithSyst ( xAOD::MissingET & jettrkmet, const xAOD::MissingETAssociationHelper & helper ) const

private

Definition at line 500 of file METSystematicsTool.cxx.

                                                                                     {
    ATH_MSG_VERBOSE(__PRETTY_FUNCTION__);
 
    if( m_jet_systRpt_pt_eta == nullptr ) {
      ATH_MSG_ERROR("jet track systematics histogram not initialized properly.") ;
      return CP::CorrectionCode::Error;
    }
 
    if(m_appliedSystEnum!=MET_JETTRK_SCALEUP && m_appliedSystEnum!=MET_JETTRK_SCALEDOWN)
      return CP::CorrectionCode::Ok;
 
    double uncert = 0.;
    int jetCount=0;
 
    std::vector<const xAOD::Jet*> jets;
    for(const iplink_t& jetlink : acc_constitObjLinks(jettrkmet)) {
      if((*jetlink)->type()!=xAOD::Type::Jet) {
        ATH_MSG_ERROR("Invalid object of type " << (*jetlink)->type() << " in jet term");
        return CP::CorrectionCode::Error;
      }
      jets.push_back(static_cast<const xAOD::Jet*>(*jetlink));
    }
    bool originalInputs = jets.empty() ? false : !acc_originalObject.isAvailable(*jets.front());
    for(const xAOD::Jet *jet : jets) {
      const MissingETAssociation* assoc = nullptr;
      const MissingETAssociationMap* map = helper.map();
      if(originalInputs) {
        assoc = MissingETComposition::getAssociation(map,jet);
      } else {
        const IParticle* orig = *acc_originalObject(*jet);
        assoc = MissingETComposition::getAssociation(map,static_cast<const xAOD::Jet*>(orig));
      }
      MissingETBase::Types::constvec_t trkvec = assoc->jetTrkVec();
      if(std::abs(jet->eta())<=2.5){
        jetCount++;
        int         phbin  = std::as_const(m_jet_systRpt_pt_eta)->GetXaxis()->FindBin(jet->pt()/1e3);
        if(phbin>m_jet_systRpt_pt_eta->GetNbinsX())  phbin  = m_jet_systRpt_pt_eta->GetNbinsX();
 
        int         etabin  = std::as_const(m_jet_systRpt_pt_eta)->GetYaxis()->FindBin(std::abs( jet->eta()  ));
        if(etabin>m_jet_systRpt_pt_eta->GetNbinsY()) etabin = m_jet_systRpt_pt_eta->GetNbinsY();
        float uncert_frac=(trkvec.sumpt())*(m_jet_systRpt_pt_eta->GetBinContent(phbin, etabin));
 
        ATH_MSG_VERBOSE("Sumpt: "<< trkvec.sumpt());
        ATH_MSG_VERBOSE("jet uncert: "<< m_jet_systRpt_pt_eta->GetBinContent(phbin, etabin));
        uncert = std::sqrt(uncert*uncert+uncert_frac*uncert_frac);
      }
    }
 
    ATH_MSG_VERBOSE("Uncertainty: "<< uncert);
    ATH_MSG_VERBOSE("Jet Counting: "<< jetCount);
 
    // Flip sign for down variation
    if(m_appliedSystEnum == MET_JETTRK_SCALEDOWN) uncert *= -1.;
 
    jettrkmet.setMpx  ( jettrkmet.mpx()*(1 + uncert/(std::abs(jettrkmet.mpx())*std::sqrt(2))));
    jettrkmet.setMpy  ( jettrkmet.mpy()*(1 + uncert/(std::abs(jettrkmet.mpy())*std::sqrt(2))));
    jettrkmet.setSumet( jettrkmet.sumet() + uncert);
 
    return CP::CorrectionCode::Ok;
  }

calcJetTrackMETWithSyst() [2/2]

CP::CorrectionCode met::METSystematicsTool::calcJetTrackMETWithSyst ( xAOD::MissingET & jettrkmet, const xAOD::MissingETAssociationHelper & helper, const xAOD::Jet * jet ) const

private

Definition at line 457 of file METSystematicsTool.cxx.

                                                           {
    ATH_MSG_VERBOSE(__PRETTY_FUNCTION__);
 
    if( m_jet_systRpt_pt_eta == nullptr ) {
      ATH_MSG_ERROR("jet track systematics histogram not initialized properly.") ;
      return CP::CorrectionCode::Error;
    }
 
    if(m_appliedSystEnum==MET_JETTRK_SCALEUP || m_appliedSystEnum==MET_JETTRK_SCALEDOWN) {
      xAOD::MissingETAssociation const * const assoc = MissingETComposition::getAssociation(helper.map(),jet);
      MissingETBase::Types::constvec_t trkvec = assoc->overlapTrkVec(helper);
 
      int phbin  = std::as_const(m_jet_systRpt_pt_eta)->GetXaxis()->FindBin(jet->pt()/1e3);
      if(phbin>m_jet_systRpt_pt_eta->GetNbinsX())  phbin  = m_jet_systRpt_pt_eta->GetNbinsX();
 
      int etabin  = std::as_const(m_jet_systRpt_pt_eta)->GetYaxis()->FindBin(std::abs( jet->eta()  ));
      if(etabin>m_jet_systRpt_pt_eta->GetNbinsY()) etabin = m_jet_systRpt_pt_eta->GetNbinsY();
 
      double uncert = 0.;
      switch( m_appliedSystEnum ){
        case MET_JETTRK_SCALEUP : {
          uncert  = m_jet_systRpt_pt_eta->GetBinContent(phbin,etabin);
          break;
        }
        case MET_JETTRK_SCALEDOWN : {
          uncert  = -1.*m_jet_systRpt_pt_eta->GetBinContent(phbin,etabin);
          break;
        }
        default:
          break;
      }
 
      ATH_MSG_VERBOSE("Uncertainty on this jet is " << uncert);
 
      jettrkmet.setMpx  ( jettrkmet.mpx() - trkvec.cpx() * uncert);
      jettrkmet.setMpy  ( jettrkmet.mpy() - trkvec.cpy() * uncert);
    } else { ATH_MSG_VERBOSE("No jet track systematics applied"); }
 
    return CP::CorrectionCode::Ok;
  }

calcPtHard()

missingEt met::METSystematicsTool::calcPtHard ( xAOD::MissingETContainer const *const cont ) const

private

Definition at line 606 of file METSystematicsTool.cxx.

  {
    ATH_MSG_VERBOSE(__PRETTY_FUNCTION__ );
 
    //get truth container
    SG::ReadHandle<xAOD::MissingETContainer> truthCont(m_TruthContKey);
    if (!truthCont.isValid()) {
 
      ATH_MSG_ERROR( m_TruthContKey.key() << " container empty or doesn't exist, calcPtHard returning zero.");
      return {};
    }
 
    xAOD::MissingETContainer::const_iterator truthiter = truthCont->find(MissingETBase::Source::truthNonInt());
    if(truthiter == truthCont->end()){
      ATH_MSG_ERROR( "NonInt is not in " << m_TruthContKey.key() << ". calcPtHard returing zero." );
      return {};
    }
    const xAOD::MissingET& truthmet = **truthiter;
 
    missingEt ptHard;
    ptHard.mpx     = truthmet.mpx();
    ptHard.mpy     = truthmet.mpy();
    ptHard.sumet   = truthmet.sumet();
    ptHard.name    = truthmet.name();
    ptHard.source  = truthmet.source();
 
    //loop over all non soft or total terms
    for(xAOD::MissingETContainer::const_iterator iMET=cont->begin();iMET!=cont->end(); ++iMET  ) {
      if( !( MissingETBase::Source::isSoftTerm( (*iMET)->source() ) ||
         MissingETBase::Source::isTotalTerm( (*iMET)->source() ) ) ) {
        ptHard.mpx   -= (*iMET)->mpx();
        ptHard.mpy   -= (*iMET)->mpy();
        ptHard.sumet += (*iMET)->sumet();
      }
    }
 
    if( ptHard.sumet < 0 ) {
      ATH_MSG_ERROR("PtHard has a negative sumet, returning ptHart = 0");
      return {};
    }
 
    ptHard.mpx  *= 1./(double(m_units)) ;
    ptHard.mpy  *= 1./(double(m_units)) ;
    ptHard.sumet*= 1./(double(m_units)) ;
 
    // protect from zero pthard. protects against an empty pthard for the soft term systematic
    if(ptHard.sumet<1.0e-6){
      ptHard.sumet=1.0e-6;
      ptHard.mpx=1.0e-6;
      ptHard.mpy=0.0;
    }
 
    return ptHard;
  }

correctedCopy()

CP::CorrectionCode met::METSystematicsTool::correctedCopy ( const xAOD::MissingET & met, xAOD::MissingET *& outputmet, const xAOD::MissingETAssociationHelper & helper ) const

virtual

Implements IMETSystematicsTool.

Definition at line 279 of file METSystematicsTool.cxx.

  { ATH_MSG_VERBOSE (__PRETTY_FUNCTION__ );
    xAOD::MissingET * copy = nullptr;
 
    if(outputmet != nullptr ){
      ATH_MSG_WARNING("Please pass a nullptr to the 2nd argument of correctedCopy to fill the output pointer");
      ATH_MSG_WARNING("Returning without making a correctedCopy");
      return CP::CorrectionCode::Error;
    }
 
    if( getDefaultEventInfo() == nullptr) {
      ATH_MSG_WARNING("event info is empty, return a nullptr");
      outputmet = nullptr;
      return CP::CorrectionCode::Error;
    }
 
    if(! getDefaultEventInfo()->eventType( xAOD::EventInfo::IS_SIMULATION ) ){
      ATH_MSG_WARNING("This tool should be applied to MC only.  Return without changing the input MET object");
      outputmet = nullptr;
      return CP::CorrectionCode::Error;
    }
 
    if( MissingETBase::Source::isSoftTerm(met.source())){
      xAOD::MissingETContainer const * METcont = dynamic_cast<xAOD::MissingETContainer const*>(met.container());
      if(METcont == nullptr){
        ATH_MSG_WARNING("MissingET object not owned by a container. Unable to apply correction, returning output MET object as null" );
        outputmet = nullptr;
        return CP::CorrectionCode::Error;
      }
      copy = new xAOD::MissingET(met);
 
      if(internalSoftTermApplyCorrection(*copy, METcont,  *getDefaultEventInfo()) != CP::CorrectionCode::Ok ){
        outputmet = nullptr; delete copy;
        return CP::CorrectionCode::Error;
      }
    }//soft term source
    if( //MissingETBase::Source::isTrackTerm(met.source()) &&
       MissingETBase::Source::isJetTerm  (met.source())){
      if( helper.map() == nullptr) {
        ATH_MSG_WARNING("MissingETAssociationHelper contained a null MissingETAssociationMap pointer");
        outputmet = nullptr; delete copy;
        return CP::CorrectionCode::Error;
      }
      delete copy;
      copy = new xAOD::MissingET(met);
      if(getCorrectedJetTrackMET(*copy, helper) != CP::CorrectionCode::Ok){
        outputmet = nullptr; delete copy;
        return CP::CorrectionCode::Error;
      }
    }//jet track term source
 
    outputmet = copy;
    return CP::CorrectionCode::Ok;
  }

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; }

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; }

extractHistoPath()

StatusCode met::METSystematicsTool::extractHistoPath ( std::string & histfile, std::string & systpath, std::string & configdir, std::string & suffix, SystType const & type )

private

Definition at line 661 of file METSystematicsTool.cxx.

                                                   {
    ATH_MSG_VERBOSE (__PRETTY_FUNCTION__);
    TEnv reader;
 
    std::string configpath = "";
    std::string configfile = "";
    if(m_useDevArea) { configpath += "dev/"; }
 
    switch(type){
    case SOFTCALO   :  configfile += m_configSoftCaloFile.value();
      configpath  = PathResolverFindCalibFile(m_configPrefix.value()+m_configSoftCaloFile.value());
        break;
    case SOFTTRK    :  configfile += m_configSoftTrkFile.value();
      configpath  = PathResolverFindCalibFile(m_configPrefix.value()+m_configSoftTrkFile.value());
        break;
    case JETTRK :   configfile += m_configJetTrkFile.value();
      configpath = PathResolverFindCalibFile(m_configPrefix.value()+m_configJetTrkFile.value());
      break;
    default     :  configpath = "";
    }
 
    ATH_MSG_INFO( "Searching for configFile: " << configfile);
    ATH_MSG_DEBUG( "PWD: "        << gSystem->Getenv("PWD")  )  ;
    ATH_MSG_DEBUG( "CALIBPATH: "  << gSystem->Getenv("CALIBPATH") );
 
    if(configpath.empty() || configfile.empty() ){
      ATH_MSG_ERROR( "Path Resolver couldn't find config file");
      return StatusCode::FAILURE;
    }
 
    if( reader.ReadFile(configpath.c_str(),EEnvLevel(0)) < 0) {
      ATH_MSG_ERROR( "Couldn't read the track config file!" );
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO( "Configuring from file : " << configpath   );
 
 
    switch(type){
      case SOFTCALO:
        histfile =  reader.GetValue( "Conf.InputFile" , "");
        systpath =  reader.GetValue( "GlobalSyst.sourcedir" , "" );
        break;
      case SOFTTRK:
        histfile = reader.GetValue( "Conf.InputFile" , "");
        systpath = reader.GetValue( "PtHardSyst.sourcedir" , "" );
        suffix   = reader.GetValue( "PtHardSyst.suffix"    , "" );
        break;
      case JETTRK:
        histfile = reader.GetValue( "JetTrkSyst.InputFile" , "");
        histfile = m_configPrefix + histfile;
        systpath  = "/";
        break;
      default:
        break;
    }
    if(m_useDevArea) histfile = "dev/"+histfile;
 
    std::string const units_string = reader.GetValue( "Units", "" );
 
    //check if we already set the units in another config file
    if(m_units == 1000){
      if(units_string != "GeV"){
        ATH_MSG_ERROR("initialized the different systematics using two config files that conflict on units");
        return StatusCode::FAILURE;
      }
    }
    if(m_units == 1){
      if( (!units_string.empty()) && (units_string != "MeV")){
        ATH_MSG_ERROR("initialized the different systematics using two config files that conflict on units");
        return StatusCode::FAILURE;
      }
    }
 
    //set the units again
    if( (units_string.empty()) || (units_string == "MeV") ){
      m_units = 1;
    }else if(units_string == "GeV"){
      m_units = 1000;
    }else{
      ATH_MSG_ERROR("You specified an incorrect 'Units' value.  Please specify MeV , GeV , or leave it blank for MeV");
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO( "Will read histograms from : " << histfile );
    ATH_MSG_DEBUG( "Systpath :" <<  systpath ) ;
    histpath = PathResolverFindCalibFile(histfile);
    ATH_MSG_INFO("Extracted histogram path : " << histpath);
 
    if(histfile.empty() || systpath.empty() || histpath.empty() ){
      ATH_MSG_ERROR("Failed to correctly set histfile path, or path to histograms inside of the histfile" );
      return StatusCode::FAILURE;
    }
 
 
    if( (m_units != 1) && (m_units != 1000) && (m_units != -1)){
      ATH_MSG_ERROR("Something is wrong with your units initialization.  Please contact the developers (you should never get here).");
      return StatusCode::FAILURE;
    }
 
    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

FRIEND_TEST() [1/5]

met::METSystematicsTool::FRIEND_TEST ( METSystTest , TestAddAffectingSystematic  )

private

FRIEND_TEST() [2/5]

met::METSystematicsTool::FRIEND_TEST ( METSystTest , TestDefaultHistosFilled  )

private

FRIEND_TEST() [3/5]

met::METSystematicsTool::FRIEND_TEST ( METSystTest , TestJetTrkHistosFilled  )

private

FRIEND_TEST() [4/5]

met::METSystematicsTool::FRIEND_TEST ( METSystTest , TestProjectST  )

private

FRIEND_TEST() [5/5]

met::METSystematicsTool::FRIEND_TEST ( METSystTest , TestProjectST2  )

private

getCorrectedJetTrackMET()

CP::CorrectionCode met::METSystematicsTool::getCorrectedJetTrackMET ( xAOD::MissingET & jettrkmet, const xAOD::MissingETAssociationHelper & helper ) const

private

Definition at line 562 of file METSystematicsTool.cxx.

                                         {
 
    const MissingETAssociationMap* map = helper.map();
    if(!map) {
      ATH_MSG_ERROR("MissingETAssociationMap null, error calculating jet track systematics.");
      return CP::CorrectionCode::Error;
    }
 
    if(calcJetTrackMETWithSyst(jettrkmet, helper) != CP::CorrectionCode::Ok){
      ATH_MSG_ERROR("Failed to calculate jet track systematics.");
      return CP::CorrectionCode::Error;
    }
    return CP::CorrectionCode::Ok;
  }

getDefaultEventInfo()

xAOD::EventInfo const * met::METSystematicsTool::getDefaultEventInfo ( ) const

private

Definition at line 771 of file METSystematicsTool.cxx.

  {
 
    SG::ReadHandle<xAOD::EventInfo> eInfoConst(m_EventInfoKey);
    if (!eInfoConst.isValid()) {
 
      ATH_MSG_ERROR("Failed to retrieve default EventInfo object");
    }
    return &*eInfoConst;
  }

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::TEvent 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::TEvent, 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::TEvent 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::TEvent, 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
   }

getNPV()

int met::METSystematicsTool::getNPV ( ) const

private

Definition at line 782 of file METSystematicsTool.cxx.

                                      {
    SG::ReadHandle<xAOD::VertexContainer> vertices(m_VertexContKey);
 
    if (!vertices.isValid()) {
 
      ATH_MSG_ERROR("Failed to retrieve default NPV value from PrimaryVertices");
      return 0;
    }
 
    int NPV = 0;
    xAOD::VertexContainer::const_iterator itr;
    for (itr = vertices->begin(); itr != vertices->end(); ++itr)
      if ( (*itr)->vertexType()  != xAOD::VxType::NoVtx) NPV++;
 
    return NPV;
  }

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

getTLSRandomGen()

TRandom3 * met::METSystematicsTool::getTLSRandomGen ( ) const

private

Definition at line 799 of file METSystematicsTool.cxx.

                                                      {
    TRandom3* random = m_rand_tls.get();
    if (!random) {
      random = new TRandom3();
      m_rand_tls.reset(random);
    }
    return random;
  }

initialize()

StatusCode met::METSystematicsTool::initialize ( void )

virtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 83 of file METSystematicsTool.cxx.

  {
    ATH_MSG_VERBOSE (__PRETTY_FUNCTION__ );
    // ReadHandleKey(s)
 
    ATH_CHECK( m_VertexContKey.initialize() );
    ATH_CHECK( m_TruthContKey.initialize() );
    ATH_CHECK( m_EventInfoKey.initialize() );
 
    const char lastchar = m_configPrefix.value().back();
    if (lastchar != '/') {
      m_configPrefix = m_configPrefix.value() + "/";
    }
 
    if(m_configSoftTrkFile.empty()  &&
       m_configSoftCaloFile.empty() &&
       m_configJetTrkFile.empty() )  ATH_MSG_WARNING("you have initialized the METSystematicsTool with no configuration file.  The tool will do nothing.  Please set the configuration file properties.");
 
    if(!m_configSoftTrkFile.empty())  ATH_CHECK( softTrkSystInitialize() ) ;
    if(!m_configSoftCaloFile.empty()) ATH_CHECK( softCaloSystInitialize());
    if(!m_configJetTrkFile.empty())   ATH_CHECK( jetTrkSystInitialize()  );
 
    return addMETAffectingSystematics();
  }

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.

internalSoftTermApplyCorrection()

CP::CorrectionCode met::METSystematicsTool::internalSoftTermApplyCorrection ( xAOD::MissingET & softMet, xAOD::MissingETContainer const * METcont, xAOD::EventInfo const & eInfo ) const

private

Definition at line 335 of file METSystematicsTool.cxx.

                                            { //this is equivalent of "getSoftTerms"
 
    ATH_MSG_VERBOSE( __PRETTY_FUNCTION__ );
 
 
    if( ! MissingETBase::Source::isSoftTerm(softMet.source()) ){
      ATH_MSG_ERROR("not soft met, cannot apply soft term correction to this MET");
      return CP::CorrectionCode::Error;
    }
 
    bool doSyst = false;
    if( MissingETBase::Source::isTrackTerm(softMet.source()) ) {
      doSyst = m_appliedSystEnum>=MET_SOFTTRK_SCALEUP && m_appliedSystEnum<=MET_SOFTTRK_RESOCORR;
      ATH_MSG_VERBOSE("Track soft term " << softMet.name()
           << ", met = " << softMet.met()
           << ", applied systematic is " << m_appliedSystEnum
           << ", do syst? " << doSyst);
    } else {
      doSyst = m_appliedSystEnum>=MET_SOFTCALO_SCALEUP && m_appliedSystEnum<=MET_SOFTCALO_RESOCORR;
      ATH_MSG_VERBOSE("Calo soft term " << softMet.name()
           << ", met = " << softMet.met()
           << ", applied systematic is " << m_appliedSystEnum
           << ", do syst? " << doSyst);
    }
 
    if(!doSyst) {
      ATH_MSG_DEBUG("Ignore irrelevant systematic.");
      return CP::CorrectionCode::Ok;
    }
 
    //this is for speed
    //we avoid creating met private stores here
    missingEt softMetStruct;
    softMetStruct.mpx = softMet.mpx();
    softMetStruct.mpy = softMet.mpy();
    softMetStruct.sumet = softMet.sumet();
    softMetStruct.name = softMet.name();
    softMetStruct.source = softMet.source();
 
    if(METcont == nullptr){
      ATH_MSG_WARNING("failed to retrieve MET container from passed object");
      return CP::CorrectionCode::Error;
    }
 
    missingEt const ptHard = calcPtHard(METcont);
    double const ptHardMet = std::sqrt( ptHard.mpx * ptHard.mpx +
          ptHard.mpy * ptHard.mpy )  ;
 
    const xAOD::MissingET* jetterm = *METcont->find( MissingETBase::Source::jet() );
    size_t njet = (jetterm==nullptr) ? 0 : acc_constitObjLinks(*jetterm ).size();
 
    const std::unique_ptr<TH3D>* shiftHist = (MissingETBase::Source::isTrackTerm(softMetStruct.source) ? &m_trk_shiftpara_pthard_njet_mu : &m_calo_shiftpara_pthard_njet_mu);
 
    int phbin        = std::as_const(*shiftHist)->GetXaxis()->FindBin( ptHardMet  ) ;
    if(phbin>(*shiftHist)->GetNbinsX())  phbin = (*shiftHist)->GetNbinsX();
    
    int const jetbin = std::as_const(*shiftHist)->GetYaxis()->FindBin(njet);
    int const mubin  = std::as_const(*shiftHist)->GetZaxis()->FindBin(eInfo.actualInteractionsPerCrossing() );
    double const scalePara = (*shiftHist)->GetBinContent(phbin,jetbin,mubin);
 
    double const randGaus = getTLSRandomGen()->Gaus(0.,1.);
    double smearPara(0), smearPerp(0);
 
    ATH_MSG_DEBUG("About to apply systematic " << appliedSystematicsString() );
 
    //now we need to know what soft term systematics we are doing
    //m_appliedSystEnum was cached by the applySystematicVariation method
    switch( m_appliedSystEnum ){
      case MET_SOFTTRK_SCALEUP:
      case MET_SOFTCALO_SCALEUP:
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, scalePara, 0.);
        break;
      case MET_SOFTTRK_SCALEDOWN:
      case MET_SOFTCALO_SCALEDOWN:
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, -1.*scalePara, 0.);
        break;
      case MET_SOFTTRK_RESOPARA:
        smearPara = m_trk_resopara_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, smearPara, 0.);
        break;
      case MET_SOFTTRK_RESOPERP:
        smearPerp = m_trk_resoperp_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, 0., smearPerp);
        break;
      case MET_SOFTTRK_RESOCORR:
        smearPara = m_trk_resopara_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        smearPerp = m_trk_resoperp_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, smearPara, smearPerp);
        break;
      case MET_SOFTCALO_RESOPARA:
        smearPara = m_calo_resopara_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, smearPara, 0.);
        break;
      case MET_SOFTCALO_RESOPERP:
        smearPerp = m_calo_resoperp_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, 0., smearPerp);
        break;
      case MET_SOFTCALO_RESOCORR:
        smearPara = m_calo_resopara_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        smearPerp = m_calo_resoperp_pthard_njet_mu->GetBinContent(phbin,jetbin,mubin)*randGaus;
        softMetStruct = variedSoftTerm(softMetStruct, ptHard, smearPara, smearPerp);
        break;
      default:
        ATH_MSG_DEBUG("No systematic applied, returning nominal MET term");
    }
 
    //fill the softMet back with the struct values to return
    softMet.setMpx(    softMetStruct.mpx);
    softMet.setMpy(    softMetStruct.mpy);
    softMet.setSumet(  softMetStruct.sumet);
    softMet.setName(   softMetStruct.name);
    softMet.setSource( softMetStruct.source);
 
    ATH_MSG_VERBOSE("Output soft term " << softMet.name()
         << ", met = " << softMet.met() );
 
    return CP::CorrectionCode::Ok;
  }

isAffectedBySystematic()

bool met::METSystematicsTool::isAffectedBySystematic ( const CP::SystematicVariation & systematic ) const

inlinevirtual

Declare the interface that this class provides.

returns: whether this tool is affected by the given systematics

Implements CP::ISystematicsTool.

Definition at line 124 of file METSystematicsTool.h.

{return CP::SystematicsTool::isAffectedBySystematic(var)   ;}

jetTrkSystInitialize()

StatusCode met::METSystematicsTool::jetTrkSystInitialize

(

)

Definition at line 141 of file METSystematicsTool.cxx.

  {
    ATH_MSG_VERBOSE (__PRETTY_FUNCTION__);
 
    std::string histfile  = "";
    std::string gsystpath = "";
    std::string configdir = "";
    std::string blank     = "";
 
    ATH_CHECK( extractHistoPath(histfile,gsystpath, configdir,blank  ,  JETTRK) );//properly sets the paths
 
    TFile infile((configdir).c_str());
 
    m_jet_systRpt_pt_eta.reset(dynamic_cast<TH2D*>( infile.Get("jet_systRpt_pt_eta")));
 
    if( !m_jet_systRpt_pt_eta) {
      ATH_MSG_ERROR("Could not get jet track histo from the config file:" << histfile);
      return StatusCode::FAILURE;
    }
 
    m_jet_systRpt_pt_eta->SetDirectory(nullptr);
 
    ATH_MSG_VERBOSE( __PRETTY_FUNCTION__ << "  DONE!!");
    return StatusCode::SUCCESS;
  }

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, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

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

projectST()

missingEt met::METSystematicsTool::projectST ( missingEt const & softTerms, missingEt const & ptHard ) const

private

Definition at line 591 of file METSystematicsTool.cxx.

  {
    double const ptHardMet =     std::sqrt( ptHard.mpx * ptHard.mpx +
                        ptHard.mpy * ptHard.mpy );
 
    double const ux    = ptHard.mpx/ptHardMet;
    double const uy    = ptHard.mpy/ptHardMet;
    double const projL = ux*softTerms.mpx + uy*softTerms.mpy;
    double const projT = uy*softTerms.mpx - ux*softTerms.mpy;
    missingEt proj(projL,projT,softTerms.sumet,
                         softTerms.name,softTerms.source);
 
    return proj;
  }

recommendedSystematics()

CP::SystematicSet met::METSystematicsTool::recommendedSystematics ( ) const

inlinevirtual

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 126 of file METSystematicsTool.h.

{                     return CP::SystematicsTool::recommendedSystematics()      ;}

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 380 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 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setRandomSeed()

void met::METSystematicsTool::setRandomSeed ( unsigned long seed ) const

virtual

Implements IMETSystematicsTool.

Definition at line 808 of file METSystematicsTool.cxx.

                                                                 {
    getTLSRandomGen()->SetSeed(seed);
  }

softCaloSystInitialize()

StatusCode met::METSystematicsTool::softCaloSystInitialize

(

)

Definition at line 108 of file METSystematicsTool.cxx.

  {
    ATH_MSG_INFO("Doing SoftCalo systematics initialization.  THIS IS FOR SOFTWARE DEVELOPMENT ONLY.");
    ATH_MSG_INFO("CST IS NOT YET RECOMMENDED OR SUPPORTED BY THE MET GROUP.");
 
    std::string histfile = "";
    std::string systpath = "";
    std::string histpath = "";
    std::string suffix   = "";
 
    ATH_CHECK( extractHistoPath(histfile,systpath,histpath,suffix,SOFTCALO) );//properly sets the paths
 
    TFile infile(histpath.c_str());
    m_calo_resoperp_pthard_njet_mu.reset(dynamic_cast<TH3D*>( infile.Get((systpath+"/resoperp_"+suffix).c_str()) ));
    m_calo_resopara_pthard_njet_mu.reset(dynamic_cast<TH3D*>( infile.Get((systpath+"/resopara_"+suffix).c_str()) ));
    m_calo_shiftpara_pthard_njet_mu.reset(dynamic_cast<TH3D*>( infile.Get((systpath+"/shiftpara_"+suffix).c_str())));
 
    if( !(m_calo_resoperp_pthard_njet_mu  &&
          m_calo_resopara_pthard_njet_mu  &&
          m_calo_shiftpara_pthard_njet_mu)){
      ATH_MSG_ERROR("Could not get all calo histos from the config file:" << histfile );
      return StatusCode::FAILURE;
    }
 
    m_calo_resoperp_pthard_njet_mu ->SetDirectory(nullptr);
    m_calo_resopara_pthard_njet_mu ->SetDirectory(nullptr);
    m_calo_shiftpara_pthard_njet_mu->SetDirectory(nullptr);
 
    ATH_MSG_VERBOSE( __PRETTY_FUNCTION__ << "  DONE!!" );
    return StatusCode::SUCCESS;
  }

softTrkSystInitialize()

StatusCode met::METSystematicsTool::softTrkSystInitialize

(

)

Definition at line 168 of file METSystematicsTool.cxx.

  {
 
    std::string histfile  = "";
    std::string psystpath = "";
    std::string histpath = "";
    std::string suffix    = "";
 
    ATH_CHECK( extractHistoPath(histfile,psystpath,histpath, suffix, SOFTTRK) );//properly sets the paths
 
    TFile infile(histpath.c_str());
 
    m_trk_resoperp_pthard_njet_mu.reset(dynamic_cast<TH3D*>( infile.Get((psystpath+"/resoperp_"+suffix).c_str()) ));
    m_trk_resopara_pthard_njet_mu.reset(dynamic_cast<TH3D*>( infile.Get((psystpath+"/resopara_"+suffix).c_str()) ));
    m_trk_shiftpara_pthard_njet_mu.reset(dynamic_cast<TH3D*>( infile.Get((psystpath+"/shiftpara_"+suffix).c_str())));
 
    if( !(m_trk_resoperp_pthard_njet_mu  &&
          m_trk_resopara_pthard_njet_mu  &&
          m_trk_shiftpara_pthard_njet_mu)){
      ATH_MSG_ERROR("Could not get all track histos from the config file:" << histfile );
      return StatusCode::FAILURE;
    }
 
    m_trk_resoperp_pthard_njet_mu ->SetDirectory(nullptr);
    m_trk_resopara_pthard_njet_mu ->SetDirectory(nullptr);
    m_trk_shiftpara_pthard_njet_mu->SetDirectory(nullptr);
 
    ATH_MSG_VERBOSE( __PRETTY_FUNCTION__ <<"  DONE!!");
    return StatusCode::SUCCESS;
  }

sysApplySystematicVariation()

StatusCode met::METSystematicsTool::sysApplySystematicVariation ( const CP::SystematicSet & systConfig )

virtual

effects: configure this tool for the given list of systematic variations.

systConfig is guaranteed to contain only supported systematics. guarantee: basic failures: out of memory II failures: unsupported combination of supported systematics failures: other tool specific errors

Implements CP::SystematicsTool.

Definition at line 199 of file METSystematicsTool.cxx.

                                                                                          {//this should already be filtered for MET systematics
    ATH_MSG_VERBOSE (__PRETTY_FUNCTION__ );
    // Only a single systematic can be applied at a time:
    // If at some point we can deal with multiple systematics, we will check here that the combination we are given will work
 
    m_appliedSystEnum = NONE;
    if( systSet.empty() ) {
      ATH_MSG_DEBUG("No affecting systematics received.");
      return StatusCode::SUCCESS;
    } else if( systSet.size() > 1 ) {
      ATH_MSG_WARNING("Tool does not support multiple systematics, returning unsupported" );
      return StatusCode::FAILURE;
    }
    CP::SystematicVariation systVar = *systSet.begin();
    if     ( systVar == CP::SystematicVariation("") )           m_appliedSystEnum = NONE                  ;
    else if( systVar == softTrkAffSyst::MET_SoftTrk_ScaleUp)    m_appliedSystEnum = MET_SOFTTRK_SCALEUP   ;
    else if( systVar == softTrkAffSyst::MET_SoftTrk_ScaleDown)  m_appliedSystEnum = MET_SOFTTRK_SCALEDOWN ;
    else if( systVar == softTrkAffSyst::MET_SoftTrk_ResoPara)   m_appliedSystEnum = MET_SOFTTRK_RESOPARA  ;
    else if( systVar == softTrkAffSyst::MET_SoftTrk_ResoPerp)   m_appliedSystEnum = MET_SOFTTRK_RESOPERP  ;
    else if( systVar == softTrkAffSyst::MET_SoftTrk_ResoCorr)   m_appliedSystEnum = MET_SOFTTRK_RESOCORR  ;
    else if( systVar == softCaloAffSyst::MET_SoftCalo_ScaleUp)   m_appliedSystEnum = MET_SOFTCALO_SCALEUP  ;
    else if( systVar == softCaloAffSyst::MET_SoftCalo_ScaleDown) m_appliedSystEnum = MET_SOFTCALO_SCALEDOWN;
    else if( systVar == softCaloAffSyst::MET_SoftCalo_ResoPara)   m_appliedSystEnum = MET_SOFTCALO_RESOPARA  ;
    else if( systVar == softCaloAffSyst::MET_SoftCalo_ResoPerp)   m_appliedSystEnum = MET_SOFTCALO_RESOPERP  ;
    else if( systVar == softCaloAffSyst::MET_SoftCalo_ResoCorr)   m_appliedSystEnum = MET_SOFTCALO_RESOCORR  ;
    else if( systVar == jetTrkAffSyst::MET_JetTrk_ScaleUp)     m_appliedSystEnum = MET_JETTRK_SCALEUP    ;
    else if( systVar == jetTrkAffSyst::MET_JetTrk_ScaleDown)   m_appliedSystEnum = MET_JETTRK_SCALEDOWN  ;
    else{
      ATH_MSG_WARNING("unsupported systematic applied " );
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_DEBUG("applied systematic is " << m_appliedSystEnum );
 
    return StatusCode::SUCCESS;
  }

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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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.

testInvariant()

void CP::SystematicsTool::testInvariant ( ) const

inherited

effects: test the invariance of this object guarantee: no-fail

Definition at line 165 of file SystematicsTool.cxx.

                                             {
 
     //RCU_INVARIANT( this != 0 );
   }

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

variedSoftTerm()

missingEt met::METSystematicsTool::variedSoftTerm ( missingEt const & softTerms, missingEt const & ptHard, double varPara, double varPerp ) const

private

Definition at line 579 of file METSystematicsTool.cxx.

                                                    {
 
    missingEt projection = projectST(softTerms,ptHard);
    projection.mpx += varPara;
    projection.mpy += varPerp;
 
    return projectST(projection, ptHard);
  }

Member Data Documentation

m_affectingSystematics

SystematicSet CP::SystematicsTool::m_affectingSystematics

protectedinherited

description: members directly corresponding to accessors

Definition at line 146 of file SystematicsTool.h.

m_appliedSystematics

SystematicSet* CP::SystematicsTool::m_appliedSystematics

privateinherited

description: pointer to currenty applied systematics

Definition at line 151 of file SystematicsTool.h.

m_appliedSystEnum

SystApplied met::METSystematicsTool::m_appliedSystEnum {NONE}

private

Definition at line 138 of file METSystematicsTool.h.

{NONE};

m_calo_resopara_pthard_njet_mu

std::unique_ptr<TH3D> met::METSystematicsTool::m_calo_resopara_pthard_njet_mu {}

private

Definition at line 161 of file METSystematicsTool.h.

{};

m_calo_resoperp_pthard_njet_mu

std::unique_ptr<TH3D> met::METSystematicsTool::m_calo_resoperp_pthard_njet_mu {}

private

Definition at line 162 of file METSystematicsTool.h.

{};

m_calo_shiftpara_pthard_njet_mu

std::unique_ptr<TH3D> met::METSystematicsTool::m_calo_shiftpara_pthard_njet_mu {}

private

Definition at line 160 of file METSystematicsTool.h.

{};

m_configJetTrkFile

Gaudi::Property<std::string> met::METSystematicsTool::m_configJetTrkFile {this, "ConfigJetTrkFile", "", ""}

private

Definition at line 153 of file METSystematicsTool.h.

{this, "ConfigJetTrkFile", "", ""};

m_configPrefix

Gaudi::Property<std::string> met::METSystematicsTool::m_configPrefix {this, "ConfigPrefix", "METUtilities/R22_PreRecs", ""}

private

Definition at line 151 of file METSystematicsTool.h.

{this, "ConfigPrefix", "METUtilities/R22_PreRecs", ""};

m_configSoftCaloFile

Gaudi::Property<std::string> met::METSystematicsTool::m_configSoftCaloFile {this, "ConfigSoftCaloFile", "", ""}

private

Definition at line 154 of file METSystematicsTool.h.

{this, "ConfigSoftCaloFile", "", ""};

m_configSoftTrkFile

Gaudi::Property<std::string> met::METSystematicsTool::m_configSoftTrkFile {this, "ConfigSoftTrkFile", "TrackSoftTerms-pflow_Dec24.config", ""}

private

Definition at line 152 of file METSystematicsTool.h.

{this, "ConfigSoftTrkFile", "TrackSoftTerms-pflow_Dec24.config", ""};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_EventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> met::METSystematicsTool::m_EventInfoKey {this, "EventInfo", "EventInfo", ""}

private

Definition at line 177 of file METSystematicsTool.h.

{this, "EventInfo", "EventInfo", ""};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_jet_systRpt_pt_eta

std::unique_ptr<TH2D> met::METSystematicsTool::m_jet_systRpt_pt_eta {}

private

Definition at line 163 of file METSystematicsTool.h.

{};

m_rand_tls

boost::thread_specific_ptr<TRandom3> met::METSystematicsTool::m_rand_tls

mutableprivate

Definition at line 165 of file METSystematicsTool.h.

m_recommendedSystematics

SystematicSet CP::SystematicsTool::m_recommendedSystematics

protectedinherited

Definition at line 147 of file SystematicsTool.h.

m_systFilterMap

std::unordered_map<SystematicSet, SystematicSet> CP::SystematicsTool::m_systFilterMap

privateinherited

map of cached systematics filtering

Definition at line 154 of file SystematicsTool.h.

m_trk_resopara_pthard_njet_mu

std::unique_ptr<TH3D> met::METSystematicsTool::m_trk_resopara_pthard_njet_mu {}

private

Definition at line 158 of file METSystematicsTool.h.

{};

m_trk_resoperp_pthard_njet_mu

std::unique_ptr<TH3D> met::METSystematicsTool::m_trk_resoperp_pthard_njet_mu {}

private

Definition at line 159 of file METSystematicsTool.h.

{};

m_trk_shiftpara_pthard_njet_mu

std::unique_ptr<TH3D> met::METSystematicsTool::m_trk_shiftpara_pthard_njet_mu {}

private

Definition at line 157 of file METSystematicsTool.h.

{};

m_TruthContKey

SG::ReadHandleKey<xAOD::MissingETContainer> met::METSystematicsTool::m_TruthContKey {this, "TruthContainer", "MET_Truth", ""}

private

Definition at line 176 of file METSystematicsTool.h.

{this, "TruthContainer", "MET_Truth", ""};

m_units

int met::METSystematicsTool::m_units {-1}

private

Definition at line 168 of file METSystematicsTool.h.

{-1};//by default = -1, not set.  Set to 1 (MeV) if not value found in config file

m_useDevArea

Gaudi::Property<bool> met::METSystematicsTool::m_useDevArea {this, "UseDevArea", false, ""}

private

Definition at line 155 of file METSystematicsTool.h.

{this, "UseDevArea", false, ""};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_VertexContKey

SG::ReadHandleKey<xAOD::VertexContainer> met::METSystematicsTool::m_VertexContKey {this, "VertexContainer", "PrimaryVertices", ""}

private

Definition at line 175 of file METSystematicsTool.h.

{this, "VertexContainer", "PrimaryVertices", ""};

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• METSystematicsTool.h
• METSystematicsTool.cxx