calculates out-of-cluster corrections based on cluster quantities More...

#include <CaloLCOutOfClusterTool.h>

Inheritance diagram for CaloLCOutOfClusterTool:

Collaboration diagram for CaloLCOutOfClusterTool:

Public Member Functions
virtual	~CaloLCOutOfClusterTool ()

virtual StatusCode	weight (xAOD::CaloCluster *theCluster, const EventContext &ctx) const override
	method to weight the cells in a cluster More...

virtual StatusCode	initialize () override

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

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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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
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
SG::ReadCondHandleKey< CaloLocalHadCoeff >	m_key
	name of the key for out-of-cluster weights More...

bool	m_useEmProbability
	look for em-probability moment and apply relative weight only More...

bool	m_useHadProbability
	look for em-probability moment and apply relative weight only More...

std::vector< std::string >	m_invalidSamplingNames
	vector of names of the calorimeter samplings not to use when applying the out-of-cluster weights. More...

std::set< int >	m_invalidSamplings
	actual set of samplings to be ignored for out-of-cluster weights More...

bool	m_interpolate
	interpolate correction coefficients More...

bool	m_updateSamplingVars
	update also sampling variables More...

std::vector< std::string >	m_interpolateDimensionNames
	vector of names of dimensions in look-up tables to interpolate More...

std::vector< int >	m_interpolateDimensions
	actual set of dimension id's to interpolate 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

calculates out-of-cluster corrections based on cluster quantities

Version: $Id: CaloLCOutOfClusterTool.h,v 1.3 2009-01-27 09:09:14 gunal Exp $

Author: Sven Menke menke.nosp@m.@mpp.nosp@m.mu.mp.nosp@m.g.de

Date

2-March-2007 concrete class implementing a IClusterCellWeightTool to calculate the out-of-cluster corrections for topo clusters. The cluster moments and its energy are used to derive the correction

therefore the correction is not called cell-by-cell, but for the entire cluster This tool reads its data from pool containing TProfile2D based correction data.

Definition at line 27 of file CaloLCOutOfClusterTool.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

◆ ~CaloLCOutOfClusterTool()

CaloLCOutOfClusterTool::~CaloLCOutOfClusterTool ( )

virtualdefault

◆ CaloLCOutOfClusterTool()

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

Definition at line 33 of file CaloLCOutOfClusterTool.cxx.

   : AthAlgTool(type,name,parent),
     m_key("OOCCorrection"),
     m_useEmProbability(false),
     m_useHadProbability(false),
     m_interpolate(false)
  
 { 
  
   declareInterface<IClusterCellWeightTool>(this);
   m_invalidSamplingNames.resize(3);
  
   m_invalidSamplingNames[0] = "PreSamplerB";
   m_invalidSamplingNames[1] = "PreSamplerE";
   m_invalidSamplingNames[2] = "TileGap3";
  
   declareProperty("CorrectionKey",m_key);
   declareProperty("UseEmProbability",m_useEmProbability);
   declareProperty("UseHadProbability",m_useHadProbability);
   declareProperty("InvalidSamplings",m_invalidSamplingNames);
  
   // Use Interpolation or not
   declareProperty("Interpolate",m_interpolate);
   m_interpolateDimensionNames.resize(3);
   m_interpolateDimensionNames[0] = "DIMO_ENER";
   m_interpolateDimensionNames[1] = "DIMO_ETA";
   m_interpolateDimensionNames[2] = "DIMO_LAMBDA";
   declareProperty("InterpolateDimensionNames", m_interpolateDimensionNames);
   declareProperty("UpdateSamplingVars",m_updateSamplingVars=false);
 }

Member Function Documentation

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

