AsgElectronEfficiencyCorrectionTool Class Reference

#include <AsgElectronEfficiencyCorrectionTool.h>

Inheritance diagram for AsgElectronEfficiencyCorrectionTool:

Classes
struct	Accessors
struct	SystConf

Public Types
Definition of the StoreGate-like object's definition
typedef ServiceHandle< StoreGateSvc >	MetaStore_t
	Type of the metadata store object in Athena.
typedef const ServiceHandle< StoreGateSvc > &	MetaStorePtr_t
	Type of the metadata store pointer in standalone mode.

Public Member Functions
void	callSingleEvent (columnar::ElectronRange electrons, columnar::EventInfoId event) const
void	callEvents (columnar::EventContextRange events) const override
virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena.
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	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
Functions providing access to the input/output metadata
MetaStorePtr_t	inputMetaStore () const
	Accessor for the input metadata store.
MetaStorePtr_t	outputMetaStore () const
	Accessor for the output metadata store.
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.

Public Attributes
std::unique_ptr< Accessors >	m_accessors

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.
Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)
virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent.
virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed.
virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual ASG_TOOL_CLASS(AsgElectronEfficiencyCorrectionTool, IAsgElectronEfficiencyCorrectionTool) public	~AsgElectronEfficiencyCorrectionTool () override final
	Standard destructor.
virtual StatusCode	initialize () override final
	Gaudi Service Interface method implementations.
virtual StatusCode	beginInputFile () override final
	Function called when a new input file is opened.
virtual StatusCode	beginEvent () override final
	Function called when a new events is loaded.
virtual CP::SystematicSet	affectingSystematics () const override final
	returns: the list of all systematics this tool can be affected by
virtual CP::SystematicSet	recommendedSystematics () const override final
	returns: the list of all systematics this tool recommends to use
virtual bool	isAffectedBySystematic (const CP::SystematicVariation &systematic) const override final
	returns: whether this tool is affected by the given systematis
virtual StatusCode	applySystematicVariation (const CP::SystematicSet &systConfig) override final
	Configure this tool for the given systematics.
virtual CP::CorrectionCode	getEfficiencyScaleFactor (const xAOD::Electron &inputObject, double &efficiencyScaleFactor) const override final
CP::CorrectionCode	getEfficiencyScaleFactor (columnar::ElectronId inputObject, double &efficiencyScaleFactor, columnar::EventInfoId info) const
virtual CP::CorrectionCode	getEfficiencyScaleFactor (const double et, const double cluster_eta, const unsigned int runNumber, double &efficiencyScaleFactor) const override final
virtual CP::CorrectionCode	applyEfficiencyScaleFactor (const xAOD::Electron &inputObject) const override final
virtual int	getNumberOfToys () const override final
virtual void	printCorrelationModels () const override final
	print available/implemented correlation models
virtual const CP::SystematicSet &	appliedSystematics () const override final
	returns: the currently applied systematics
virtual int	systUncorrVariationIndex (const xAOD::Electron &inputObject) const override final
int	systUncorrVariationIndex (columnar::ElectronId inputObject) const
StatusCode	registerSystematics ()
int	currentSimplifiedUncorrSystRegion (const double cluster_eta, const double et) const
int	currentUncorrSystRegion (const double cluster_eta, const double et) const
StatusCode	InitSystematics ()
	initialize the systematics
virtual StatusCode	getFile (const std::string &recokey, const std::string &idkey, const std::string &isokey, const std::string &trigkey)
	Gets the correction filename from map.
StatusCode	get_simType_from_metadata (PATCore::ParticleDataType::DataType &result) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
bool	m_metadata_retrieved = false
	To check if the metadata can be retrieved.
std::unique_ptr< Root::TElectronEfficiencyCorrectionTool >	m_rootTool = nullptr
	Pointer to the underlying ROOT based tool.
std::unordered_map< CP::SystematicSet, CP::SystematicSet >	m_systFilter
	Systematics filter map.
CP::SystematicSet	m_affectedSys
	Affected systematic, should be done only once.
CP::SystematicSet *	m_appliedSystematics
	Currently applied systematics.
std::string	m_correlation_model_name
int	m_correlation_model
std::string	m_mapFile
std::string	m_recoKey
std::string	m_idKey
std::string	m_isoKey
std::string	m_trigKey
std::vector< std::string >	m_corrFileNameList
	The list of file names.
std::string	m_resultPrefix
	The prefix string for the result.
std::string	m_resultName
	The string for the result.
std::string	m_sysSubstring
std::string	m_eventInfoCollectionName
	The Event info collection name.
bool	m_useRandomRunNumber
int	m_defaultRandomRunNumber
PATCore::ParticleDataType::DataType	m_dataType
int	m_dataTypeOverwrite
	Force the data type to a given value.
int	m_number_of_toys
int	m_seed_toys
double	m_scale_toys
int	m_nCorrSyst
int	m_nUncorrSyst
std::vector< std::pair< float, std::vector< float > > >	m_pteta_bins
std::vector< float >	m_uncorrSimplfEtaBinsUser
std::vector< float >	m_uncorrSimplfEtBinsUser
TH2F *	m_UncorrRegions
int	m_nSimpleUncorrSyst
std::string	m_toysBasename
std::vector< CP::SystematicVariation >	m_corrVarUp
std::vector< CP::SystematicVariation >	m_corrVarDown
std::vector< CP::SystematicVariation >	m_uncorrVarUp
std::vector< CP::SystematicVariation >	m_uncorrVarDown
MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store.
MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store.
bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file.
bool	m_useIncidents
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 41 of file AsgElectronEfficiencyCorrectionTool.h.

Member Typedef Documentation

MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

affectingSystematics()

CP::SystematicSet AsgElectronEfficiencyCorrectionTool::affectingSystematics ( ) const

finaloverrideprivatevirtual

returns: the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 572 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  return m_affectedSys;
}

appliedSystematics()

virtual const CP::SystematicSet & AsgElectronEfficiencyCorrectionTool::appliedSystematics ( ) const

inlinefinaloverrideprivatevirtual

returns: the currently applied systematics

Implements IAsgElectronEfficiencyCorrectionTool.

Definition at line 115 of file AsgElectronEfficiencyCorrectionTool.h.

  {
    return *m_appliedSystematics;
  }

applyEfficiencyScaleFactor()

CP::CorrectionCode AsgElectronEfficiencyCorrectionTool::applyEfficiencyScaleFactor ( const xAOD::Electron & inputObject ) const

finaloverrideprivatevirtual

Implements IAsgElectronEfficiencyCorrectionTool.

Definition at line 539 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  double efficiencyScaleFactor = 1.0;
  CP::CorrectionCode result =
    getEfficiencyScaleFactor(inputObject, efficiencyScaleFactor);
  const static SG::AuxElement::Decorator<float> dec(m_resultPrefix +
                                                    m_resultName + "SF");
  dec(inputObject) = efficiencyScaleFactor;
  return result;
}

