egammaMVACalibTool Class Reference

A tool used by the egammaMVASvc to help calibrate energy for one particle type. More...

#include <egammaMVACalibTool.h>

Inheritance diagram for egammaMVACalibTool:

Collaboration diagram for egammaMVACalibTool:

Public Types
enum	CalibrationType { correctEaccordion, fullCalibration }
	how the output of the BDT is used correctEaccordion: energy = raw energy * BDT fullCalibration: energy = BDT More...
enum	ShiftType { NOSHIFT =0, MEAN10TOTRUE }
	shift to be applied after the BDT. More...

Public Member Functions
	egammaMVACalibTool (const std::string &type)
virtual	~egammaMVACalibTool () override
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...
float	getEnergy (const xAOD::CaloCluster &clus, const xAOD::Egamma *eg) const override final
	returns the calibrated energy More...
virtual void	print () const
	Print the state of the tool. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	setupBDT (const egammaMVAFunctions::funcMap_t &funcLibrary, const std::string &fileName)
	a function called by initialize to setup the BDT, funcs, and shifts. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Static Private Member Functions
static const TString &	getString (TObject *obj)
	a utility to get a TString out of an TObjString pointer More...

Private Attributes
Gaudi::Property< int >	m_particleType
Gaudi::Property< int >	m_shiftType
Gaudi::Property< int >	m_calibrationType
Gaudi::Property< bool >	m_clusterEif0
Gaudi::Property< std::string >	m_folder
	string with folder for weight files More...
Gaudi::Property< bool >	m_useLayerCorrected
std::unique_ptr< TH2Poly >	m_hPoly
	A TH2Poly used to extract bin numbers. Note there is an offset of 1. More...
std::vector< MVAUtils::BDT >	m_BDTs
	Where the BDTs are stored. More...
std::unique_ptr< egammaMVACalibTool_detail::Funcs >	m_funcs
	where the pointers to the funcs to calculate the vars per BDT More...
std::vector< TFormula >	m_shifts
	shifts formulas More...
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

A tool used by the egammaMVASvc to help calibrate energy for one particle type.

The particle type to be calibrated must be specified by the property ParticleType. The property folder must be set with the path to a folder containig three files:

• MVACalib_electron.weights.root
• MVACalib_unconvertedPhoton.weights.root
• MVACalib_convertedPhoton.weights.root

The ROOT files should have in the following content:

• a TH2Poly object named "hPoly". This is used to decide which BDT to use. The x-axis is cluster eta, the y-axis is the raw-accordion-Et in GeV. The BDT that will be used for each event is the one with index equal to the content of the TH2Poly - 1, e.g. const int bin = m_hPoly->FindBin(etaVar, energyVarGeV) - 1. (the minimum value in the TH2Poly is 1)
• several TTree named BDTX where X is an integer index (not padded). X here counts from 0. Each TTree has the weights of a BDT and it is the input to MVAUtils::BDT. Alternatively the TTree can be inside a TObjArray named "trees".
• a TObjArray named "variables" containing many TObjString, each one for each BDT. Each TObjString is a string containing the names of the input variables for each BDT, separated by ";". The names should be understandable by egammaMVAFunctions::initializeElectronFuncs, egammaMVAFunctions::initializeUnconvertedPhotonFuncs, egammaMVAFunctions::initializeConvertedPhotonFuncs.
• a TObjectArray named "shifts" containing many TObjString, each one for each BDT. Each TObjString is a string which represent the formula to compute the shift (used to construct a TFormula). The variables is the Et in GeV after the calibration. The value of the shift is divided by the energy calibrated by the BDT.

On data the property use_layer_corrected should be set to true. In reconstruction this flag is always false. In PhysicsAnalysis it should be set appropriately. When set to true when using the layer energies as input the data-driver-corrected version are used.

Definition at line 71 of file egammaMVACalibTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

CalibrationType

