#include <AsgPhotonBDTSelector.h>

Inheritance diagram for PhotonIDBDT::AsgPhotonBDTSelector:

Collaboration diagram for PhotonIDBDT::AsgPhotonBDTSelector:

Public Member Functions
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual asg::AcceptData	accept (const xAOD::IParticle *part) const override
	accept with pointer to IParticle so as to not hide the IAsgSelectionTool one
virtual asg::AcceptData	accept (const EventContext &ctx, const xAOD::IParticle *part) const override
virtual asg::AcceptData	accept (const EventContext &ctx, const xAOD::Egamma *part) const override
	accept with pointer to Egamma object
virtual asg::AcceptData	accept (const EventContext &ctx, const xAOD::Photon *part) const override
	accept with Photon pointer
virtual asg::AcceptData	accept (const EventContext &ctx, const xAOD::Electron *part) const override
	accept with Electron reference
virtual StatusCode	execute (const EventContext &ctx, const xAOD::Egamma *eg, unsigned int &isEM) const override
	Add a legacy execute method - return isEM value.
virtual std::string	getOperatingPointName () const override
	Report the current operating point.
	AsgTool (const std::string &name)
	Constructor specifying the tool instance's name.
	AsgTool (const AsgTool &)=delete
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	loadConfig ()
asg::AcceptData	acceptBDT (const EventContext &ctx, const xAOD::Photon &ph, unsigned int *isEM=nullptr) const
virtual const asg::AcceptInfo &	getAcceptInfo () const override
	Declare the interface ID for this pure-virtual interface class to the Athena framework.
bool	isConverted (const xAOD::Photon &ph) const
bool	findBin (const float absEta, const float etGeV, size_t &iEta, size_t &iEt) const
float	getCut (const bool converted, const size_t iEta, const size_t iEt) const
float	getShowerShape (const xAOD::Photon &ph, xAOD::EgammaParameters::ShowerShapeType t, const char *name="") const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static asg::AcceptData	makeReject (const asg::AcceptInfo &info)

Private Attributes
Gaudi::Property< std::string >	m_workingPoint {this, "WorkingPoint", "", "Name of the Photon ID BDT Working point"}
Gaudi::Property< bool >	m_excludeTRT {this, "ExcludeTRT", true, "Conversion definition for Run 3"}
Gaudi::Property< bool >	m_reapplyWPIfNoShowerShapes {this, "ReapplyWPIfNoShowerShapes", true, "Reapply the WP calculation, based on the BDT score and isEM word (works only if these are available!) "}
Gaudi::Property< std::string >	m_isEMDecoration {this, "IsEMDecoration", "BDTIsEM", "Name of the int decoration containing the isEM word (used if ReapplyWPIfNoShowerShapes is true)"}
std::string	m_configFile = ""
std::vector< float >	m_etaBins
std::vector< float >	m_etBinsGeV
std::vector< float >	m_cutF1Conv
std::vector< float >	m_cutF1Unconv
std::vector< float >	m_cutE277Conv
std::vector< float >	m_cutE277Unconv
std::vector< float >	m_cutConv
std::vector< float >	m_cutUnconv
asg::AcceptInfo	m_acceptInfo
int	m_cutPosScore {-1}
int	m_cutPosInRange {-1}
int	m_cutPosHasScore {-1}
int	m_cutPosPreF1 {-1}
int	m_cutPosPreE277 {-1}
int	m_cutPosPassPreselection {-1}
SG::ReadHandleKey< xAOD::EgammaContainer >	m_ContainerName { this, "ContainerName", "", "Input" }
SG::ReadDecorHandleKey< xAOD::EgammaContainer >	m_decoratorScore
Gaudi::Property< bool >	m_suppressInputDeps {this, "SuppressInputDependence", false, "Will BDT score be created in the same algorithm that uses this tool?"}
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 57 of file AsgPhotonBDTSelector.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ accept() [1/5]

asg::AcceptData AsgPhotonBDTSelector::accept	(	const EventContext &	ctx,
		const xAOD::Egamma *	part ) const

overridevirtual

