Tool to check in each sampling that fraction of energy reconstructed is not greater than a certain threshold. More...

#include <egammaCheckEnergyDepositTool.h>

Inheritance diagram for egammaCheckEnergyDepositTool:

Collaboration diagram for egammaCheckEnergyDepositTool:

Public Member Functions
	egammaCheckEnergyDepositTool (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
virtual	~egammaCheckEnergyDepositTool ()=default
	destructor
virtual StatusCode	initialize () override final
	initialize method
virtual StatusCode	finalize () override final
	finalize method
virtual bool	checkFractioninSamplingCluster (const xAOD::CaloCluster *cluster) const override final
	execute method
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods.

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< double >	m_thrE2min
	Threshold on minimum energy reconstructed in 2nd sampling.
Gaudi::Property< double >	m_thrF0max
	Threshold on maximum fraction of energy reconstructed in presampler.
Gaudi::Property< double >	m_thrF1max
	Threshold on maximum fraction of energy reconstructed in 1st sampling.
Gaudi::Property< double >	m_thrF2max
	Threshold on maximum fraction of energy reconstructed in 2nd sampling.
Gaudi::Property< double >	m_thrF3max
	Threshold on maximum fraction of energy reconstructed in 3rd sampling.
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

Tool to check in each sampling that fraction of energy reconstructed is not greater than a certain threshold.

Also make sure there is some minimal energy in the 2nd sampling.

Authors: Frederic Derue

Definition at line 23 of file egammaCheckEnergyDepositTool.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

◆ egammaCheckEnergyDepositTool()

egammaCheckEnergyDepositTool::egammaCheckEnergyDepositTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

constructor

Definition at line 27 of file egammaCheckEnergyDepositTool.cxx.

                                                         :
  AthAlgTool(type, name, parent)
{
  declareInterface<IegammaCheckEnergyDepositTool>(this);
 
}

◆ ~egammaCheckEnergyDepositTool()

virtual egammaCheckEnergyDepositTool::~egammaCheckEnergyDepositTool ( )

virtualdefault

destructor

Member Function Documentation

◆ checkFractioninSamplingCluster()

bool egammaCheckEnergyDepositTool::checkFractioninSamplingCluster ( const xAOD::CaloCluster * cluster ) const

finaloverridevirtual

execute method

Implements IegammaCheckEnergyDepositTool.

Definition at line 49 of file egammaCheckEnergyDepositTool.cxx.

{
 
  // retrieve associated cluster
  if (cluster==nullptr) return false;
 
  // Retrieve energy in all samplings
  double e0 = cluster->energyBE(0);
  double e1 = cluster->energyBE(1);
  double e2 = cluster->energyBE(2);
  double e3 = cluster->energyBE(3);
 
  if (e2<m_thrE2min){
     return false;
  }
  // sum of energy in all samplings
  const double eallsamples = e0+e1+e2+e3;
 
  if (eallsamples!=0.) {
    const double inv_eallsamples = 1. / eallsamples;
 
    // check fraction of energy reconstructed in presampler
    double f0 = e0 * inv_eallsamples;
    if (f0 > m_thrF0max) return false;
 
    // check fraction of energy reconstructed in first sampling
    double f1 = e1 * inv_eallsamples;
    if (f1 > m_thrF1max) return false;
 
    // check fraction of energy reconstructed in second sampling
    double f2 = e2 * inv_eallsamples;
    if (f2 > m_thrF2max) return false;
 
    // check fraction of energy reconstructed in third sampling
    double f3 = e3 * inv_eallsamples;
    if (f3 > m_thrF3max) return false;
  }
 
  return true;
}

◆ 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

◆ 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

◆ finalize()

StatusCode egammaCheckEnergyDepositTool::finalize ( )

finaloverridevirtual

finalize method

Implements IegammaCheckEnergyDepositTool.

Definition at line 44 of file egammaCheckEnergyDepositTool.cxx.

{
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode egammaCheckEnergyDepositTool::initialize ( )

finaloverridevirtual

initialize method

Implements IegammaCheckEnergyDepositTool.

Definition at line 36 of file egammaCheckEnergyDepositTool.cxx.

{
 
  ATH_MSG_DEBUG("Initializing " << name() << "...");
  
  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.

◆ interfaceID()

const InterfaceID & IegammaCheckEnergyDepositTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 50 of file IegammaCheckEnergyDepositTool.h.

{
  return IID_IegammaCheckEnergyDepositTool;
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

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

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ 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_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_thrE2min

Gaudi::Property<double> egammaCheckEnergyDepositTool::m_thrE2min

private

Initial value:

{this, "ThrE2min", 50.,

"Threshold on minimum energy reconstructed in 2nd sampling"}

Threshold on minimum energy reconstructed in 2nd sampling.

Definition at line 42 of file egammaCheckEnergyDepositTool.h.

42 {this, "ThrE2min", 50.,

43 "Threshold on minimum energy reconstructed in 2nd sampling"};

◆ m_thrF0max

Gaudi::Property<double> egammaCheckEnergyDepositTool::m_thrF0max

private

Initial value:

{this, "ThrF0max", 0.9,

"Threshold on maximum fraction of energy reconstructed in presampler"}

Threshold on maximum fraction of energy reconstructed in presampler.

Definition at line 46 of file egammaCheckEnergyDepositTool.h.

46 {this, "ThrF0max", 0.9,

47 "Threshold on maximum fraction of energy reconstructed in presampler"};

◆ m_thrF1max

Gaudi::Property<double> egammaCheckEnergyDepositTool::m_thrF1max

private

Initial value:

{this, "ThrF1max", 0.9,

"Threshold on maximum fraction of energy reconstructed in 1st sampling"}

Threshold on maximum fraction of energy reconstructed in 1st sampling.

Definition at line 50 of file egammaCheckEnergyDepositTool.h.

50 {this, "ThrF1max", 0.9,

51 "Threshold on maximum fraction of energy reconstructed in 1st sampling"};

◆ m_thrF2max

Gaudi::Property<double> egammaCheckEnergyDepositTool::m_thrF2max

private

Initial value:

{this, "ThrF2max", 0.999,

"Threshold on maximum fraction of energy reconstructed in 2nd sampling"}

Threshold on maximum fraction of energy reconstructed in 2nd sampling.

Definition at line 54 of file egammaCheckEnergyDepositTool.h.

54 {this, "ThrF2max", 0.999,

55 "Threshold on maximum fraction of energy reconstructed in 2nd sampling"};

◆ m_thrF3max

Gaudi::Property<double> egammaCheckEnergyDepositTool::m_thrF3max

private

Initial value:

{this, "ThrF3max", 0.8,

"Threshold on maximum fraction of energy reconstructed in 3rd sampling"}

Threshold on maximum fraction of energy reconstructed in 3rd sampling.

Definition at line 58 of file egammaCheckEnergyDepositTool.h.

58 {this, "ThrF3max", 0.8,

59 "Threshold on maximum fraction of energy reconstructed in 3rd sampling"};

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ egammaCheckEnergyDepositTool()

◆ ~egammaCheckEnergyDepositTool()

Member Function Documentation

◆ checkFractioninSamplingCluster()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_thrE2min

◆ m_thrF0max

◆ m_thrF1max

◆ m_thrF2max

◆ m_thrF3max

◆ m_varHandleArraysDeclared

◆ m_vhka