enum egammaMVACalibTool::CalibrationType

how the output of the BDT is used correctEaccordion: energy = raw energy * BDT fullCalibration: energy = BDT

Enumerator
correctEaccordion
fullCalibration

Definition at line 83 of file egammaMVACalibTool.h.

{correctEaccordion, fullCalibration};

ShiftType

enum egammaMVACalibTool::ShiftType

shift to be applied after the BDT.

Only MEAN10TOTRUE and MEAN10TOTRUE are supperted

Enumerator
NOSHIFT
MEAN10TOTRUE

Definition at line 88 of file egammaMVACalibTool.h.

{NOSHIFT=0, MEAN10TOTRUE};

Constructor & Destructor Documentation

egammaMVACalibTool()

egammaMVACalibTool::egammaMVACalibTool

(

const std::string &

type

)

Definition at line 37 of file egammaMVACalibTool.cxx.

                                                            :
  asg::AsgTool(name),
  m_funcs (std::make_unique<egammaMVACalibTool_detail::Funcs>())
{
}

~egammaMVACalibTool()

egammaMVACalibTool::~egammaMVACalibTool ( )

overridevirtual

Definition at line 45 of file egammaMVACalibTool.cxx.

{
}

Member Function Documentation

declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

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

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

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

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

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() [1/2]

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

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 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

getEnergy()

float egammaMVACalibTool::getEnergy ( const xAOD::CaloCluster &  clus, const xAOD::Egamma *  eg  ) const

finaloverridevirtual

returns the calibrated energy

Implements IegammaMVACalibTool.

Definition at line 230 of file egammaMVACalibTool.cxx.

{
 
  ATH_MSG_DEBUG("calling getEnergy with cluster index (" << clus.index());
 
  // find the bin of BDT and the shift
  const auto initEnergy = (m_useLayerCorrected ?
                           egammaMVAFunctions::compute_correctedcl_Eacc(clus) :
                           egammaMVAFunctions::compute_rawcl_Eacc(clus));
 
  const auto etVarGeV = (initEnergy / std::cosh(clus.eta())) / GeV;
  const auto etaVar = std::abs(clus.eta());
 
  ATH_MSG_DEBUG("Looking at object with initEnergy = " << initEnergy
                << ", etVarGeV = " << etVarGeV
                << ", etaVar = " << etaVar
                << ", clus->e() = " << clus.e());
 
  // Normally, we'd just use FindFixBin here.  But TH2Poly overrides FindBin
  // to handle its special bin definitions, but it doesn't also override
  // FindFixBin.  But TH2Poly::FindBin (unlike TH1::FindBin) doesn't actually
  // do anything non-const, so just suppress the warning here.
  TH2Poly* hPoly ATLAS_THREAD_SAFE = m_hPoly.get();
  const int bin = hPoly->FindBin(etaVar, etVarGeV) - 1; // poly bins are shifted by one
 
  ATH_MSG_DEBUG("Using bin: " << bin);
 
  if (bin < 0) {
    ATH_MSG_DEBUG("The bin is under/overflow; just return the energy");
    return clus.e();
  }
 
  if (bin >= static_cast<int>(m_BDTs.size())) {
    ATH_MSG_WARNING("The bin is outside the range, so just return the energy");
    return clus.e();
  }
 
  // select the bdt and functions. (shifts are done later if needed)
  // if there is only one BDT just use that
  const int bin_BDT = m_BDTs.size() != 1 ? bin : 0;
  const auto& bdt = m_BDTs[bin_BDT];
  const auto& funcs = m_funcs->funcs[bin_BDT];
 
  const size_t sz = funcs.size();
 
  // could consider adding std::array support to the BDTs
  std::vector<float> vars(sz);
 
  for (size_t i = 0; i < sz; ++i) {
    vars[i] = funcs[i](eg, &clus);
  }
 
  // evaluate the BDT response
  const float mvaOutput = bdt.GetResponse(vars);
 
  // what to do if the MVA response is 0;
  if (mvaOutput == 0.) {
    if (m_clusterEif0) {
      return clus.e();
    }
    return 0.;
  }
 
  // calculate the unshifted energy
  const auto energy = (m_calibrationType == fullCalibration) ?
    mvaOutput : (initEnergy * mvaOutput);
 
  ATH_MSG_DEBUG("energy after MVA = " << energy);
 
  if (m_shiftType == NOSHIFT) {
    // if no shift, just return the unshifted energy
    return energy;
  }
 
  // have to do a shift if here. It's based on the corrected Et in GeV
  const auto etGeV = (energy / std::cosh(clus.eta())) / GeV;
 
  // evaluate the TFormula associated with the bin
  const auto shift = m_shifts[bin].Eval(etGeV);
  ATH_MSG_DEBUG("shift = " << shift);
  if (shift > 0.5) {
    return energy / shift;
  }
    ATH_MSG_WARNING("Shift value too small: " << shift << "; not applying shift");
    return energy;
 
}

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
   }

getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

getString()

const TString & egammaMVACalibTool::getString ( TObject *  obj )

staticprivate

a utility to get a TString out of an TObjString pointer

Definition at line 221 of file egammaMVACalibTool.cxx.

{
  TObjString *objS = dynamic_cast<TObjString*>(obj);
  if (!objS) {
    throw std::runtime_error("egammaMVACalibTool::getString was passed something that was not a string object");
  }
  return objS->GetString();
}

initialize()

StatusCode egammaMVACalibTool::initialize ( )

overridevirtual

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 50 of file egammaMVACalibTool.cxx.

{
  if (m_particleType == xAOD::EgammaParameters::NumberOfEgammaTypes) {
    ATH_MSG_FATAL("Particle type not set: you have to set property ParticleType to a valid value");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("Initializing with particle " << m_particleType);
 
  if (m_shiftType == MEAN10TOTRUE) {
    ATH_MSG_DEBUG("Using Mean10 shift");
  } else if (m_shiftType == NOSHIFT) {
    ATH_MSG_DEBUG("Not using a shift");
  } else {
    ATH_MSG_FATAL("Unsupported shift: " << m_shiftType);
    return StatusCode::FAILURE;
  }
 
  // get the BDTs and initialize functions
  ATH_MSG_DEBUG("get BDTs in folder: " << m_folder);
  switch (m_particleType) {
  case xAOD::EgammaParameters::electron:
    {
      std::unique_ptr<egammaMVAFunctions::funcMap_t> funcLibraryPtr =
        egammaMVAFunctions::initializeElectronFuncs(m_useLayerCorrected);
      ATH_CHECK(setupBDT(*funcLibraryPtr,
                         PathResolverFindCalibFile(m_folder + "/MVACalib_electron.weights.root")));
    }
    break;
  case xAOD::EgammaParameters::unconvertedPhoton:
    {
      std::unique_ptr<egammaMVAFunctions::funcMap_t> funcLibraryPtr =
        egammaMVAFunctions::initializeUnconvertedPhotonFuncs(m_useLayerCorrected);
      ATH_CHECK(setupBDT(*funcLibraryPtr,
                         PathResolverFindCalibFile(m_folder + "/MVACalib_unconvertedPhoton.weights.root")));
    }
    break;
  case xAOD::EgammaParameters::convertedPhoton:
    {
      std::unique_ptr<egammaMVAFunctions::funcMap_t> funcLibraryPtr =
        egammaMVAFunctions::initializeConvertedPhotonFuncs(m_useLayerCorrected);
      ATH_CHECK(setupBDT(*funcLibraryPtr,
                         PathResolverFindCalibFile(m_folder + "/MVACalib_convertedPhoton.weights.root")));
    }
    break;
  default:
    ATH_MSG_FATAL("Particle type not set properly: " << m_particleType);
    return StatusCode::FAILURE;
  }
 
  // Load these dictionaries now, so we don't need to try to do so
  // while multiple threads are running.
  TClass::GetClass ("TH2Poly");
  TClass::GetClass ("TMultiGraph");
 
  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.

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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 JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, LundVariablesTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

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

renounce()

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

inlineprotectedinherited

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

setupBDT()

StatusCode egammaMVACalibTool::setupBDT ( const egammaMVAFunctions::funcMap_t &  funcLibrary, const std::string &  fileName  )

private

a function called by initialize to setup the BDT, funcs, and shifts.

Definition at line 107 of file egammaMVACalibTool.cxx.

{
  ATH_MSG_DEBUG("Trying to open " << fileName);
 
  std::unique_ptr<TFile> f(TFile::Open(fileName.c_str()));
  if (!f || f->IsZombie()) {
    ATH_MSG_FATAL("Could not open file: " << fileName);
    return StatusCode::FAILURE;
  }
 
  // Load hPoly
  TH2Poly *hPoly = nullptr;
  f->GetObject("hPoly", hPoly);
  if (!hPoly) {
    ATH_MSG_FATAL("Could not find hPoly");
    return StatusCode::FAILURE;
  }
  //pass ownership to class variable
  m_hPoly.reset(static_cast<TH2Poly*>(hPoly));
  m_hPoly->SetDirectory(nullptr);
 
  // Load variables
  TObjArray *variablesTmp = nullptr;
  f->GetObject("variables", variablesTmp);
  if (!variablesTmp) {
    ATH_MSG_FATAL("Could not find variables");
    return StatusCode::FAILURE;
  }
  auto variables = std::unique_ptr<TObjArray>(variablesTmp);
  variables->SetOwner(); // to delete the objects when d-tor is called
 
  // Load shifts
  TObjArray *shiftsTmp = nullptr;
  f->GetObject("shifts", shiftsTmp);
  if (!shiftsTmp) {
    ATH_MSG_FATAL("Could not find shifts");
    return StatusCode::FAILURE;
  }
  auto shifts = std::unique_ptr<TObjArray>(shiftsTmp);
  shifts->SetOwner(); // to delete the objects when d-tor is called
 
  // Load trees
  TObjArray *treesTmp = nullptr;
  std::unique_ptr<TObjArray> trees;
  f->GetObject("trees", treesTmp);
  if (treesTmp) {
    trees = std::unique_ptr<TObjArray>(treesTmp);
    trees->SetOwner(); // to delete the objects when d-tor is called
    ATH_MSG_DEBUG("setupBDT " << "BDTs read from TObjArray");
  } else {
    ATH_MSG_DEBUG("setupBDT " << "Reading trees individually");
    trees = std::make_unique<TObjArray>();
    trees->SetOwner(); // to delete the objects when d-tor is called
    for (int i = 0; i < variables->GetEntries(); ++i)
    {
      TTree *tree = nullptr;
      f->GetObject(Form("BDT%d", i), tree);
      if (tree) tree->SetCacheSize(0);
      trees->AddAtAndExpand(tree, i);
    }
  }
 
  // Ensure the objects have (the same number of) entries
  if (!trees->GetEntries() || !(trees->GetEntries() == variables->GetEntries())) {
    ATH_MSG_FATAL("Tree has size " << trees->GetEntries()
          << " while variables has size " << variables->GetEntries());
    return StatusCode::FAILURE;
  }
 
  // Loop simultaneously over trees, variables and shifts
  // Define the BDTs, the list of variables and the shift for each BDT
  TObjString *str2;
  TObjString *shift;
  TTree *tree;
  TIter nextTree(trees.get());
  TIter nextVariables(variables.get());
  TIter nextShift(shifts.get());
  for (int i=0; (tree = (TTree*) nextTree()) && ((TObjString*) nextVariables()); ++i)
  {
    m_BDTs.emplace_back(tree);
 
    std::vector<std::function<float(const xAOD::Egamma*, const xAOD::CaloCluster*)> > funcs;
    // Loop over variables, which are separated by comma
    char separator_var = ';';
    if (getString(variables->At(i)).Index(";") < 1) separator_var = ','; // old versions
    std::unique_ptr<TObjArray> tokens(getString(variables->At(i)).Tokenize(separator_var));
    TIter nextVar(tokens.get());
    while ((str2 = (TObjString*) nextVar()))
    {
      const TString& varName = getString(str2);
      if (!varName.Length()) {
        ATH_MSG_FATAL("There was an empty variable name!");
        return StatusCode::FAILURE;
      }
      try {
        funcs.push_back(funcLibrary.at(varName.Data()));
      } catch(const std::out_of_range& e) {
        ATH_MSG_FATAL("Could not find formula for variable " << varName << ", error: " << e.what());
        return StatusCode::FAILURE;
      }
    }
    m_funcs->funcs.push_back(std::move(funcs));
 
    if (m_shiftType == MEAN10TOTRUE) {
      shift = (TObjString*) nextShift();
      const TString& shiftFormula = getString(shift);
      m_shifts.emplace_back("", shiftFormula);
    }
  }
  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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 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);
      }
    }
  }