accept with pointer to Egamma object

Implements IAsgEGammaIsEMSelector.

Definition at line 175 of file AsgPhotonBDTSelector.cxx.

{
  if (!eg) return makeReject(m_acceptInfo);
 
  const auto* ph = dynamic_cast<const xAOD::Photon*>(eg);
  if (!ph) return makeReject(m_acceptInfo);
 
  return accept(ctx, ph);
}

◆ accept() [2/5]

asg::AcceptData AsgPhotonBDTSelector::accept	(	const EventContext &	ctx,
		const xAOD::Electron *	part ) const

overridevirtual

accept with Electron reference

Implements IAsgEGammaIsEMSelector.

Definition at line 193 of file AsgPhotonBDTSelector.cxx.

{
  // This tool is photon-only
  return makeReject(m_acceptInfo);
}

◆ accept() [3/5]

asg::AcceptData AsgPhotonBDTSelector::accept	(	const EventContext &	ctx,
		const xAOD::IParticle *	part ) const

overridevirtual

Implements IAsgEGammaIsEMSelector.

Definition at line 161 of file AsgPhotonBDTSelector.cxx.

{
  if (!part) return makeReject(m_acceptInfo);
 
  if (const auto* ph = dynamic_cast<const xAOD::Photon*>(part)) {
    return accept(ctx, ph);
  }
  if (const auto* eg = dynamic_cast<const xAOD::Egamma*>(part)) {
    return accept(ctx, eg);
  }
  return makeReject(m_acceptInfo);
}

◆ accept() [4/5]

asg::AcceptData AsgPhotonBDTSelector::accept	(	const EventContext &	ctx,
		const xAOD::Photon *	part ) const

overridevirtual

accept with Photon pointer

Implements IAsgEGammaIsEMSelector.

Definition at line 186 of file AsgPhotonBDTSelector.cxx.

{
  if (!ph) return makeReject(m_acceptInfo);
  return acceptBDT(ctx, *ph, nullptr);
}

◆ accept() [5/5]

asg::AcceptData AsgPhotonBDTSelector::accept ( const xAOD::IParticle * part ) const

overridevirtual

accept with pointer to IParticle so as to not hide the IAsgSelectionTool one

Implements IAsgEGammaIsEMSelector.

Definition at line 156 of file AsgPhotonBDTSelector.cxx.

{
  return accept(Gaudi::Hive::currentContext(), part);
}

◆ acceptBDT()

asg::AcceptData AsgPhotonBDTSelector::acceptBDT	(	const EventContext &	ctx,
		const xAOD::Photon &	ph,
		unsigned int *	isEM = nullptr ) const

private