applySystematicVariation()

StatusCode AsgElectronEfficiencyCorrectionTool::applySystematicVariation ( const CP::SystematicSet & systConfig )

finaloverrideprivatevirtual

Configure this tool for the given systematics.

Apply one variation at a time.

Implements CP::ISystematicsTool.

Definition at line 598 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  // First, check if this configuration exists in the filtered map/registy
  auto itr = m_systFilter.find(systConfig);
 
  if (itr != m_systFilter.end()) {
    CP::SystematicSet& mySysConf = itr->second;
    m_appliedSystematics = &mySysConf;
  }
  // if not, we should register it, after it passes sanity checks
  else {
    // If it's a new input set, we need to filter it
    CP::SystematicSet affectingSys = affectingSystematics();
    CP::SystematicSet filteredSys;
    if (!CP::SystematicSet::filterForAffectingSystematics(
          systConfig, affectingSys, filteredSys)) {
      ATH_MSG_ERROR(
        "Unsupported combination of systematic variations passed to the tool!");
      return StatusCode::FAILURE;
    }
    // Does filtered make sense,  only one per time
    if (filteredSys.size() > 1) {
      ATH_MSG_ERROR(
        "More than one systematic variation passed at the same time");
      return StatusCode::FAILURE;
    }
 
    if (filteredSys.empty() && !systConfig.empty()) {
      ATH_MSG_DEBUG("systematics : ");
      for (const auto& syst : systConfig) {
        ATH_MSG_DEBUG(syst.name());
      }
      ATH_MSG_DEBUG(" Not supported ");
    }
    // insert to the registy
    itr = m_systFilter.insert(std::make_pair(systConfig, filteredSys)).first;
    // And return directly
    CP::SystematicSet& mySysConf = itr->second;
    m_appliedSystematics = &mySysConf;
  }
  return StatusCode::SUCCESS;
}

beginEvent()

StatusCode AsgElectronEfficiencyCorrectionTool::beginEvent ( )

finaloverrideprivatevirtual

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

Reimplemented from asg::AsgMetadataTool.

Definition at line 933 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
 
  if (m_dataTypeOverwrite != -1)
    return StatusCode::SUCCESS;
  if (m_metadata_retrieved)
    return StatusCode::SUCCESS;
 
  m_metadata_retrieved = true;
  return StatusCode::SUCCESS;
}

beginInputFile()

StatusCode AsgElectronEfficiencyCorrectionTool::beginInputFile ( )

finaloverrideprivatevirtual

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented from asg::AsgMetadataTool.

Definition at line 898 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
 
  // User forced a particular dataType
  if (m_dataTypeOverwrite != -1)
    return StatusCode::SUCCESS;
 
  PATCore::ParticleDataType::DataType dataType_metadata;
  const StatusCode status = get_simType_from_metadata(dataType_metadata);
  // Metadata got retrieved
  if (status == StatusCode::SUCCESS) {
    m_metadata_retrieved = true;
    ATH_MSG_DEBUG("metadata from new file: "
                  << (dataType_metadata == PATCore::ParticleDataType::Data
                        ? "data"
                        : (dataType_metadata == PATCore::ParticleDataType::Full
                             ? "full simulation"
                             : "fast simulation")));
 
    if (dataType_metadata != PATCore::ParticleDataType::Data) {
      if (m_dataTypeOverwrite == -1) {
        m_dataType = dataType_metadata;
      } else {
        ATH_MSG_DEBUG(
          "Applying SF corrections to data while they make sense only for MC");
      }
    }
  } else { // not able to retrieve metadata
    m_metadata_retrieved = false;
    ATH_MSG_DEBUG("not able to retrieve metadata");
  }
  return StatusCode::SUCCESS;
}

callEvents()

void AsgElectronEfficiencyCorrectionTool::callEvents ( columnar::EventContextRange events ) const

override

Definition at line 1026 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  const Accessors& acc = *m_accessors;
  for (columnar::EventContextId event : events)
  {
    auto eventInfo = acc.m_eventInfo(event);
    callSingleEvent (acc.m_electrons(event), eventInfo);
  }
}

callSingleEvent()

void AsgElectronEfficiencyCorrectionTool::callSingleEvent	(	columnar::ElectronRange	electrons,
		columnar::EventInfoId	event ) const

Definition at line 1004 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  const Accessors& acc = *m_accessors;
  for (columnar::ElectronId electron : electrons)
  {
    double sf = 0;
    switch (getEfficiencyScaleFactor(electron, sf, event).code())
    {
      case CP::CorrectionCode::Ok:
        acc.m_sfDec(electron) = sf;
        acc.m_validDec(electron) = true;
        break;
      case CP::CorrectionCode::OutOfValidityRange:
        acc.m_sfDec(electron) = sf;
        acc.m_validDec(electron) = false;
        break;
      default:
        throw std::runtime_error("Error in getEfficiencyScaleFactor");
    }
  }
}

currentSimplifiedUncorrSystRegion()

int AsgElectronEfficiencyCorrectionTool::currentSimplifiedUncorrSystRegion ( const double cluster_eta, const double et ) const

private

Definition at line 716 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  int ptbin = std::as_const(*m_UncorrRegions).GetXaxis()->FindBin(et) - 1;
  if (ptbin < 0 ||
      ptbin >= std::as_const(*m_UncorrRegions).GetXaxis()->GetNbins()) {
    ATH_MSG_WARNING(
      " Found electron with Et = "
      << et / 1000. << " GeV, where you specified boundaries of ["
      << std::as_const(*m_UncorrRegions).GetXaxis()->GetBinLowEdge(1) << ","
      << std::as_const(*m_UncorrRegions)
           .GetXaxis()
           ->GetBinUpEdge(
             std::as_const(*m_UncorrRegions).GetXaxis()->GetNbins())
      << "] for the SIMPLIFIED correlation model ");
    return -1;
  }
  int etabin =
    std::as_const(*m_UncorrRegions).GetYaxis()->FindBin(std::abs(cluster_eta)) -
    1;
  if (etabin < 0 ||
      etabin >= std::as_const(*m_UncorrRegions).GetYaxis()->GetNbins()) {
    ATH_MSG_WARNING(
      " Found electron with |eta| = "
      << std::abs(cluster_eta) << ", where you specified boundaries of ["
      << std::as_const(*m_UncorrRegions).GetYaxis()->GetBinLowEdge(1) << ","
      << std::as_const(*m_UncorrRegions)
           .GetYaxis()
           ->GetBinUpEdge(
             std::as_const(*m_UncorrRegions).GetYaxis()->GetNbins())
      << "] for the SIMPLIFIED correlation model ");
    return -1;
  }
  int reg = ((etabin)*m_UncorrRegions->GetNbinsX() + ptbin);
  return reg;
}

