AsgForwardElectronLikelihoodTool Class Reference

Electron selector tool to select objects in Asgena using an underlying pure ROOT tool. More...

#include <AsgForwardElectronLikelihoodTool.h>

Inheritance diagram for AsgForwardElectronLikelihoodTool:

Collaboration diagram for AsgForwardElectronLikelihoodTool:

Public Member Functions
double	calculate (const xAOD::IParticle *part) const
	The main result method: the actual likelihood is calculated here. More...
double	calculate (const EventContext &ctx, const xAOD::IParticle *part) const override
	calculate method: for pointer to IParticle More...
double	calculate (const xAOD::Electron *eg) const
	The main result method: the actual likelihood is calculated here. More...
double	calculate (const EventContext &ctx, const xAOD::Electron *eg) const override
	calculate method: for pointer to electron More...
double	calculate (const xAOD::Egamma *eg) const
	The main result method: the actual likelihood is calculated here. More...
double	calculate (const EventContext &ctx, const xAOD::Egamma *eg) const override
	calculate method: for pointer to egamma More...
double	calculate (const xAOD::Electron *eg, double mu) const
	The main result method: the actual likelihood is calculated here. More...
double	calculate (const EventContext &ctx, const xAOD::Electron *eg, double mu) const override
	calculate method: for pointer to electron when mu not in EventInfo for online More...
double	calculate (const xAOD::Egamma *eg, double mu) const
	The main result method: the actual likelihood is calculated here. More...
double	calculate (const EventContext &ctx, const xAOD::Egamma *eg, double mu) const override
	calculate method: for pointer to egamma when mu not in EventInfo for online More...
virtual std::vector< float >	calculateMultipleOutputs (const EventContext &ctx, const xAOD::Electron *eg, double mu=-99) const override
	The result method for multiple outputs: only one output is used so return vector of that output. More...
virtual std::string	getOperatingPointName () const override
	Get the name of the current operating point. 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 > &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
virtual ASG_TOOL_CLASS2(AsgForwardElectronLikelihoodTool, IAsgElectronLikelihoodTool, IAsgSelectionTool) public	~AsgForwardElectronLikelihoodTool ()
	Standard constructor. More...
virtual StatusCode	initialize () override final
	Gaudi Service Interface method implementations. More...
virtual const asg::AcceptInfo &	getAcceptInfo () const override
	Method to get the plain AcceptInfo. More...
asg::AcceptData	accept (const xAOD::IParticle *part) const override
	The main accept method: using the generic interface. More...
asg::AcceptData	accept (const EventContext &ctx, const xAOD::IParticle *part) const override
asg::AcceptData	accept (const xAOD::Electron *eg) const
	The main accept method: the actual cuts are applied here. More...
asg::AcceptData	accept (const EventContext &ctx, const xAOD::Electron *eg) const override
	accept method with pointer to electron More...
asg::AcceptData	accept (const xAOD::Egamma *eg) const
	The main accept method: the actual cuts are applied here. More...
asg::AcceptData	accept (const EventContext &ctx, const xAOD::Egamma *eg) const override
	accept method with pointer to egamma More...
asg::AcceptData	accept (const xAOD::Electron *eg, double mu) const
	The main accept method: in case mu not in EventInfo online. More...
asg::AcceptData	accept (const EventContext &ctx, const xAOD::Electron *eg, double mu) const override
	accept method with pointer to electron when mu not in EventInfo for online More...
asg::AcceptData	accept (const xAOD::Egamma *eg, double mu) const
	The main accept method: in case mu not in EventInfo online. More...
asg::AcceptData	accept (const EventContext &ctx, const xAOD::Egamma *eg, double mu) const override
	accept method with pointer to egammma when mu not in EventInfo for online More...
unsigned int	getNPrimVertices (const EventContext &ctx) const
	Get the number of primary vertices. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
std::string	m_WorkingPoint
	Get the name of the current operating point. More...
std::string	m_configFile
Root::TForwardElectronLikelihoodTool *	m_rootForwardTool
	Pointer to the underlying ROOT based tool. More...
bool	m_usePVCont
	Whether to use the PV (not available for trigger) More...
unsigned int	m_nPVdefault
	defualt nPV (when not using PVCont) More...
SG::ReadHandleKey< xAOD::VertexContainer >	m_primVtxContKey
	read handle key to primary vertex container More...
std::string	m_pdfFileName
	The input ROOT file name that holds the PDFs. 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