Definition at line 269 of file AsgPhotonBDTSelector.cxx.

                                                                                                                     {
  // Helper for isEM word
  auto setBit = [&](unsigned int bit) {
    if (isEM) *isEM |= bit;
  };
  // I assume that the photon exists and is valid
 
  // start to retrieve the acceptor
  // Start with all cuts failed 
  asg::AcceptData acc = makeReject(m_acceptInfo);
 
  // Ok now we assume that we have the score
  SG::ReadDecorHandle<xAOD::EgammaContainer, float> decoratorScore{m_decoratorScore, ctx};
  const float score = decoratorScore(ph);
  acc.setCutResult(m_cutPosHasScore, true);
 
  // Now we check the photon kinematics from cluster and the binning
  const xAOD::CaloCluster* cluster = ph.caloCluster();
  if (!cluster) {
    setBit(FailOutOfRange);
    return acc;
  }
  const float absEta = std::abs(cluster->eta());
  const float etGeV  = cluster->pt() * 1e-3f;
 
  size_t iEta=0, iEt=0;
  if (!findBin(absEta, etGeV, iEta, iEt)) {
    setBit(FailOutOfRange); // failOutOfRange
    return acc;
  }
  // If we are here, the photon is in the correct eta range
  acc.setCutResult(m_cutPosInRange, true);
 
  // check if the photon is converted
  const bool conv = isConverted(ph);
 
  // Check F1 and e277 preselection cuts
  bool passF1 = false, passE277 = false, passPre = false;
  // Before trying to access the shower shape variables, we check if they are available. 
  // If not, we can either fail or reapply the WP based on the score and isEM word (if enabled and available)
  if (m_reapplyWPIfNoShowerShapes) {
    float tmp = 0.f;
    const bool hasF1 = ph.showerShapeValue(tmp, xAOD::EgammaParameters::f1);
    const bool hasE277 = ph.showerShapeValue(tmp, xAOD::EgammaParameters::e277);
    if (!hasF1 || !hasE277) {
      // Check if isEM decoration is available
      const SG::AuxElement::Accessor<int> accIsEM(m_isEMDecoration);
      if (accIsEM.isAvailable(ph)) {
        const int previousIsEM = accIsEM(ph);
        passF1 = !(previousIsEM & FailPreselectionF1);
        passE277 = !(previousIsEM & FailPreselectionE277);
        passPre = passF1 && passE277;
      }
      else {
        ATH_MSG_ERROR("Missing f1 and e277 shower shapes and isEM decoration, cannot reapply WP. Rejecting photon.");
        acc.setCutResult(m_cutPosPreF1, false);
        acc.setCutResult(m_cutPosPreE277, false);
        acc.setCutResult(m_cutPosPassPreselection, false);
        setBit(FailPreselectionF1);
        setBit(FailPreselectionE277);
        return acc;
      }
    }
  }
  else {
    // If we are missing shower shapes and we are not reapplying the WP, we throw an error
    float f1 = 0.f, e277 = 0.f;
    f1 = getShowerShape(ph, xAOD::EgammaParameters::f1, "f1");
    e277 = getShowerShape(ph, xAOD::EgammaParameters::e277, "e277");
 
    const float cutF1   = conv ? m_cutF1Conv.at(0)   : m_cutF1Unconv.at(0);
    const float cutE277 = conv ? m_cutE277Conv.at(0) : m_cutE277Unconv.at(0); 
    passF1   = (f1   > cutF1);
    passE277 = (e277 >  cutE277);
    passPre = passF1 && passE277;
  }
  
  // Decorate the accept data with the results of the preselection cuts
  acc.setCutResult(m_cutPosPreF1, passF1);
  acc.setCutResult(m_cutPosPreE277, passE277);
  acc.setCutResult(m_cutPosPassPreselection, passPre);
 
  // Set bits for failed preselections
  if (!passF1) setBit(FailPreselectionF1);
  if (!passE277) setBit(FailPreselectionE277);
  // If failed preselection, reject and return
  if (!passPre) return acc;
 
  // Check the BDT score cut
  const float cut = getCut(conv, iEta, iEt);
  const bool passBDT = (score > cut);
  acc.setCutResult(m_cutPosScore, (score > cut));
  if (!passBDT) setBit(FailBDTScore);
 
  return acc;
}

◆ AsgTool() [1/2]

asg::AsgTool::AsgTool ( const AsgTool & )

delete

◆ AsgTool() [2/2]

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

Constructor specifying the tool instance's name.

Definition at line 51 of file AsgTool.cxx.

      : AsgToolBase(
#ifndef XAOD_STANDALONE
                    ::getType(name), ::getName(name), ::getParent(name)
#else // not XAOD_STANDALONE
                    name
#endif // not XAOD_STANDALONE
                    )
#ifdef XAOD_STANDALONE
      , m_event()
#endif // XAOD_STANDALONE
   {
      ToolStore::put( this ).ignore(); // Register the tool in the ToolStore
   }

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode AsgPhotonBDTSelector::execute	(	const EventContext &	ctx,
		const xAOD::Egamma *	eg,
		unsigned int &	isEM ) const

overridevirtual

Add a legacy execute method - return isEM value.

Implements IAsgEGammaIsEMSelector.

Definition at line 201 of file AsgPhotonBDTSelector.cxx.