currentUncorrSystRegion()

int AsgElectronEfficiencyCorrectionTool::currentUncorrSystRegion ( const double cluster_eta, const double et ) const

private

Definition at line 755 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  int etabin = 0;
  int reg = 0;
  bool found = false;
  float cluster_eta_electron = 0;
  auto itr_ptBEGIN = m_pteta_bins.begin();
  auto itr_ptEND = m_pteta_bins.end();
  for (; itr_ptBEGIN != itr_ptEND; ++itr_ptBEGIN) {
    auto itr_ptBEGINplusOne = itr_ptBEGIN;
    ++itr_ptBEGINplusOne;
    // Find the pt bin : Larger or equal from the current and the next one is
    // the last or the next one is larger.
    if (et >= itr_ptBEGIN->first &&
        (itr_ptBEGINplusOne == itr_ptEND || et < itr_ptBEGINplusOne->first)) {
      if ((itr_ptBEGIN->second).at(0) >= 0) {
        cluster_eta_electron = std::abs(cluster_eta);
      } else {
        cluster_eta_electron = (cluster_eta);
      };
      for (unsigned int etab = 0; etab < ((itr_ptBEGIN->second).size());
           ++etab) {
        unsigned int etabnext = etab + 1;
        // Find the eta bin : Larger or equal from the current and the next one
        // is the last or the next one is larger:.
        if ((cluster_eta_electron) >= (itr_ptBEGIN->second).at(etab) &&
            (etabnext == itr_ptBEGIN->second.size() ||
             cluster_eta_electron < itr_ptBEGIN->second.at(etabnext))) {
          found = true;
          break;
        }
        // We did not find it. Increment eta and continue looking
        etabin++;
      }
    }
    if (found) {
      break;
    }
    // Add the full size of the "passed" eta row
    reg += (itr_ptBEGIN->second).size();
  }
  if (!found) {
    ATH_MSG_WARNING("No index for the uncorrelated systematic was found, "
                    "returning the maximum index");
    return m_nCorrSyst;
  }
  reg = reg + etabin;
  return reg;
}

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

endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 193 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      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; }

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

get_simType_from_metadata()

StatusCode AsgElectronEfficiencyCorrectionTool::get_simType_from_metadata ( PATCore::ParticleDataType::DataType & result ) const

private

Definition at line 946 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
 
#ifndef XAOD_STANDALONE
  // Determine MC/Data
  std::string dataType("");
  if ((AthAnalysisHelper::retrieveMetadata(
         "/TagInfo", "project_name", dataType, inputMetaStore()))
        .isSuccess()) {
    if (!(dataType == "IS_SIMULATION")) {
      result = PATCore::ParticleDataType::Data;
      ATH_MSG_DEBUG("Running on data");
      return StatusCode::SUCCESS;
    }
    // Determine Fast/FullSim
    if (dataType == "IS_SIMULATION") {
      std::string simType("");
      ATH_CHECK(AthAnalysisHelper::retrieveMetadata("/Simulation/Parameters",
                                                    "SimulationFlavour",
                                                    simType,
                                                    inputMetaStore()));
      std::transform(simType.begin(), simType.end(), simType.begin(), ::toupper);
      result = (simType.find("ATLFAST") == std::string::npos)
                 ? PATCore::ParticleDataType::Full
                 : PATCore::ParticleDataType::Fast;
      return StatusCode::SUCCESS;
    }
  }
#endif
  // Here's how things will work dual use, when file metadata is available in
  // files
  if (inputMetaStore()->contains<xAOD::FileMetaData>("FileMetaData")) {
    const xAOD::FileMetaData* fmd = nullptr;
    ATH_CHECK(inputMetaStore()->retrieve(fmd, "FileMetaData"));
 
    std::string simType("");
    const bool s = fmd->value(xAOD::FileMetaData::simFlavour, simType);
    if (!s) {
      ATH_MSG_DEBUG("no sim flavour from metadata: must be data");
      result = PATCore::ParticleDataType::Data;
      return StatusCode::SUCCESS;
    } else {
      ATH_MSG_DEBUG("sim type = " + simType);
       std::transform(simType.begin(), simType.end(), simType.begin(), ::toupper);
      result = (simType.find("ATLFAST") == std::string::npos)
                 ? PATCore::ParticleDataType::Full
                 : PATCore::ParticleDataType::Fast;
      return StatusCode::SUCCESS;
    }
  } else { // no metadata in the file
    ATH_MSG_DEBUG("no metadata found in the file");
    return StatusCode::FAILURE;
  }
}

getEfficiencyScaleFactor() [1/3]

CP::CorrectionCode AsgElectronEfficiencyCorrectionTool::getEfficiencyScaleFactor ( columnar::ElectronId inputObject, double & efficiencyScaleFactor, columnar::EventInfoId info ) const

private

Definition at line 347 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  const Accessors& acc = *m_accessors;
 
  efficiencyScaleFactor = 1;
  // Retrieve the proper random Run Number
  unsigned int runNumber = m_defaultRandomRunNumber;
  if (m_useRandomRunNumber) {
    if (!acc.randomrunnumber.isAvailable(eventInfo)) {
      ATH_MSG_WARNING(
        "Pileup tool not run before using ElectronEfficiencyTool! SFs do not "
        "reflect PU distribution in data");
      return CP::CorrectionCode::Error;
    }
    runNumber = acc.randomrunnumber(eventInfo);
  }
  //
  // Get the result
  //
  double cluster_eta(-9999.9);
 
  auto cluster = acc.caloClusterAcc (inputObject) [0].value();
 
  // we need to use different variables for central and forward electrons
  if (acc.accAuthor.isAvailable(inputObject) &&
      acc.accAuthor(inputObject) == xAOD::EgammaParameters::AuthorFwdElectron) {
    cluster_eta = acc.clusterEtaAcc (cluster);
  } else {
    cluster_eta = acc.clusterEtaBEAcc (cluster, 2);
  }
 
  // use et from cluster because it is immutable under syst variations of
  // electron energy scale
  const double energy = acc.clusterEAcc(cluster);
  const double parEta = acc.m_eta(inputObject);
  const double coshEta = std::cosh(parEta);
  double et = (coshEta != 0.) ? energy / coshEta : 0.;
  // allow for a 5% margin at the lowest pT bin boundary (i.e. increase et by 5%
  // for sub-threshold electrons). This assures that electrons that pass the
  // threshold only under syst variations of energy get a scale factor assigned.
  auto itr_pt = m_pteta_bins.begin();
  if (itr_pt != m_pteta_bins.end() && et < itr_pt->first) {
    et = et * 1.05;
  }
  return getEfficiencyScaleFactor(et, cluster_eta, runNumber,
                                  efficiencyScaleFactor);
}