Electron selector tool to select objects in Asgena using an underlying pure ROOT tool.

Definition at line 25 of file AsgForwardElectronLikelihoodTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

~AsgForwardElectronLikelihoodTool()

AsgForwardElectronLikelihoodTool::~AsgForwardElectronLikelihoodTool ( )

privatevirtual

Standard constructor.

Standard destructor

Definition at line 85 of file AsgForwardElectronLikelihoodTool.cxx.

{
  delete m_rootForwardTool;
}

Member Function Documentation

accept() [1/10]

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

inlineoverrideprivatevirtual

accept method with pointer to egamma

Implements IAsgElectronLikelihoodTool.

Definition at line 73 of file AsgForwardElectronLikelihoodTool.h.

  {
    return accept(ctx, eg, -99); // mu = -99 as input will force accept to grab
                                 // the pileup variable from the xAOD object
  }

accept() [2/10]

asg::AcceptData AsgForwardElectronLikelihoodTool::accept ( const EventContext &  ctx, const xAOD::Egamma *  part, double  mu  ) const

overrideprivatevirtual

accept method with pointer to egammma when mu not in EventInfo for online

Implements IAsgElectronLikelihoodTool.

Definition at line 222 of file AsgForwardElectronLikelihoodTool.cxx.

{
 
  const xAOD::Electron* el = dynamic_cast<const xAOD::Electron*>(eg);
  return accept(ctx, el, mu);
}

accept() [3/10]

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

inlineoverrideprivatevirtual

accept method with pointer to electron

Implements IAsgElectronLikelihoodTool.

Definition at line 60 of file AsgForwardElectronLikelihoodTool.h.

  {
    return accept(ctx, eg, -99); // mu = -99 as input will force accept to grab
                                 // the pileup variable from the xAOD object
  }

accept() [4/10]

asg::AcceptData AsgForwardElectronLikelihoodTool::accept ( const EventContext &  ctx, const xAOD::Electron *  part, double  mu  ) const

overrideprivatevirtual

accept method with pointer to electron when mu not in EventInfo for online

Implements IAsgElectronLikelihoodTool.

Definition at line 235 of file AsgForwardElectronLikelihoodTool.cxx.

{
  if (!eg) {
    ATH_MSG_ERROR("Failed, no egamma object.");
    return m_rootForwardTool->accept();
  }
 
  const xAOD::CaloCluster* cluster = eg->caloCluster();
  if (!cluster) {
    ATH_MSG_WARNING("Failed, no cluster.");
    return m_rootForwardTool->accept();
  }
 
  const double energy = cluster->e();
  const float eta = (cluster->eta());
  if (fabs(eta) > 300.0) {
    ATH_MSG_WARNING("Failed, eta > 3000.");
    return m_rootForwardTool->accept();
  }
 
  // transverse energy of the electron (using the track eta)
  double et = (cosh(eta) != 0.) ? energy / cosh(eta) : 0.;
  double ip(0);
 
  // Get the number of primary vertices in this event
  if (mu < 0) { // use npv if mu is negative (not given)
    ip = static_cast<double>(m_usePVCont ? this->getNPrimVertices(ctx)
                                         : m_nPVdefault);
  } else {
    ip = mu;
  }
 
  // for now don't cache.
  double likelihood = calculate(ctx, eg, ip);
 
  // Get the answer from the underlying ROOT tool
  return m_rootForwardTool->accept(likelihood, eta, et, ip);
}

accept() [5/10]

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

overrideprivatevirtual

Implements IAsgElectronLikelihoodTool.

Definition at line 448 of file AsgForwardElectronLikelihoodTool.cxx.

{
  if (part->type() == xAOD::Type::Electron) {
    const xAOD::Electron* el = static_cast<const xAOD::Electron*>(part);
    return accept(ctx, el);
  }
  ATH_MSG_ERROR("Input is not an electron");
  return m_rootForwardTool->accept();
}

accept() [6/10]

asg::AcceptData AsgForwardElectronLikelihoodTool::accept ( const xAOD::Egamma *  eg ) const

inlineprivate

The main accept method: the actual cuts are applied here.

Definition at line 68 of file AsgForwardElectronLikelihoodTool.h.

  {
    return accept(eg, -99); // mu = -99 as input will force accept to grab the
                            // pileup variable from the xAOD object
  }

accept() [7/10]

asg::AcceptData AsgForwardElectronLikelihoodTool::accept ( const xAOD::Egamma *  eg, double  mu  ) const