Member Data Documentation

m_BDTs

std::vector<MVAUtils::BDT> egammaMVACalibTool::m_BDTs

private

Where the BDTs are stored.

Definition at line 124 of file egammaMVACalibTool.h.

m_calibrationType

Gaudi::Property<int> egammaMVACalibTool::m_calibrationType

private

Initial value:

{this,
      "CalibrationType", correctEaccordion,
      "What type of calibration to apply"}

Definition at line 103 of file egammaMVACalibTool.h.

m_clusterEif0

Gaudi::Property<bool> egammaMVACalibTool::m_clusterEif0

private

Initial value:

{this,
      "useClusterIf0", true,
      "Use cluster energy if MVA response is 0"}

Definition at line 107 of file egammaMVACalibTool.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_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_folder

Gaudi::Property<std::string> egammaMVACalibTool::m_folder

private

Initial value:

{this,
      "folder", "",
      "string with folder for weight files"}

string with folder for weight files

Definition at line 112 of file egammaMVACalibTool.h.

m_funcs

std::unique_ptr<egammaMVACalibTool_detail::Funcs> egammaMVACalibTool::m_funcs

private

where the pointers to the funcs to calculate the vars per BDT

Definition at line 129 of file egammaMVACalibTool.h.

m_hPoly

std::unique_ptr<TH2Poly> egammaMVACalibTool::m_hPoly

private

A TH2Poly used to extract bin numbers. Note there is an offset of 1.

Definition at line 121 of file egammaMVACalibTool.h.

m_particleType

Gaudi::Property<int> egammaMVACalibTool::m_particleType

private

Initial value:

{this,
      "ParticleType", xAOD::EgammaParameters::NumberOfEgammaTypes,
      "What type of particle do we use"}

Definition at line 95 of file egammaMVACalibTool.h.

m_shifts

std::vector<TFormula> egammaMVACalibTool::m_shifts

private

shifts formulas

Definition at line 132 of file egammaMVACalibTool.h.

m_shiftType

Gaudi::Property<int> egammaMVACalibTool::m_shiftType

private

Initial value:

{this,
      "ShiftType", MEAN10TOTRUE,
      "Shift corrections to apply to value"}

Definition at line 99 of file egammaMVACalibTool.h.

m_useLayerCorrected

Gaudi::Property<bool> egammaMVACalibTool::m_useLayerCorrected

private

Initial value:

{this,
      "use_layer_corrected", false,
      "whether to use layer corrections"}

Definition at line 116 of file egammaMVACalibTool.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:

• egammaMVACalibTool.h
• egammaMVACalibTool.cxx