95 { 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.

85 { 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.

90 { 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

◆ initialize()

StatusCode CaloLCOutOfClusterTool::initialize ( )

overridevirtual

Definition at line 66 of file CaloLCOutOfClusterTool.cxx.

 {
   ATH_MSG_INFO( "Initializing " << name()  );
  
   //--- check sampling names to use exclude in correction
   std::vector<std::string>::iterator samplingIter = m_invalidSamplingNames.begin(); 
   std::vector<std::string>::iterator samplingIterEnd = m_invalidSamplingNames.end(); 
   for(; samplingIter!=samplingIterEnd; ++samplingIter) { 
     int theSampling(CaloSampling::Unknown);
     for (unsigned int jsamp = 0;jsamp< CaloSampling::Unknown; jsamp++) {
       if ( *samplingIter == CaloSamplingHelper::getSamplingName((CaloSampling::CaloSample)jsamp)) {
     theSampling = jsamp;
     break;
       }
     }
     if ( theSampling == CaloSampling::Unknown ) {
       msg(MSG::ERROR) << "Calorimeter sampling " 
       << *samplingIter
           << " is not a valid Calorimeter sampling name and will be ignored! "
           << "Valid names are: ";
       for (unsigned int jsamp = 0;jsamp< CaloSampling::Unknown; jsamp++) {
     msg() << CaloSamplingHelper::getSamplingName((CaloSampling::CaloSample)jsamp);
     if ( jsamp < CaloSampling::Unknown-1) 
       msg() << ", ";
     else 
       msg() << ".";
       }
       msg() << endmsg;
     }
     else {
       m_invalidSamplings.insert(theSampling);
     }
   }
  
   msg(MSG::INFO) << "Samplings to exclude from the out-of-cluster weighting:";
   samplingIter = m_invalidSamplingNames.begin(); 
   for(; samplingIter!=samplingIterEnd; ++samplingIter)  
     msg() << " " << *samplingIter;
   msg() << endmsg;
  
   if(m_interpolate) {
     msg(MSG::INFO) << "Interpolation is ON, dimensions: ";
     for(std::vector<std::string>::iterator it=m_interpolateDimensionNames.begin(); it!=m_interpolateDimensionNames.end(); ++it){
       msg() << " " << (*it);
     }
     msg() << endmsg;
     for(std::vector<std::string>::iterator it=m_interpolateDimensionNames.begin(); it!=m_interpolateDimensionNames.end(); ++it){
       CaloLocalHadDefs::LocalHadDimensionId id = CaloLCCoeffHelper::getDimensionId( (*it) );
       if(id!=CaloLocalHadDefs::DIMU_UNKNOWN) {
         m_interpolateDimensions.push_back(int(id));
       }else{
         ATH_MSG_WARNING( "Dimension '" << (*it) << "' is invalid and will be excluded."  );
       }
     }
   }
  
   // callback for conditions data
   ATH_CHECK(  m_key.initialize() );
  
   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()

static const InterfaceID& IClusterCellWeightTool::interfaceID ( )

inlinestaticinherited

Definition at line 28 of file IClusterCellWeightTool.h.

                                           { 
     static const InterfaceID IID_IClusterCellWeightTool("IClusterCellWeightTool", 1 , 0);
     return IID_IClusterCellWeightTool; 
   }

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

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

◆ weight()

StatusCode CaloLCOutOfClusterTool::weight	(	xAOD::CaloCluster *	thisCluster,
		const EventContext &	ctx
	)		const

overridevirtual

method to weight the cells in a cluster

Parameters

theCluster the pointer to the CaloCluster to be weighted

this method is purely virtual because every derived class needs to implement it.

Implements IClusterCellWeightTool.

Definition at line 128 of file CaloLCOutOfClusterTool.cxx.

 {
   double eWeightedOrig = theCluster->e();
   double eWeighted = theCluster->e();
   // get ratio of weighted and em cluster
   double ratio=1.;
   std::vector<float> vars(5);
  
   CaloLCCoeffHelper hp;
  
   double pi0Prob = 0;
   if ( m_useEmProbability || m_useHadProbability) {
     if (!theCluster->retrieveMoment(CaloCluster::EM_PROBABILITY,pi0Prob)) {
       ATH_MSG_WARNING ("Cannot find cluster moment EM_PROBABILITY");
     }
   }
   else if (theCluster->recoStatus().checkStatus(CaloRecoStatus::TAGGEDEM)) {
     pi0Prob = 1.;
   }
   if ( pi0Prob < 0 ) 
     pi0Prob = 0;
   if ( pi0Prob > 1 )
     pi0Prob = 1;
  
   double classifyWeight = 1;
   if ( m_useEmProbability ) {
     classifyWeight = pi0Prob;
   }
   else if ( m_useHadProbability ) {
     classifyWeight = 1-pi0Prob;
   }
   double eEM = theCluster->rawE();
   // basic energy can be 0 if the locking tool option FixBasicEnergy is False
   // in that case simply use the weighted energy ...
   if ( eEM == 0. ) {
     ATH_MSG_DEBUG("Basic Energy is 0. Use weighted energy instead");
     eEM = eWeighted;
   }
   
   
  
   // subtract the samplings to ignore from eEM and eWeighted, assuming that
   // they would not have received any cell weights in prior calibration 
   // steps
   std::set<int>::const_iterator ivSamplingIter = m_invalidSamplings.begin(); 
   std::set<int>::const_iterator ivSamplingIterEnd = m_invalidSamplings.end(); 
   for(; ivSamplingIter!=ivSamplingIterEnd; ++ivSamplingIter) {
     eEM       -= theCluster->eSample((CaloCluster::CaloSample)(*ivSamplingIter));
     eWeighted -= theCluster->eSample((CaloCluster::CaloSample)(*ivSamplingIter));
   }
  
   if ( eEM > 0 && eWeighted > 0 ) {
     // ratio is em energy over weighted energy without the samplings
     // to ignore. This means also the OOC weight tables have to be made 
     // relative to the em energy wihtout the samplings to ignore ...
     ratio = eEM / eWeighted;
  
     if ( ratio < 0.3 || ratio > 3 ) {
       ATH_MSG_DEBUG("The ratio eEM/eWeighted = " 
             << ratio << " is out of normal range [0.3,3]" 
             << " - this mean we have mainly noise ... using 1 instead");
       ratio = 1.0;
     }
     
     double log10cluse = log10(eEM);
  
     SG::ReadCondHandle<CaloLocalHadCoeff> h (m_key,ctx);
     const CaloLocalHadCoeff* data = *h;
     if (!data) {
       ATH_MSG_ERROR("Unable to access conditions object");
       return StatusCode(CaloRecoStatus::TAGGEDUNKNOWN);
     }
  
     const CaloLocalHadCoeff::LocalHadDimension *logeDim = data->getArea(0)->getDimension(2);
     double lemax = logeDim->getXmax()-0.5*logeDim->getDx();
     double lemin = logeDim->getXmin()+0.5*logeDim->getDx();
     if ( log10cluse > lemax ) 
       log10cluse = lemax;
     if ( log10cluse < lemin ) 
       log10cluse = lemin;
  
     double center_lambda,isolation;
     if ( theCluster->retrieveMoment(CaloCluster::ISOLATION,isolation) 
      && theCluster->retrieveMoment(CaloCluster::CENTER_LAMBDA, center_lambda)) {
       if ( isolation > 0 ) {
     if ( center_lambda > 0 ) {
       const double abseta = fabs(theCluster->eta());
       const double log10lambda = log10(center_lambda);
  
       vars[CaloLocalHadDefs::DIMO_SIDE] = static_cast<float> ((theCluster->eta()<0?-1.0:1.0));
       vars[CaloLocalHadDefs::DIMO_PHI] = static_cast<float> (theCluster->phi());
       vars[CaloLocalHadDefs::DIMO_ENER] = static_cast<float> (log10cluse);
       vars[CaloLocalHadDefs::DIMO_ETA] = static_cast<float> (abseta);
       vars[CaloLocalHadDefs::DIMO_LAMBDA] = static_cast<float> (log10lambda);
  
           bool isDataOK = false;
           double oocData(0);
  
           // accessing coefficients (non-interpolated)
           int iBin = data->getBin(0,vars);
           if ( iBin >= 0 ) {
             const CaloLocalHadCoeff::LocalHadCoeff * pData = data->getCoeff(iBin);
             if ( pData && (*pData)[CaloLocalHadDefs::BIN_ENTRIES] > 0 ) {
               isDataOK = true;
               oocData = (*pData)[CaloLocalHadDefs::BIN_WEIGHT];
             }
             if(m_interpolate) {
               // accesing interpolated coefficients
               CaloLocalHadCoeff::LocalHadCoeff parint;
               bool isa = CaloLCCoeffHelper::Interpolate(data, 0,vars,parint, m_interpolateDimensions);
               if(isa && parint[CaloLocalHadDefs::BIN_ENTRIES] > 0) {
                 isDataOK = true;
                 oocData = parint[CaloLocalHadDefs::BIN_WEIGHT];
               }
             }
           }
  
       ATH_MSG_DEBUG("interpolation_ON=" << m_interpolate
             << "isDataOK="<<isDataOK
             << "side = " << vars[0]
             << ", phi = " << vars[1]
             << ", log10cluse = " << log10cluse
             << ", eta = " << abseta
             << ", log10lambda = " << log10lambda
             << ", ratio = " << ratio
             << ", isol = " << isolation
             << ", oocData = " << oocData);
  
           if(isDataOK){
             const double oocWeight = 1.+classifyWeight*isolation*ratio*oocData;
             // loop over all cells
         CaloCluster::cell_iterator itrCell = theCluster->cell_begin();
             CaloCluster::cell_iterator itrCellEnd = theCluster->cell_end();
             for (;itrCell!=itrCellEnd; ++itrCell) {
               CaloPrefetch::nextDDE(itrCell, itrCellEnd);
               const CaloDetDescrElement* cDDE = itrCell->caloDDE();
               if ( cDDE && !m_invalidSamplings.contains(cDDE->getSampling())) { //Fixme ... could use a bit-pattern
                 double weight = itrCell.weight();//theCluster->getCellWeight(itrCell); // fastest!
                 weight *= oocWeight;
                 // reweight cell in cluster
                 theCluster->reweightCell(itrCell,weight);
               } else if (cDDE) {
                 ATH_MSG_DEBUG("Exclude cell with sampling = " << cDDE->getSampling());
               }
             }//cell-loop
         CaloClusterKineHelper::calculateKine(theCluster,true,m_updateSamplingVars);
           }
     } // log10lambda
       } // isolation
     } // moments
   }
   
   // assume that the weighting could be called more than once. In that
   // case eWeighted is the result of the previous step and the current
   // e/eWeighted ratio should be multiplied with the existing
   // OOC_WEIGHT moment
   if ( eWeightedOrig > 0 || eWeightedOrig < 0 ) { 
     double old_weight(1);
     if (!theCluster->retrieveMoment(CaloCluster::OOC_WEIGHT,old_weight)) {
       ATH_MSG_ERROR("Cannot retrieve OOC_WEIGHT cluster moment." );
       return StatusCode::FAILURE;
     }
     const double new_weight = old_weight*theCluster->e()/eWeightedOrig;
     theCluster->insertMoment(CaloCluster::OOC_WEIGHT,new_weight); 
   }
   return StatusCode::SUCCESS;
 }

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_interpolate

bool CaloLCOutOfClusterTool::m_interpolate

private

interpolate correction coefficients

Definition at line 80 of file CaloLCOutOfClusterTool.h.

◆ m_interpolateDimensionNames

std::vector<std::string> CaloLCOutOfClusterTool::m_interpolateDimensionNames

private

vector of names of dimensions in look-up tables to interpolate

Definition at line 88 of file CaloLCOutOfClusterTool.h.

◆ m_interpolateDimensions

std::vector<int> CaloLCOutOfClusterTool::m_interpolateDimensions

private

actual set of dimension id's to interpolate

Definition at line 92 of file CaloLCOutOfClusterTool.h.

◆ m_invalidSamplingNames

std::vector<std::string> CaloLCOutOfClusterTool::m_invalidSamplingNames

private

vector of names of the calorimeter samplings not to use when applying the out-of-cluster weights.

The pre-sampler layers (barrel and endcap) and the gap-scintillators should not receive out-of-cluster weights as they mainly deal with dead-material corrections.

Definition at line 69 of file CaloLCOutOfClusterTool.h.

◆ m_invalidSamplings

std::set<int> CaloLCOutOfClusterTool::m_invalidSamplings

private

actual set of samplings to be ignored for out-of-cluster weights

This set is created according to the names given in the property m_invalidSamplingNames.

Definition at line 76 of file CaloLCOutOfClusterTool.h.

◆ m_key

SG::ReadCondHandleKey<CaloLocalHadCoeff> CaloLCOutOfClusterTool::m_key

private

name of the key for out-of-cluster weights

Definition at line 44 of file CaloLCOutOfClusterTool.h.

◆ m_updateSamplingVars

bool CaloLCOutOfClusterTool::m_updateSamplingVars

private

update also sampling variables

Definition at line 84 of file CaloLCOutOfClusterTool.h.

◆ m_useEmProbability

bool CaloLCOutOfClusterTool::m_useEmProbability

private

look for em-probability moment and apply relative weight only

The classification provides the probability p for the current cluster to be em-like. OOC weights are applied with the additional em-prob factor p to all clusters for the cases EM and HAD.

Definition at line 52 of file CaloLCOutOfClusterTool.h.

◆ m_useHadProbability

bool CaloLCOutOfClusterTool::m_useHadProbability

private

look for em-probability moment and apply relative weight only

The classification provides the probability p for the current cluster to be em-like. OOC weights are applied with the additional had-prob factor (1-p) to all clusters for the cases EM and HAD.

Definition at line 60 of file CaloLCOutOfClusterTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

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

◆ ~CaloLCOutOfClusterTool()

◆ CaloLCOutOfClusterTool()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ weight()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_interpolate

◆ m_interpolateDimensionNames

◆ m_interpolateDimensions

◆ m_invalidSamplingNames

◆ m_invalidSamplings

◆ m_key

◆ m_updateSamplingVars

◆ m_useEmProbability

◆ m_useHadProbability

◆ m_varHandleArraysDeclared

◆ m_vhka