private

The main accept method: in case mu not in EventInfo online.

Definition at line 204 of file AsgForwardElectronLikelihoodTool.cxx.

{
 
  const xAOD::Electron* el = dynamic_cast<const xAOD::Electron*>(eg);
  return accept(el, mu);
}

accept() [8/10]

asg::AcceptData AsgForwardElectronLikelihoodTool::accept ( const xAOD::Electron *  eg ) const

inlineprivate

The main accept method: the actual cuts are applied here.

Definition at line 55 of file AsgForwardElectronLikelihoodTool.h.

  {
    return accept(eg, -99); // mu = -99 as input will force accept to grab the
                            // pileup variable from the xAOD object
  }

accept() [9/10]

asg::AcceptData AsgForwardElectronLikelihoodTool::accept ( const xAOD::Electron *  eg, double  mu  ) const

private

The main accept method: in case mu not in EventInfo online.

Definition at line 213 of file AsgForwardElectronLikelihoodTool.cxx.

{
 
  // Backwards compatbility
  return accept(Gaudi::Hive::currentContext(), eg, mu);
}

accept() [10/10]

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

overrideprivatevirtual

The main accept method: using the generic interface.

Implements IAsgElectronLikelihoodTool.

Definition at line 441 of file AsgForwardElectronLikelihoodTool.cxx.

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

calculate() [1/10]

double AsgForwardElectronLikelihoodTool::calculate ( const EventContext &  ctx, const xAOD::Egamma *  eg  ) const

inlineoverridevirtual

calculate method: for pointer to egamma

Implements IAsgElectronLikelihoodTool.

Definition at line 119 of file AsgForwardElectronLikelihoodTool.h.

  {
    return calculate(
      ctx, eg, -99); // mu = -99 as input will force accept to grab the pileup
                     // variable from the xAOD object
  }

calculate() [2/10]

double AsgForwardElectronLikelihoodTool::calculate ( const EventContext &  ctx, const xAOD::Egamma *  eg, double  mu  ) const

overridevirtual

calculate method: for pointer to egamma when mu not in EventInfo for online

Implements IAsgElectronLikelihoodTool.

Definition at line 297 of file AsgForwardElectronLikelihoodTool.cxx.

{
 
  const xAOD::Electron* el = dynamic_cast<const xAOD::Electron*>(eg);
  return calculate(ctx, el, mu);
}

calculate() [3/10]

double AsgForwardElectronLikelihoodTool::calculate ( const EventContext &  ctx, const xAOD::Electron *  eg  ) const

inlineoverridevirtual

calculate method: for pointer to electron

Implements IAsgElectronLikelihoodTool.

Definition at line 105 of file AsgForwardElectronLikelihoodTool.h.

  {
    return calculate(
      ctx, eg, -99); // mu = -99 as input will force accept to grab the pileup
                     // variable from the xAOD object
  }

calculate() [4/10]

double AsgForwardElectronLikelihoodTool::calculate ( const EventContext &  ctx, const xAOD::Electron *  eg, double  mu  ) const

overridevirtual

calculate method: for pointer to electron when mu not in EventInfo for online

Implements IAsgElectronLikelihoodTool.

Definition at line 310 of file AsgForwardElectronLikelihoodTool.cxx.