getEfficiencyScaleFactor() [2/3]

CP::CorrectionCode AsgElectronEfficiencyCorrectionTool::getEfficiencyScaleFactor ( const double et, const double cluster_eta, const unsigned int runNumber, double & efficiencyScaleFactor ) const

finaloverrideprivatevirtual

Implements IAsgElectronEfficiencyCorrectionTool.

Definition at line 399 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  // We pass only one variation per time
  // The applied systematic is always one systematic.
  // Either is relevant and acquires a value
  // or stays 0.
  double sys(0);
 
  // Let's try to figure already what we are to do
  bool doSFOnly = appliedSystematics().empty();
  bool doToys = (m_correlation_model == correlationModel::MCTOYS ||
                 m_correlation_model == correlationModel::COMBMCTOYS);
  bool isTotal = (m_correlation_model == correlationModel::TOTAL);
  bool isFull = (m_correlation_model == correlationModel::FULL);
  bool isSimplified = (m_correlation_model == correlationModel::SIMPLIFIED);
 
  // Lets see if we have an uncorrelated syst variation passed
  int unCorrSign = 0;
  // or a correlated one
  int indexCorrelated = -999;
  int correlatedSign = 0;
  if (!(doSFOnly || doToys || isTotal) && (isFull || isSimplified)) {
    const auto& sysName = appliedSystematics().begin()->name();
    bool isUncorr = (sysName.find("UncorrUnc") != std::string::npos);
    int currentUncorReg = -999;
    if (isUncorr) {
      // Can we find an uncorrelated region?
      if (isFull) {
        currentUncorReg = currentUncorrSystRegion(cluster_eta, et);
      } else if (isSimplified) {
        currentUncorReg = currentSimplifiedUncorrSystRegion(cluster_eta, et);
      }
      if (currentUncorReg < 0) {
        return CP::CorrectionCode::OutOfValidityRange;
      }
      // And  use it to if we got the "right" syst variation
      if (appliedSystematics().matchSystematic(
              m_uncorrVarDown[currentUncorReg])) {
        unCorrSign = -1;
      } else if (appliedSystematics().matchSystematic(
                     m_uncorrVarUp[currentUncorReg])) {
        unCorrSign = 1;
      }
    } else if (m_nCorrSyst != 0) {//if we have 0 we do not care ...
      if (sysName.find("CorrUnc") != std::string::npos) {
        // given the name convention we
        const auto varNumEnd = sysName.rfind("__");
        const auto varNumBegin = sysName.rfind("NP") + 2;
        const int varIndex =
            std::stoi(sysName.substr(varNumBegin, (varNumEnd - varNumBegin)));
        if (appliedSystematics().matchSystematic(m_corrVarUp[varIndex])) {
          indexCorrelated = varIndex;
          correlatedSign = 1;
        } else if (appliedSystematics().matchSystematic(
                       m_corrVarDown[varIndex])) {
          indexCorrelated = varIndex;
          correlatedSign = -1;
        }
      }  // find CorrUncertainty in name
    } // not Uncorr and we have CorrSyst
  } // Not (SF or toys or total)
 
  // Now lets do the call
  // For now we more or less calculate on demand only
  // the Correlated and the toys we can see if we want
  // top opt also the "TOTAL"
  Root::TElectronEfficiencyCorrectionTool::Result result;
  const int status =
      m_rootTool->calculate(m_dataType, runNumber, cluster_eta, et, /* in MeV */
                            result, isTotal);
 
  // if status 0 something went wrong
  if (!status) {
    efficiencyScaleFactor = 1;
    return CP::CorrectionCode::OutOfValidityRange;
  }
  // At this point we have the SF
  efficiencyScaleFactor = result.SF;
  //And if all we need we can return
  if (doSFOnly) {
    return CP::CorrectionCode::Ok;
  }
 
  // First the logic if the user requested toys
  if (doToys) {
    auto toy = appliedSystematics().getToyVariationByBaseName(m_toysBasename);
    toy.second = m_scale_toys;
    sys = result.toys[toy.first - 1] * m_scale_toys;
    // return here for Toy variations
    efficiencyScaleFactor = sys;
    return CP::CorrectionCode::Ok;
  }
  // The "TOTAL" single uncertainty uncorrelated+correlated
  else if (isTotal) {
    sys = result.Total;
    if (appliedSystematics().matchSystematic(m_uncorrVarUp[0])) {
      return HelperFunc(efficiencyScaleFactor, sys);
    }
    if (appliedSystematics().matchSystematic(m_uncorrVarDown[0])) {
      return HelperFunc(efficiencyScaleFactor, -1 * sys);
    }
  }
  // Then the uncorrelated part for the SiMPLIFIED/FULL models
  else if (unCorrSign!=0) {
    sys = unCorrSign * result.UnCorr;
    return HelperFunc(efficiencyScaleFactor, sys);
  }
 
  // If we reach this point
  // it means we need to do the correlated part
  // for the FULL/SIMPLIFIED models.
  // First if there are not correlated systematic
  if (m_nCorrSyst == 0) {
 
    if (appliedSystematics().matchSystematic(m_corrVarUp[0])) {
      sys = std::sqrt(result.Total * result.Total -
                      result.UnCorr * result.UnCorr);  // total
                                                       // -stat
      return HelperFunc(efficiencyScaleFactor, sys);
    }
    if (appliedSystematics().matchSystematic(m_corrVarDown[0])) {
      sys = -1 * std::sqrt(result.Total * result.Total -
                           result.UnCorr * result.UnCorr);  // total
                                                            // -stat
      return HelperFunc(efficiencyScaleFactor, sys);
    }
  }
 //or if we had
 if (correlatedSign != 0) {
    sys = correlatedSign * result.Corr[indexCorrelated];
    return HelperFunc(efficiencyScaleFactor, sys);
  }
  return CP::CorrectionCode::Ok;
}

getEfficiencyScaleFactor() [3/3]

CP::CorrectionCode AsgElectronEfficiencyCorrectionTool::getEfficiencyScaleFactor ( const xAOD::Electron & inputObject, double & efficiencyScaleFactor ) const

finaloverrideprivatevirtual

Implements IAsgElectronEfficiencyCorrectionTool.

Definition at line 334 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  const xAOD::EventInfo* eventInfo = nullptr;
  if (evtStore()->retrieve(eventInfo, m_eventInfoCollectionName).isFailure()) {
    ATH_MSG_ERROR("Could not retrieve EventInfo object!");
    return CP::CorrectionCode::Error;
  }
  return getEfficiencyScaleFactor(columnar::ElectronId(inputObject), efficiencyScaleFactor, columnar::EventInfoId (*eventInfo));
}

getFile()

StatusCode AsgElectronEfficiencyCorrectionTool::getFile ( const std::string & recokey, const std::string & idkey, const std::string & isokey, const std::string & trigkey )