{
  isEM = 0u;
  if (!eg) return StatusCode::SUCCESS;;
 
  const auto* ph = dynamic_cast<const xAOD::Photon*>(eg);
  if (!ph) {
    isEM = 1u; // or define a bit for wrong type
    return StatusCode::SUCCESS;
  }
 
  (void) acceptBDT(ctx, *ph, &isEM);
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

◆ findBin()

bool AsgPhotonBDTSelector::findBin	(	const float	absEta,
		const float	etGeV,
		size_t &	iEta,
		size_t &	iEt ) const

private

Definition at line 226 of file AsgPhotonBDTSelector.cxx.

                                                                    {
  // bins defined as [edge_i, edge_{i+1})
  // Eta binning
  auto itEta = std::upper_bound(m_etaBins.begin(), m_etaBins.end(), absEta);
  if (itEta == m_etaBins.begin() || itEta == m_etaBins.end()) return false; // Eta out of range
  iEta = (itEta - m_etaBins.begin()) - 1; // regular bin
 
  // ET binning
  auto itEt  = std::upper_bound(m_etBinsGeV.begin(), m_etBinsGeV.end(), etGeV);
  if (itEt == m_etBinsGeV.begin()) { iEt = 0; } // underflow: first bin
  else if (itEt == m_etBinsGeV.end()) { iEt = m_etBinsGeV.size() - 2; } // overflow: last bin
  else { iEt = (itEt - m_etBinsGeV.begin()) - 1; } // regular bin
  
  return true;
}

◆ getAcceptInfo()

const asg::AcceptInfo & AsgPhotonBDTSelector::getAcceptInfo ( ) const

overrideprivatevirtual

Declare the interface ID for this pure-virtual interface class to the Athena framework.

Method to get the AcceptInfo to query what cuts are defined.

Implements IAsgSelectionTool.

Definition at line 148 of file AsgPhotonBDTSelector.cxx.

                                                               {
  return m_acceptInfo;
}

◆ getCut()

float AsgPhotonBDTSelector::getCut	(	const bool	converted,
		const size_t	iEta,
		const size_t	iEt ) const

private

Definition at line 243 of file AsgPhotonBDTSelector.cxx.

                                                                                                  {
  const size_t nEta = m_etaBins.size() - 1;
  const size_t idx = iEt * nEta + iEta;
  const float cut = converted ? m_cutConv.at(idx) : m_cutUnconv.at(idx);
  return cut;
}

◆ getKey()

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

inherited

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

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

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

See also: asg::AsgTool::getName

Parameters

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

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

Definition at line 119 of file AsgTool.cxx.

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

◆ getName()

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

inherited

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

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

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

See also: asg::AsgTool::getKey

Parameters

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

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

Definition at line 106 of file AsgTool.cxx.

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

◆ getOperatingPointName()

std::string AsgPhotonBDTSelector::getOperatingPointName ( ) const

overridevirtual

Report the current operating point.

Implements IAsgEGammaIsEMSelector.

Definition at line 140 of file AsgPhotonBDTSelector.cxx.

{
  return m_workingPoint;
}

◆ getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

◆ getShowerShape()

float AsgPhotonBDTSelector::getShowerShape	(	const xAOD::Photon &	ph,
		xAOD::EgammaParameters::ShowerShapeType	t,
		const char *	name = "" ) const

private

Definition at line 256 of file AsgPhotonBDTSelector.cxx.

                                                                                                                              {
  float out = 0.f;
  if (!ph.showerShapeValue(out, t)) {
    ATH_MSG_ERROR("AsgPhotonBDTSelector: missing shower shape variable '" << name);
    // Fail loudly
    throw std::runtime_error(std::string("AsgPhotonBDTSelector: missing shower shape ") + name);
  }
  return out;
}

◆ initialize()

StatusCode AsgPhotonBDTSelector::initialize ( void )

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 44 of file AsgPhotonBDTSelector.cxx.

                                            {
  // Load the configuration file and parse it
  ATH_CHECK(loadConfig());
  // Register the cuts in the AcceptInfo
  m_cutPosHasScore          = m_acceptInfo.addCut("HasScore", "Photon has BDT score decoration");
  m_cutPosPreF1             = m_acceptInfo.addCut("PreselectionF1", "Photon passes preselection on f1");
  m_cutPosPreE277           = m_acceptInfo.addCut("PreselectionE277", "Photon passes preselection on e277");
  m_cutPosPassPreselection  = m_acceptInfo.addCut("PassPreselection", "Photon passes all preselections");
  m_cutPosInRange           = m_acceptInfo.addCut("InRange", "Photon kinematics within eta range and binned in Et");
  m_cutPosScore             = m_acceptInfo.addCut("BDTScore", "Passes the BDT score cut");
  // Check if it went well
  if (m_cutPosScore < 0 || m_cutPosInRange < 0 || m_cutPosHasScore < 0 ||
      m_cutPosPreF1 < 0 || m_cutPosPreE277 < 0 || m_cutPosPassPreselection < 0) {
    ATH_MSG_ERROR("Failed to register cuts in AcceptInfo");
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK(m_ContainerName.initialize());
  ATH_CHECK(m_decoratorScore.initialize());
 
#ifndef XAOD_STANDALONE
  if(m_suppressInputDeps){
    // The user has promised that this will be produced by the same alg.
    // Tell the scheduler to ignore it to avoid circular dependencies.
    renounce(m_decoratorScore);
  }
#endif
 
  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.

◆ isConverted()

bool AsgPhotonBDTSelector::isConverted ( const xAOD::Photon & ph ) const

private

Definition at line 221 of file AsgPhotonBDTSelector.cxx.

                                                                 {
  return xAOD::EgammaHelpers::isConvertedPhoton(&ph, m_excludeTRT);
}

◆ loadConfig()

StatusCode AsgPhotonBDTSelector::loadConfig ( )

private

Definition at line 78 of file AsgPhotonBDTSelector.cxx.

                                            {
  // If we specified the WP, look for the corresponding config file in the mapping
  if (!m_workingPoint.empty()) {
    m_configFile = AsgConfigHelper::findConfigFile(
      m_workingPoint, EgammaSelectors::PhotonBDTPointToConfFile
    );
    ATH_MSG_INFO("Photon ID BDT working point: " << getOperatingPointName());
  }
 
  if (m_configFile.empty()) {
    ATH_MSG_ERROR("Empty configFile. WorkingPoint: " << m_workingPoint);
    return StatusCode::FAILURE;
  }
 
  const std::string configFile = PathResolverFindCalibFile(m_configFile);
  if (configFile.empty()) {
    ATH_MSG_ERROR("Could not locate config via PathResolver: " << m_configFile);
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Using config file: " << m_configFile << " (resolved: " << configFile << ")");
 
  // Parse config file
  TEnv env;
  env.ReadFile(configFile.c_str(), kEnvLocal);
 
  // Load WP binning
  m_etaBins    = AsgConfigHelper::HelperFloat("CutBinEta",    env);
  m_etBinsGeV  = AsgConfigHelper::HelperFloat("CutBinEtGeV",  env);
  // Load preselection cuts on f1 and e277 variables
  m_cutF1Conv    = AsgConfigHelper::HelperFloat("CutF1Conv", env);
  m_cutF1Unconv  = AsgConfigHelper::HelperFloat("CutF1Unconv", env);
  m_cutE277Conv  = AsgConfigHelper::HelperFloat("CutE277Conv", env);
  m_cutE277Unconv= AsgConfigHelper::HelperFloat("CutE277Unconv", env);
  // Load BDT score cuts
  m_cutConv    = AsgConfigHelper::HelperFloat("BDTCutConv",   env);
  m_cutUnconv  = AsgConfigHelper::HelperFloat("BDTCutUnconv", env);
 
  // Validate binning
  const unsigned nEta = (m_etaBins.size() >= 2) ? (m_etaBins.size() - 1) : 0;
  const unsigned nEt  = (m_etBinsGeV.size() >= 2) ? (m_etBinsGeV.size() - 1) : 0;
 
  if (nEta == 0 || nEt == 0) {
    ATH_MSG_ERROR("Need at least 2 edges for eta and Et binning.");
    return StatusCode::FAILURE;
  }
 
  const unsigned nExpected = nEta * nEt;
  if (m_cutConv.size() != nExpected || m_cutUnconv.size() != nExpected) {
    ATH_MSG_ERROR("Size mismatch between eta and Et binning and BDT cut maps: expected " << nExpected
                  << " (= " << nEta << "*" << nEt << ")"
                  << " got BDTCutConv=" << m_cutConv.size()
                  << " BDTCutUnconv=" << m_cutUnconv.size());
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ makeReject()

asg::AcceptData AsgPhotonBDTSelector::makeReject ( const asg::AcceptInfo & info )

staticprivate

Definition at line 250 of file AsgPhotonBDTSelector.cxx.

                                                                        {
  asg::AcceptData acc(&info);
  for (unsigned i = 0; i < info.getNCuts(); ++i) acc.setCutResult(i, false);
  return acc;
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

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

inherited

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

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

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

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

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

Definition at line 101 of file AsgTool.cxx.

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

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ renounce()

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

inlineprotectedinherited

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

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

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

asg::AcceptInfo PhotonIDBDT::AsgPhotonBDTSelector::m_acceptInfo

private

Definition at line 106 of file AsgPhotonBDTSelector.h.

◆ m_configFile

std::string PhotonIDBDT::AsgPhotonBDTSelector::m_configFile = ""

private

Definition at line 90 of file AsgPhotonBDTSelector.h.

◆ m_ContainerName

SG::ReadHandleKey<xAOD::EgammaContainer> PhotonIDBDT::AsgPhotonBDTSelector::m_ContainerName { this, "ContainerName", "", "Input" }

private

Definition at line 121 of file AsgPhotonBDTSelector.h.

121{ this, "ContainerName", "", "Input" };

◆ m_cutConv

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_cutConv

private

Definition at line 102 of file AsgPhotonBDTSelector.h.

◆ m_cutE277Conv

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_cutE277Conv

private

Definition at line 98 of file AsgPhotonBDTSelector.h.

◆ m_cutE277Unconv

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_cutE277Unconv

private

Definition at line 99 of file AsgPhotonBDTSelector.h.

◆ m_cutF1Conv

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_cutF1Conv

private

Definition at line 96 of file AsgPhotonBDTSelector.h.

◆ m_cutF1Unconv

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_cutF1Unconv

private

Definition at line 97 of file AsgPhotonBDTSelector.h.

◆ m_cutPosHasScore

int PhotonIDBDT::AsgPhotonBDTSelector::m_cutPosHasScore {-1}

private

Definition at line 109 of file AsgPhotonBDTSelector.h.

109{-1};

◆ m_cutPosInRange

int PhotonIDBDT::AsgPhotonBDTSelector::m_cutPosInRange {-1}

private

Definition at line 108 of file AsgPhotonBDTSelector.h.

108{-1};

◆ m_cutPosPassPreselection

int PhotonIDBDT::AsgPhotonBDTSelector::m_cutPosPassPreselection {-1}

private

Definition at line 112 of file AsgPhotonBDTSelector.h.

112{-1};

◆ m_cutPosPreE277

int PhotonIDBDT::AsgPhotonBDTSelector::m_cutPosPreE277 {-1}

private

Definition at line 111 of file AsgPhotonBDTSelector.h.

111{-1};

◆ m_cutPosPreF1

int PhotonIDBDT::AsgPhotonBDTSelector::m_cutPosPreF1 {-1}

private

Definition at line 110 of file AsgPhotonBDTSelector.h.

110{-1};

◆ m_cutPosScore

int PhotonIDBDT::AsgPhotonBDTSelector::m_cutPosScore {-1}

private

Definition at line 107 of file AsgPhotonBDTSelector.h.

107{-1};

◆ m_cutUnconv

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_cutUnconv

private

Definition at line 103 of file AsgPhotonBDTSelector.h.

◆ m_decoratorScore

SG::ReadDecorHandleKey<xAOD::EgammaContainer> PhotonIDBDT::AsgPhotonBDTSelector::m_decoratorScore

private

Initial value:

{ this,

"ScoreDecoration", m_ContainerName, "", "" }

Definition at line 122 of file AsgPhotonBDTSelector.h.

122 { this,

123 "ScoreDecoration", m_ContainerName, "", "" };

◆ 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_etaBins

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_etaBins

private

Definition at line 93 of file AsgPhotonBDTSelector.h.

◆ m_etBinsGeV

std::vector<float> PhotonIDBDT::AsgPhotonBDTSelector::m_etBinsGeV

private

Definition at line 94 of file AsgPhotonBDTSelector.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_excludeTRT

Gaudi::Property<bool> PhotonIDBDT::AsgPhotonBDTSelector::m_excludeTRT {this, "ExcludeTRT", true, "Conversion definition for Run 3"}

private

Definition at line 85 of file AsgPhotonBDTSelector.h.

85{this, "ExcludeTRT", true, "Conversion definition for Run 3"};

◆ m_isEMDecoration

Gaudi::Property<std::string> PhotonIDBDT::AsgPhotonBDTSelector::m_isEMDecoration {this, "IsEMDecoration", "BDTIsEM", "Name of the int decoration containing the isEM word (used if ReapplyWPIfNoShowerShapes is true)"}

private

Definition at line 87 of file AsgPhotonBDTSelector.h.

87{this, "IsEMDecoration", "BDTIsEM", "Name of the int decoration containing the isEM word (used if ReapplyWPIfNoShowerShapes is true)"};

◆ m_reapplyWPIfNoShowerShapes

Gaudi::Property<bool> PhotonIDBDT::AsgPhotonBDTSelector::m_reapplyWPIfNoShowerShapes {this, "ReapplyWPIfNoShowerShapes", true, "Reapply the WP calculation, based on the BDT score and isEM word (works only if these are available!) "}

private

Definition at line 86 of file AsgPhotonBDTSelector.h.

86{this, "ReapplyWPIfNoShowerShapes", true, "Reapply the WP calculation, based on the BDT score and isEM word (works only if these are available!) "};

◆ m_suppressInputDeps

Gaudi::Property<bool> PhotonIDBDT::AsgPhotonBDTSelector::m_suppressInputDeps {this, "SuppressInputDependence", false, "Will BDT score be created in the same algorithm that uses this tool?"}

private

Definition at line 125 of file AsgPhotonBDTSelector.h.

125{this, "SuppressInputDependence", false, "Will BDT score be created in the same algorithm that uses this tool?"};

◆ 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.

◆ m_workingPoint

Gaudi::Property<std::string> PhotonIDBDT::AsgPhotonBDTSelector::m_workingPoint {this, "WorkingPoint", "", "Name of the Photon ID BDT Working point"}

private

Definition at line 84 of file AsgPhotonBDTSelector.h.

84{this, "WorkingPoint", "", "Name of the Photon ID BDT Working point"};

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ accept() [1/5]

◆ accept() [2/5]

◆ accept() [3/5]

◆ accept() [4/5]

◆ accept() [5/5]

◆ acceptBDT()

◆ AsgTool() [1/2]

◆ AsgTool() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ findBin()

◆ getAcceptInfo()

◆ getCut()

◆ getKey()

◆ getName()

◆ getOperatingPointName()

◆ getProperty()

◆ getShowerShape()

◆ initialize()

◆ inputHandles()

◆ isConverted()

◆ loadConfig()

◆ makeReject()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_acceptInfo

◆ m_configFile

◆ m_ContainerName

◆ m_cutConv

◆ m_cutE277Conv

◆ m_cutE277Unconv

◆ m_cutF1Conv

◆ m_cutF1Unconv

◆ m_cutPosHasScore

◆ m_cutPosInRange

◆ m_cutPosPassPreselection

◆ m_cutPosPreE277

◆ m_cutPosPreF1

◆ m_cutPosScore

◆ m_cutUnconv

◆ m_decoratorScore

◆ m_detStore

◆ m_etaBins

◆ m_etBinsGeV

◆ m_evtStore

◆ m_excludeTRT

◆ m_isEMDecoration

◆ m_reapplyWPIfNoShowerShapes

◆ m_suppressInputDeps

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_workingPoint