{
  if (!eg) {
    ATH_MSG_ERROR("Failed, no egamma object.");
    return -999;
  }
 
  const xAOD::CaloCluster* cluster = eg->caloCluster();
  if (!cluster) {
    ATH_MSG_ERROR("Failed, no cluster.");
    return -999;
  }
 
  const double energy = cluster->e();
  const float eta = cluster->eta();
  if (fabs(eta) > 300.0) {
    ATH_MSG_ERROR("Failed, eta range.");
    ATH_MSG_ERROR("checking at other place ." << eta);
    return -999;
  }
 
  const double et = (cosh(eta) != 0.) ? energy / cosh(eta) : 0.;
 
  // Shower shape variables
  double secondDensity(0), significance(0), secondLambda(0), lateral(0),
    longitudinal(0), fracMax(0), secondR(0), centerLambda(0);
 
  bool allFound = true;
  std::string notFoundList = "";
 
  // secondLambda
  if (!cluster->retrieveMoment(xAOD::CaloCluster::SECOND_LAMBDA,
                               secondLambda)) {
    allFound = false;
    notFoundList += "secondLambda ";
  }
  // lateral
  if (!cluster->retrieveMoment(xAOD::CaloCluster::LATERAL, lateral)) {
    allFound = false;
    notFoundList += "lateral ";
  }
  // longitudinal
  if (!cluster->retrieveMoment(xAOD::CaloCluster::LONGITUDINAL, longitudinal)) {
    allFound = false;
    notFoundList += "longitudinal ";
  }
  // fracMax
  if (!cluster->retrieveMoment(xAOD::CaloCluster::ENG_FRAC_MAX, fracMax)) {
    allFound = false;
    notFoundList += "fracMax ";
  }
  // secondR
  if (!cluster->retrieveMoment(xAOD::CaloCluster::SECOND_R, secondR)) {
    allFound = false;
    notFoundList += "secondR ";
  }
  // centerlambda
  if (!cluster->retrieveMoment(xAOD::CaloCluster::CENTER_LAMBDA,
                               centerLambda)) {
    allFound = false;
    notFoundList += "centerLambda ";
  }
  if (!cluster->retrieveMoment(xAOD::CaloCluster::SECOND_ENG_DENS,
                               secondDensity)) {
    allFound = false;
    notFoundList += "secondDensity ";
  }
  if (!cluster->retrieveMoment(xAOD::CaloCluster::SIGNIFICANCE, significance)) {
    allFound = false;
    notFoundList += "significance ";
  }
 
  // Get the number of primary vertices in this event
  double ip = static_cast<double>(m_nPVdefault);
 
  if (mu < 0) { // use npv if mu is negative (not given)
    ip = static_cast<double>(m_usePVCont ? this->getNPrimVertices(ctx)
                                         : m_nPVdefault);
  } else {
    ip = mu;
  }
 
  ATH_MSG_VERBOSE(
    Form("Vars: eta=%8.5f, et=%8.5f, 2nd lambda=%8.5f, lateral=%8.5f, "
         "longitudinal=%8.5f, center lambda=%8.5f, frac max=%8.5f, "
         "secondR=%8.5f, significance=%8.5f, 2nd density=%8.5f, ip=%8.5f",
         eta,
         et,
         secondLambda,
         lateral,
         longitudinal,
         centerLambda,
         fracMax,
         secondR,
         significance,
         secondDensity,
         ip));
 
  if (!allFound) {
    ATH_MSG_ERROR(
      "Skipping LH calculation! The following variables are missing: "
      << notFoundList);
    return -999;
  }
 
  // Get the answer from the underlying ROOT tool
  return m_rootForwardTool->calculate(eta,
                                      et,
                                      secondLambda,
                                      lateral,
                                      longitudinal,
                                      centerLambda,
                                      fracMax,
                                      secondR,
                                      significance,
                                      secondDensity,
                                      ip);
}

calculate() [5/10]

double AsgForwardElectronLikelihoodTool::calculate ( const EventContext &  ctx, const xAOD::IParticle *  part  ) const

overridevirtual

calculate method: for pointer to IParticle

Implements IAsgElectronLikelihoodTool.

Definition at line 467 of file AsgForwardElectronLikelihoodTool.cxx.

{
  if (part->type() == xAOD::Type::Electron) {
    const xAOD::Electron* el = static_cast<const xAOD::Electron*>(part);
    return calculate(ctx, el);
  }
  ATH_MSG_ERROR("Input is not an electron");
  return -999;
}

calculate() [6/10]

double AsgForwardElectronLikelihoodTool::calculate ( const xAOD::Egamma *  eg ) const

inline

The main result method: the actual likelihood is calculated here.

Definition at line 114 of file AsgForwardElectronLikelihoodTool.h.

  {
    return calculate(eg, -99); // mu = -99 as input will force accept to grab
                               // the pileup variable from the xAOD object
  }

calculate() [7/10]

double AsgForwardElectronLikelihoodTool::calculate	(	const xAOD::Egamma *	eg,
		double	mu
	)		const

The main result method: the actual likelihood is calculated here.

Definition at line 280 of file AsgForwardElectronLikelihoodTool.cxx.

{
 
  const xAOD::Electron* el = dynamic_cast<const xAOD::Electron*>(eg);
  return calculate(el, mu);
}

calculate() [8/10]

double AsgForwardElectronLikelihoodTool::calculate ( const xAOD::Electron *  eg ) const

inline

The main result method: the actual likelihood is calculated here.

Definition at line 100 of file AsgForwardElectronLikelihoodTool.h.

  {
    return calculate(eg, -99); // mu = -99 as input will force accept to grab
                               // the pileup variable from the xAOD object
  }