privatevirtual

Gets the correction filename from map.

Definition at line 845 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
 
  std::string mapFileName = PathResolverFindCalibFile(m_mapFile);
  std::string key =
    ElRecomFileHelpers::convertToOneKey(recokey, idkey, isokey, trigkey);
  std::string value = ElRecomFileHelpers::getValueByKey(mapFileName, key);
 
  if (!value.empty()) {
    m_corrFileNameList.push_back(value);
  } else {
    if (mapFileName.empty()) {
      ATH_MSG_ERROR(
        "Map file does not exist, Please set the path and version properly..");
    } else {
      ATH_MSG_ERROR(
        "Key "
        << key
        << " does not exist in the map file, Please configure it properly..");
    }
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Full File Name is " + value);
  return StatusCode::SUCCESS;
}

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
   }

getNumberOfToys()

virtual int AsgElectronEfficiencyCorrectionTool::getNumberOfToys ( ) const

inlinefinaloverrideprivatevirtual

Implements IAsgElectronEfficiencyCorrectionTool.

Definition at line 97 of file AsgElectronEfficiencyCorrectionTool.h.

  {
    return m_number_of_toys;
  };

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 135 of file AsgMetadataTool.cxx.

                                                     {
 
      // Tell the user what's happening:
      ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
 
      // Call the appropriate member function:
      if( inc.type() == IncidentType::BeginInputFile ) {
        m_beginInputFileCalled = true;
        if( beginInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call beginInputFile()" );
          throw std::runtime_error( "Couldn't call beginInputFile()" );
         }
      } else if( inc.type() == IncidentType::EndInputFile ) {
        if( endInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call endInputFile()" );
          throw std::runtime_error( "Couldn't call endInputFile()" );
         }
      } else if( inc.type() == IncidentType::BeginEvent ) {
         // If the tool didn't catch the begin input file incident for the
         // first input file of the job, then call the appropriate function
         // now.
         if( ! m_beginInputFileCalled ) {
            m_beginInputFileCalled = true;
            if( beginInputFile().isFailure() ) {
               ATH_MSG_FATAL( "Failed to call beginInputFile()" );
               throw std::runtime_error( "Couldn't call beginInputFile()" );
            }
         }
         if( beginEvent().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call beginEvent()" );
            throw std::runtime_error( "Couldn't call beginEvent()" );
         }
 
     #ifdef XAOD_STANDALONE
      } else if( inc.type() == IncidentType::MetaDataStop ) {
         if( metaDataStop().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call metaDataStop()" );
            throw std::runtime_error( "Couldn't call metaDataStop()" );
         }
         
     #endif // XAOD_STANDALONE
      } else {
         ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
      }
 
      return;
   }

initialize()

StatusCode AsgElectronEfficiencyCorrectionTool::initialize ( void )

finaloverrideprivatevirtual

Gaudi Service Interface method implementations.

Reimplemented from asg::AsgTool.