calculate() [9/10]

double AsgForwardElectronLikelihoodTool::calculate	(	const xAOD::Electron *	eg,
		double	mu
	)		const

The main result method: the actual likelihood is calculated here.

Definition at line 289 of file AsgForwardElectronLikelihoodTool.cxx.

{
  // Backward compatbility
  return calculate(Gaudi::Hive::currentContext(), el, mu);
}

calculate() [10/10]

double AsgForwardElectronLikelihoodTool::calculate

(

const xAOD::IParticle *

part

)

const

The main result method: the actual likelihood is calculated here.

Definition at line 460 of file AsgForwardElectronLikelihoodTool.cxx.

{
  // Backwards compatibily
  return calculate(Gaudi::Hive::currentContext(), part);
}

calculateMultipleOutputs()

virtual std::vector<float> AsgForwardElectronLikelihoodTool::calculateMultipleOutputs ( const EventContext &  ctx, const xAOD::Electron *  eg, double  mu = -99  ) const

inlineoverridevirtual

The result method for multiple outputs: only one output is used so return vector of that output.

Implements IAsgElectronLikelihoodTool.

Definition at line 141 of file AsgForwardElectronLikelihoodTool.h.

  {
    return {static_cast<float>(calculate(ctx, eg, mu))};
  }

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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 > &  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 > &  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 > &  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 > &  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

getAcceptInfo()

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

overrideprivatevirtual

Method to get the plain AcceptInfo.

This is needed so that one can already get the AcceptInfo and query what cuts are defined before the first object is passed to the tool.

Implements IAsgSelectionTool.

Definition at line 195 of file AsgForwardElectronLikelihoodTool.cxx.

{
  return m_rootForwardTool->getAcceptInfo();
}

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
   }

getNPrimVertices()

unsigned int AsgForwardElectronLikelihoodTool::getNPrimVertices ( const EventContext &  ctx ) const

private

Get the number of primary vertices.

Definition at line 485 of file AsgForwardElectronLikelihoodTool.cxx.

{
  unsigned int nVtx(0);
  SG::ReadHandle<xAOD::VertexContainer> vtxCont(m_primVtxContKey, ctx);
  if (!vtxCont.isValid()) {
    ATH_MSG_WARNING("Cannot find " << m_primVtxContKey.key()
            << " container, returning default nVtx");
    return m_nPVdefault;
  }
  for (const auto *vxcand : *vtxCont) {
    if (vxcand->nTrackParticles() >= 2)
      nVtx++;
  }
  return nVtx;
}

getOperatingPointName()

std::string AsgForwardElectronLikelihoodTool::getOperatingPointName ( ) const

overridevirtual

Get the name of the current operating point.

Implements IAsgElectronLikelihoodTool.

Definition at line 435 of file AsgForwardElectronLikelihoodTool.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.

initialize()

StatusCode AsgForwardElectronLikelihoodTool::initialize ( )

finaloverrideprivatevirtual

Gaudi Service Interface method implementations.

--------—End of text config-------------------------—

Reimplemented from asg::AsgTool.

Definition at line 94 of file AsgForwardElectronLikelihoodTool.cxx.