Definition at line 150 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  // Forward the message level
  m_rootTool->msg().setLevel(this->msg().level());
 
  if (m_corrFileNameList.empty() && m_recoKey.empty() && m_idKey.empty() &&
      m_trigKey.empty() && m_isoKey.empty()) {
    ATH_MSG_ERROR("CorrectionFileNameList as well as SFKeys are empty! Please "
                  "configure it properly...");
    return StatusCode::FAILURE;
  }
  /*
   * When metadata are available
   * m_dataType will be whatever the metadata says i.e Full or Fast
   * Its default value is Full.
   * The user can overwrite all these ,using a flag,
   * and force a specific dataType
   */
  if (m_dataTypeOverwrite != -1) {
    if (m_dataTypeOverwrite !=
          static_cast<int>(PATCore::ParticleDataType::Full) &&
        m_dataTypeOverwrite !=
          static_cast<int>(PATCore::ParticleDataType::Fast)) {
      ATH_MSG_ERROR("Unsupported Particle Data Type Overwrite"
                    << m_dataTypeOverwrite);
      return StatusCode::FAILURE;
    }
    m_dataType =
      static_cast<PATCore::ParticleDataType::DataType>(m_dataTypeOverwrite);
  }
  // Find the relevant input files
  // Fill the vector with filename using keys if the user
  // has not passed the full filename as a property
  if (m_corrFileNameList.empty()) {
    if (getFile(m_recoKey, m_idKey, m_isoKey, m_trigKey).isFailure()) {
      ATH_MSG_ERROR("No Root file input specified, and not available map file");
      return StatusCode::FAILURE;
    }
  }
  // Resolve the paths to the input files for the full Geant4 simualtion
  // corrections
  for (auto& ifile : m_corrFileNameList) {
 
    std::string filename = PathResolverFindCalibFile(ifile);
    if (filename.empty()) {
      ATH_MSG_ERROR("Could NOT resolve file name " << ifile);
      return StatusCode::FAILURE;
    } else {
      ATH_MSG_DEBUG(" Path found = " << filename);
    }
    m_rootTool->addFileName(filename);
    // Determine the systematics substring according to the name of the input
    // file
    if (ifile.find("efficiencySF.") != std::string::npos) {
      m_sysSubstring = "Trigger_";
    }
    if (ifile.find("efficiencySF.offline") != std::string::npos) {
      m_sysSubstring = "ID_";
    }
    if (ifile.find("efficiencySF.offline.RecoTrk") != std::string::npos) {
      m_sysSubstring = "Reco_";
    }
    if (ifile.find("efficiencySF.offline.Fwd") != std::string::npos) {
      m_sysSubstring = "FwdID_";
    }
    if (ifile.find("efficiencySF.Isolation") != std::string::npos) {
      m_sysSubstring = "Iso_";
    }
    if (ifile.find("efficiency.") != std::string::npos) {
      m_sysSubstring = "TriggerEff_";
    }
    if (ifile.find("efficiencySF.ChargeID") != std::string::npos) {
      m_sysSubstring = "ChargeIDSel_";
    }
    if (m_sysSubstring.empty()) {
      ATH_MSG_ERROR("Could NOT find systematics Substring file name "
                    << m_sysSubstring);
      return StatusCode::FAILURE;
    }
  }
  //
  // Find the proper correlation Model
  if (m_correlation_model_name == "COMBMCTOYS") {
    m_correlation_model = correlationModel::COMBMCTOYS;
  } else if (m_correlation_model_name == "MCTOYS") {
    m_correlation_model = correlationModel::MCTOYS;
  } else if (m_correlation_model_name == "FULL") {
    m_correlation_model = correlationModel::FULL;
  } else if (m_correlation_model_name == "SIMPLIFIED") {
    m_correlation_model = correlationModel::SIMPLIFIED;
    // a few checks on the binning that the user might have specified
    if (m_uncorrSimplfEtaBinsUser.empty() || m_uncorrSimplfEtBinsUser.empty() ||
        m_uncorrSimplfEtBinsUser.size() < 2 ||
        m_uncorrSimplfEtaBinsUser.size() < 2) {
      ATH_MSG_ERROR("Something went wrong when specifying bins for the "
                    "SIMPLIFIED correlation model ");
      return StatusCode::FAILURE;
    }
  } else if (m_correlation_model_name == "TOTAL") {
    m_correlation_model = correlationModel::TOTAL;
  } else if (m_correlation_model_name == "SYST") {
    m_correlation_model = correlationModel::SYST;
  } else {
    ATH_MSG_ERROR("Unknown correlation model " + m_correlation_model_name);
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("Correlation model: " + m_correlation_model_name
                << " Enum " << m_correlation_model);
 
  // Histogram of simplified uncorrelated regions
  if (m_correlation_model == correlationModel::SIMPLIFIED) {
    m_UncorrRegions = new TH2F("UncorrRegions",
                               "UncorrRegions",
                               m_uncorrSimplfEtBinsUser.size() - 1,
                               &(m_uncorrSimplfEtBinsUser[0]),
                               m_uncorrSimplfEtaBinsUser.size() - 1,
                               &(m_uncorrSimplfEtaBinsUser[0]));
    m_UncorrRegions->SetDirectory(nullptr);
 
    // bins not entries here
    m_nSimpleUncorrSyst = (m_uncorrSimplfEtaBinsUser.size() - 1) *
                          (m_uncorrSimplfEtBinsUser.size() - 1);
  }
  // Finish the preaparation of the underlying tool
  if (m_seed_toys != 0) {
    m_rootTool->setSeed(m_seed_toys);
  }
  //
  if (m_correlation_model == correlationModel::COMBMCTOYS) {
    m_rootTool->bookCombToyMCScaleFactors(m_number_of_toys);
  }
  //
  if (m_correlation_model == correlationModel::MCTOYS) {
    m_rootTool->bookToyMCScaleFactors(m_number_of_toys);
  }
  // We need to initialize the underlying ROOT TSelectorTool
  if (0 == m_rootTool->initialize()) {
    ATH_MSG_ERROR(
      "Could not initialize the TElectronEfficiencyCorrectionTool!");
    return StatusCode::FAILURE;
  }
 
  // get Nsyst
  m_nCorrSyst = m_rootTool->getNSyst();
  std::map<float, std::vector<float>> tmp;
  m_nUncorrSyst = m_rootTool->getNbins(tmp);
  // copy over to vector for better access
  for (const auto& i : tmp) {
    m_pteta_bins.emplace_back(i.first, i.second);
  }
 
  // Check if the input contains uncorr/stat necessary
  // to run non-total systematic model
  if (m_correlation_model != correlationModel::TOTAL &&
      m_rootTool->uncorrEmpty(m_dataType) ) {
    ATH_MSG_ERROR("Called correlation model "+m_correlation_model_name+
                  " but input does not contain necessary histograms.");
    return StatusCode::FAILURE;
  }
 
  // Initialize the systematics
  if (InitSystematics() != StatusCode::SUCCESS) {
    ATH_MSG_ERROR("(InitSystematics() != StatusCode::SUCCESS)");
    return StatusCode::FAILURE;
  }
  // Add the recommended systematics to the registry
  if (registerSystematics() != StatusCode::SUCCESS) {
    ATH_MSG_ERROR("(registerSystematics() != StatusCode::SUCCESS)");
    return StatusCode::FAILURE;
  }
  // Configure for nominal systematics
  if (applySystematicVariation(CP::SystematicSet()) != StatusCode::SUCCESS) {
    ATH_MSG_ERROR("Could not configure for nominal settings");
    return StatusCode::FAILURE;
  }
 
  if (m_useRandomRunNumber) {
    resetAccessor (m_accessors->randomrunnumber, *this, "RandomRunNumber");
  }
  ATH_CHECK (initializeColumns());
  return StatusCode::SUCCESS;
}

InitSystematics()

StatusCode AsgElectronEfficiencyCorrectionTool::InitSystematics ( )

private

initialize the systematics

Definition at line 646 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  const std::string prefix = "EL_EFF_" + m_sysSubstring;
  const std::string prefixUncorr = prefix + m_correlation_model_name + "_";
  // Toys
  if (m_correlation_model == correlationModel::COMBMCTOYS) {
    m_toysBasename = prefix + "COMBMCTOY";
    m_affectedSys.insert(
      (CP::SystematicVariation::makeToyEnsemble(m_toysBasename)));
  } else if (m_correlation_model == correlationModel::MCTOYS) {
    m_toysBasename = prefix + "MCTOY";
    m_affectedSys.insert(
      (CP::SystematicVariation::makeToyEnsemble(m_toysBasename)));
    // Correlated for the different models (1 or Full set)
  } else if (m_correlation_model != correlationModel::TOTAL) {
    if (m_nCorrSyst == 0) {
      auto varUp = CP::SystematicVariation(prefix + "CorrUncertainty", 1);
      auto varDown = CP::SystematicVariation(prefix + "CorrUncertainty", -1);
      m_corrVarUp.push_back(varUp);
      m_corrVarDown.push_back(varDown);
      m_affectedSys.insert(varUp);
      m_affectedSys.insert(varDown);
    } else
      for (int i = 0; i < m_nCorrSyst; ++i) {
        auto varUp =
          CP::SystematicVariation(prefix + Form("CorrUncertaintyNP%d", i), 1);
        auto varDown =
          CP::SystematicVariation(prefix + Form("CorrUncertaintyNP%d", i), -1);
        m_corrVarUp.push_back(varUp);
        m_corrVarDown.push_back(varDown);
        m_affectedSys.insert(varUp);
        m_affectedSys.insert(varDown);
      }
  }
  // Different tratement for the uncorrelated per model
  if (m_correlation_model == correlationModel::TOTAL) {
    auto varUp = CP::SystematicVariation(prefixUncorr + "1NPCOR_PLUS_UNCOR", 1);
    auto varDown =
      CP::SystematicVariation(prefixUncorr + "1NPCOR_PLUS_UNCOR", -1);
    m_uncorrVarUp.push_back(varUp);
    m_uncorrVarDown.push_back(varDown);
    m_affectedSys.insert(varUp);
    m_affectedSys.insert(varDown);
  } else if (m_correlation_model == correlationModel::FULL) {
    for (int i = 0; i < m_nUncorrSyst; ++i) {
      auto varUp = CP::SystematicVariation(
        prefixUncorr + Form("UncorrUncertaintyNP%d", i), 1);
      auto varDown = CP::SystematicVariation(
        prefixUncorr + Form("UncorrUncertaintyNP%d", i), -1);
      m_uncorrVarUp.push_back(varUp);
      m_uncorrVarDown.push_back(varDown);
      m_affectedSys.insert(varUp);
      m_affectedSys.insert(varDown);
    }
  } else if (m_correlation_model == correlationModel::SIMPLIFIED) {
    for (int i = 0; i < m_nSimpleUncorrSyst; ++i) {
      auto varUp = CP::SystematicVariation(
        prefixUncorr + Form("UncorrUncertaintyNP%d", i), 1);
      auto varDown = CP::SystematicVariation(
        prefixUncorr + Form("UncorrUncertaintyNP%d", i), -1);
      m_uncorrVarUp.push_back(varUp);
      m_uncorrVarDown.push_back(varDown);
      m_affectedSys.insert(varUp);
      m_affectedSys.insert(varDown);
    }
  }
  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.

inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 93 of file AsgMetadataTool.cxx.

                                                                       {
 
#ifdef XAOD_STANDALONE
      return &m_inputMetaStore;
#else // XAOD_STANDALONE
      return m_inputMetaStore;
#endif // XAOD_STANDALONE
   }

isAffectedBySystematic()

bool AsgElectronEfficiencyCorrectionTool::isAffectedBySystematic ( const CP::SystematicVariation & systematic ) const

finaloverrideprivatevirtual

returns: whether this tool is affected by the given systematis

returns: bool indicating if affected by the variation

Implements CP::ISystematicsTool.

Definition at line 556 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  if (systematic.empty()) {
    return false;
  }
  CP::SystematicSet sys = affectingSystematics();
  if (m_correlation_model == correlationModel::MCTOYS ||
      m_correlation_model == correlationModel::COMBMCTOYS) {
    return (sys.begin()->ensembleContains(systematic));
  } else {
    return (sys.find(systematic) != sys.end());
  }
}

metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 209 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      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.

outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 102 of file AsgMetadataTool.cxx.

                                                                        {
 
#ifdef XAOD_STANDALONE
      return &m_outputMetaStore;
#else // XAOD_STANDALONE
      return m_outputMetaStore;
#endif // XAOD_STANDALONE
   }

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

printCorrelationModels()

virtual void AsgElectronEfficiencyCorrectionTool::printCorrelationModels ( ) const

inlinefinaloverrideprivatevirtual

print available/implemented correlation models

Implements IAsgElectronEfficiencyCorrectionTool.

Definition at line 102 of file AsgElectronEfficiencyCorrectionTool.h.

  {
    ATH_MSG_INFO(
      " Available Correlation Models for the ElectronEfficiencyCorrectionTool");
    ATH_MSG_INFO("FULL");
    ATH_MSG_INFO("SIMPLIFIED");
    ATH_MSG_INFO("MCTOYS");
    ATH_MSG_INFO("SYST");
    ATH_MSG_INFO("COMBMCTOYS");
    ATH_MSG_INFO("TOTAL");
  };

recommendedSystematics()

CP::SystematicSet AsgElectronEfficiencyCorrectionTool::recommendedSystematics ( ) const

finaloverrideprivatevirtual

returns: the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 592 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  return affectingSystematics();
}

registerSystematics()

StatusCode AsgElectronEfficiencyCorrectionTool::registerSystematics ( )

private

Definition at line 579 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  CP::SystematicRegistry& registry = CP::SystematicRegistry::getInstance();
 
  if (registry.registerSystematics(*this) != StatusCode::SUCCESS) {
    ATH_MSG_ERROR(
      "Failed to add systematic to list of recommended systematics.");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

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

setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

   {
      m_useIncidents = flag;
   }

sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 115 of file AsgMetadataTool.cxx.

                                             {
 
#ifndef XAOD_STANDALONE
      if (m_useIncidents) {
         // Connect to the IncidentSvc:
         ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
         ATH_CHECK( incSvc.retrieve() );
 
         // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
         incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
      }
      // Let the base class do its thing:
      ATH_CHECK( AlgTool::sysInitialize() );
 
#endif // not XAOD_STANDALONE
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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.

systUncorrVariationIndex() [1/2]

int AsgElectronEfficiencyCorrectionTool::systUncorrVariationIndex ( columnar::ElectronId inputObject ) const

private

Definition at line 815 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  const Accessors& acc = *m_accessors;
  int currentSystRegion = -999;
  double cluster_eta(-9999.9);
  double et(0.0);
 
  et = acc.m_pt(inputObject);
  const auto cluster = acc.caloClusterAcc (inputObject) [0].value();
  cluster_eta = acc.clusterEtaBEAcc (cluster, 2);
  switch (m_correlation_model) {
    case correlationModel::SIMPLIFIED: {
      currentSystRegion = currentSimplifiedUncorrSystRegion(cluster_eta, et);
      break;
    }
    case correlationModel::FULL: {
      currentSystRegion = currentUncorrSystRegion(cluster_eta, et);
      break;
    }
    default: {
      // not there for the other models
      break;
    }
  }
  return currentSystRegion;
}

systUncorrVariationIndex() [2/2]

int AsgElectronEfficiencyCorrectionTool::systUncorrVariationIndex ( const xAOD::Electron & inputObject ) const

finaloverrideprivatevirtual

Implements IAsgElectronEfficiencyCorrectionTool.

Definition at line 808 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  return systUncorrVariationIndex (columnar::ElectronId (inputObject));
}

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

~AsgElectronEfficiencyCorrectionTool()

AsgElectronEfficiencyCorrectionTool::~AsgElectronEfficiencyCorrectionTool ( )

finaloverrideprivatevirtual

Standard destructor.

Definition at line 142 of file AsgElectronEfficiencyCorrectionTool.cxx.

{
  if (m_UncorrRegions) {
    delete m_UncorrRegions;
  }
}

Member Data Documentation

m_accessors

std::unique_ptr<Accessors> AsgElectronEfficiencyCorrectionTool::m_accessors

Definition at line 256 of file AsgElectronEfficiencyCorrectionTool.h.

m_affectedSys

CP::SystematicSet AsgElectronEfficiencyCorrectionTool::m_affectedSys

private

Affected systematic, should be done only once.

Definition at line 162 of file AsgElectronEfficiencyCorrectionTool.h.

m_appliedSystematics

CP::SystematicSet* AsgElectronEfficiencyCorrectionTool::m_appliedSystematics

private

Currently applied systematics.

Definition at line 165 of file AsgElectronEfficiencyCorrectionTool.h.

m_beginInputFileCalled

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

m_correlation_model

int AsgElectronEfficiencyCorrectionTool::m_correlation_model

private

Definition at line 169 of file AsgElectronEfficiencyCorrectionTool.h.

m_correlation_model_name

std::string AsgElectronEfficiencyCorrectionTool::m_correlation_model_name

private

Definition at line 168 of file AsgElectronEfficiencyCorrectionTool.h.

m_corrFileNameList

std::vector<std::string> AsgElectronEfficiencyCorrectionTool::m_corrFileNameList