{
 
  ATH_MSG_INFO("initialize : WP " << m_WorkingPoint.size() << " "
                                  << m_configFile.size());
 
  std::string PDFfilename(""); // Default
 
  if (!m_WorkingPoint.empty()) {
    m_configFile = AsgConfigHelper::findConfigFile(
      m_WorkingPoint, EgammaSelectors::ForwardLHPointToConfFile);
    ATH_MSG_INFO("operating point : " << this->getOperatingPointName());
  }
 
  if (!m_configFile.empty()) {
    std::string configFile = PathResolverFindCalibFile(m_configFile);
    if (configFile.empty()) {
      ATH_MSG_ERROR("Could not locate " << m_configFile);
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_DEBUG("Get the input PDFs in the tool ");
    TEnv env;
    env.ReadFile(configFile.c_str(), kEnvLocal);
 
    // Get the input PDFs in the tool.
    ATH_MSG_DEBUG("Get the input PDFs in the tool ");
 
    if (!m_pdfFileName
           .empty()) { // If the property was set by the user, take that.
      ATH_MSG_INFO("Setting user specified PDF file " << m_pdfFileName);
      PDFfilename = m_pdfFileName;
    } else {
      if (m_configFile.find("dev/") != std::string::npos) {
        std::string PDFdevval = env.GetValue(
          "inputPDFFileName",
          "ElectronPhotonSelectorTools/offline/mc16_20180716/"
          "ForwardElectronLikelihoodPdfs.root"); // this is the first PDF ever
                                                 // released
        PDFfilename = ("dev/" + PDFdevval);
        ATH_MSG_DEBUG("Getting the input PDFs from: " << PDFfilename);
      } else {
        PDFfilename =
          env.GetValue("inputPDFFileName",
                       "ElectronPhotonSelectorTools/offline/mc16_20180716/"
                       "ForwardElectronLikelihoodPdfs.root");
        ATH_MSG_DEBUG("Getting the input PDFs from: " << PDFfilename);
      }
    }
    std::string filename = PathResolverFindCalibFile(PDFfilename);
 
    if (!filename.empty()) {
      m_rootForwardTool->setPDFFileName(filename);
    } else {
      ATH_MSG_ERROR("Could not find PDF file");
      return StatusCode::FAILURE;
    }
 
    m_rootForwardTool->m_variableNames = env.GetValue("VariableNames", "");
    m_rootForwardTool->m_cutLikelihood =
      AsgConfigHelper::HelperDouble("CutLikelihood", env);
    m_rootForwardTool->m_cutLikelihoodPileupCorrectionA =
      AsgConfigHelper::HelperDouble("DiscCutSlopeForPileupCorrection", env);
    m_rootForwardTool->m_cutLikelihoodPileupCorrectionB =
      AsgConfigHelper::HelperDouble("DiscCutForPileupCorrection", env);
    m_rootForwardTool->m_doPileupCorrection =
      env.GetValue("doPileupCorrection", false);
  } else { // Error if it cant find the conf
    ATH_MSG_ERROR("Could not find configuration file");
    return StatusCode::FAILURE;
  }
 
 
  // Setup primary vertex key handle
  ATH_CHECK(m_primVtxContKey.initialize(m_usePVCont));
 
  // Get the name of the current operating point, and massage the other strings
  // accordingly
  ATH_MSG_VERBOSE(
    "Going to massage the labels based on the provided operating point...");
 
  // Get the message level and set the underlying ROOT tool message level
  // accordingly
  m_rootForwardTool->msg().setLevel(this->msg().level());
 
  // We need to initialize the underlying ROOT TSelectorTool
  if (m_rootForwardTool->initialize().isFailure()) {
    ATH_MSG_ERROR(
      "ERROR! Could not initialize the TForwardElectronLikelihoodTool!");
    return StatusCode::FAILURE;
  }
 
  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, top::TopObjectSelection, 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();
  }

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_configFile

std::string AsgForwardElectronLikelihoodTool::m_configFile

private

Definition at line 163 of file AsgForwardElectronLikelihoodTool.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_nPVdefault

unsigned int AsgForwardElectronLikelihoodTool::m_nPVdefault

private

defualt nPV (when not using PVCont)

Definition at line 172 of file AsgForwardElectronLikelihoodTool.h.

m_pdfFileName

std::string AsgForwardElectronLikelihoodTool::m_pdfFileName

private

The input ROOT file name that holds the PDFs.

Definition at line 183 of file AsgForwardElectronLikelihoodTool.h.

m_primVtxContKey

SG::ReadHandleKey<xAOD::VertexContainer> AsgForwardElectronLikelihoodTool::m_primVtxContKey

private

Initial value:

{
    this,
    "primaryVertexContainer",
    "PrimaryVertices",
    "The primary vertex container name"
  }

read handle key to primary vertex container

Definition at line 175 of file AsgForwardElectronLikelihoodTool.h.

m_rootForwardTool

Root::TForwardElectronLikelihoodTool* AsgForwardElectronLikelihoodTool::m_rootForwardTool

private

Pointer to the underlying ROOT based tool.

Definition at line 166 of file AsgForwardElectronLikelihoodTool.h.

m_usePVCont

bool AsgForwardElectronLikelihoodTool::m_usePVCont

private

Whether to use the PV (not available for trigger)

Definition at line 169 of file AsgForwardElectronLikelihoodTool.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.

m_WorkingPoint

std::string AsgForwardElectronLikelihoodTool::m_WorkingPoint

private

Get the name of the current operating point.

Definition at line 160 of file AsgForwardElectronLikelihoodTool.h.

---

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

• AsgForwardElectronLikelihoodTool.h
• AsgForwardElectronLikelihoodTool.cxx