private

The list of file names.

Definition at line 181 of file AsgElectronEfficiencyCorrectionTool.h.

m_corrVarDown

std::vector<CP::SystematicVariation> AsgElectronEfficiencyCorrectionTool::m_corrVarDown

private

Definition at line 230 of file AsgElectronEfficiencyCorrectionTool.h.

m_corrVarUp

std::vector<CP::SystematicVariation> AsgElectronEfficiencyCorrectionTool::m_corrVarUp

private

Definition at line 229 of file AsgElectronEfficiencyCorrectionTool.h.

m_dataType

PATCore::ParticleDataType::DataType AsgElectronEfficiencyCorrectionTool::m_dataType

private

Definition at line 200 of file AsgElectronEfficiencyCorrectionTool.h.

m_dataTypeOverwrite

int AsgElectronEfficiencyCorrectionTool::m_dataTypeOverwrite

private

Force the data type to a given value.

Definition at line 203 of file AsgElectronEfficiencyCorrectionTool.h.

m_defaultRandomRunNumber

int AsgElectronEfficiencyCorrectionTool::m_defaultRandomRunNumber

private

Definition at line 197 of file AsgElectronEfficiencyCorrectionTool.h.

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_eventInfoCollectionName

std::string AsgElectronEfficiencyCorrectionTool::m_eventInfoCollectionName

private

The Event info collection name.

Definition at line 193 of file AsgElectronEfficiencyCorrectionTool.h.

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_idKey

std::string AsgElectronEfficiencyCorrectionTool::m_idKey

private

Definition at line 176 of file AsgElectronEfficiencyCorrectionTool.h.

m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

m_isoKey

std::string AsgElectronEfficiencyCorrectionTool::m_isoKey

private

Definition at line 177 of file AsgElectronEfficiencyCorrectionTool.h.

m_mapFile

std::string AsgElectronEfficiencyCorrectionTool::m_mapFile

private

Definition at line 172 of file AsgElectronEfficiencyCorrectionTool.h.

m_metadata_retrieved

bool AsgElectronEfficiencyCorrectionTool::m_metadata_retrieved = false

private

To check if the metadata can be retrieved.

Definition at line 153 of file AsgElectronEfficiencyCorrectionTool.h.

m_nCorrSyst

int AsgElectronEfficiencyCorrectionTool::m_nCorrSyst

private

Definition at line 215 of file AsgElectronEfficiencyCorrectionTool.h.

m_nSimpleUncorrSyst

int AsgElectronEfficiencyCorrectionTool::m_nSimpleUncorrSyst

private

Definition at line 225 of file AsgElectronEfficiencyCorrectionTool.h.

m_number_of_toys

int AsgElectronEfficiencyCorrectionTool::m_number_of_toys

private

Definition at line 206 of file AsgElectronEfficiencyCorrectionTool.h.

m_nUncorrSyst

int AsgElectronEfficiencyCorrectionTool::m_nUncorrSyst

private

Definition at line 216 of file AsgElectronEfficiencyCorrectionTool.h.

m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

m_pteta_bins

std::vector<std::pair<float, std::vector<float> > > AsgElectronEfficiencyCorrectionTool::m_pteta_bins

private

Definition at line 217 of file AsgElectronEfficiencyCorrectionTool.h.

m_recoKey

std::string AsgElectronEfficiencyCorrectionTool::m_recoKey

private

Definition at line 175 of file AsgElectronEfficiencyCorrectionTool.h.

m_resultName

std::string AsgElectronEfficiencyCorrectionTool::m_resultName

private

The string for the result.

Definition at line 187 of file AsgElectronEfficiencyCorrectionTool.h.

m_resultPrefix

std::string AsgElectronEfficiencyCorrectionTool::m_resultPrefix

private

The prefix string for the result.

Definition at line 184 of file AsgElectronEfficiencyCorrectionTool.h.

m_rootTool

std::unique_ptr<Root::TElectronEfficiencyCorrectionTool> AsgElectronEfficiencyCorrectionTool::m_rootTool = nullptr

private

Pointer to the underlying ROOT based tool.

Definition at line 156 of file AsgElectronEfficiencyCorrectionTool.h.

m_scale_toys

double AsgElectronEfficiencyCorrectionTool::m_scale_toys

private

Definition at line 212 of file AsgElectronEfficiencyCorrectionTool.h.

m_seed_toys

int AsgElectronEfficiencyCorrectionTool::m_seed_toys

private

Definition at line 209 of file AsgElectronEfficiencyCorrectionTool.h.

m_sysSubstring

std::string AsgElectronEfficiencyCorrectionTool::m_sysSubstring

private

Definition at line 190 of file AsgElectronEfficiencyCorrectionTool.h.

m_systFilter

std::unordered_map<CP::SystematicSet, CP::SystematicSet> AsgElectronEfficiencyCorrectionTool::m_systFilter

private

Systematics filter map.

Definition at line 159 of file AsgElectronEfficiencyCorrectionTool.h.

m_toysBasename

std::string AsgElectronEfficiencyCorrectionTool::m_toysBasename

private

Definition at line 228 of file AsgElectronEfficiencyCorrectionTool.h.

m_trigKey

std::string AsgElectronEfficiencyCorrectionTool::m_trigKey

private

Definition at line 178 of file AsgElectronEfficiencyCorrectionTool.h.

m_UncorrRegions

TH2F* AsgElectronEfficiencyCorrectionTool::m_UncorrRegions

private

Definition at line 224 of file AsgElectronEfficiencyCorrectionTool.h.

m_uncorrSimplfEtaBinsUser

std::vector<float> AsgElectronEfficiencyCorrectionTool::m_uncorrSimplfEtaBinsUser

private

Definition at line 220 of file AsgElectronEfficiencyCorrectionTool.h.

m_uncorrSimplfEtBinsUser

std::vector<float> AsgElectronEfficiencyCorrectionTool::m_uncorrSimplfEtBinsUser

private

Definition at line 221 of file AsgElectronEfficiencyCorrectionTool.h.

m_uncorrVarDown

std::vector<CP::SystematicVariation> AsgElectronEfficiencyCorrectionTool::m_uncorrVarDown

private

Definition at line 232 of file AsgElectronEfficiencyCorrectionTool.h.

m_uncorrVarUp

std::vector<CP::SystematicVariation> AsgElectronEfficiencyCorrectionTool::m_uncorrVarUp

private

Definition at line 231 of file AsgElectronEfficiencyCorrectionTool.h.

m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.h.

m_useRandomRunNumber

bool AsgElectronEfficiencyCorrectionTool::m_useRandomRunNumber

private

Definition at line 196 of file AsgElectronEfficiencyCorrectionTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

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:

• AsgElectronEfficiencyCorrectionTool.h
• AsgElectronEfficiencyCorrectionTool.cxx