#include <JetBadChanCorrTool.h>

Inheritance diagram for JetBadChanCorrTool:

Collaboration diagram for JetBadChanCorrTool:

Classes
class	ProfileData

Public Member Functions
	JetBadChanCorrTool (const std::string &name)

virtual	~JetBadChanCorrTool ()

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it. More...

virtual StatusCode	setupEvent ()

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

virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier. More...

Protected Member Functions
StatusCode	correctionFromClustersBadCells (const xAOD::JetContainer &jets) const

StatusCode	correctionFromCellsInJet (const xAOD::JetContainer &jets, const jet::CaloCellFastMap *badCellMap) const

float	correctionFromCellsInCone (const xAOD::Jet jet, const jet::CaloCellFastMap badCellMap) const

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
double	getProfile (double pt, double dr, int sample, double eta, double phi) const

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
ServiceHandle< ITHistSvc >	m_thistSvc

Gaudi::Property< std::string >	m_jetContainerName {this, "JetContainer", "", "SG key for the input jet container"}

Gaudi::Property< int >	m_nBadCellLimit {this, "NBadCellLimit", 10000, "Limit to calculate moments"}

Gaudi::Property< std::string >	m_streamName {this, "StreamName", "/JetBadChanCorrTool/", "Stream name"}

Gaudi::Property< std::string >	m_profileName {this, "ProfileName", "JetBadChanCorrTool.root", "Profile name"}

Gaudi::Property< std::string >	m_profileTag {this, "ProfileTag", "", "Profile tag"}

Gaudi::Property< bool >	m_useCone {this, "UseCone", true, "Use cone?"}

Gaudi::Property< bool >	m_useClusters {this, "UseClusters", false, "Use clusters?"}

SG::ReadHandleKey< jet::CaloCellFastMap >	m_badCellMap_key {this, "MissingCellMap", "MissingCaloCellsMap", "SG key for missing cell map"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_corrCellKey {this, "CorrCellDecorKey", "BchCorrCell", "SG key for cell level decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_corrDotxKey {this, "CorrDotxDecorKey", "BchCorrDotx", "SG key for DOTX decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_corrJetKey {this, "CorrJetDecorKey", "BchCorrJet", "SG key for jet level decoration"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_corrJetForCellKey {this, "CorrJetForCellDecorKey", "BchCorrJetForCell", "SG key for JetForCell decoration"}

std::vector< ProfileData >	m_profileDatas [CaloCell_ID::Unknown]

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

JetBadChanCorrTool.

The energy fraction of dead cells are estimated by jet-level estimator using jet profile. Some cells are already corrected in cell-level using neighboring cells, so this fraction is calculated. The estimation by jet-level for those cells corrected in cell-level is also stored to see the difference or combined the corrections.

BCH_CORR_JET= jet level estimation of the energy fraction of dead cells BCH_CORR_CELL= cell level correction, which is already corrected BCH_CORR_JET_FORCELL= jet level estimation for the corrected cells in cell level

The relation and usage of the moment is jet = jet already corrected in cell level jet x ( 1 - BCH_CORR_CELL ) = jet without cell level correction jet x ( 1 - BCH_CORR_CELL + BCH_CORR_JET ) = jet corrected by jet level estimation jet x ( 1 + BCH_CORR_JET - BCH_CORR_JET_FORCELL ) = jet with cell level correction and corrected in jet level for not covered cells

Properties:

Name	Type	Default	Description
ProcessNJetMax		999999
NBadCellLimit		10000	limit to calculate the moments, if exceed, giving up the calculation ie) when Calorimeter off
AttachCorrCell		True	switch to attach BCH_CORR_CELL
AttachCorrDOTX		True	switch to attach BCH_CORR_DOTX
AttachCorrJet		True	switch to attach BCH_CORR_JET
AttachCorrJetForCell		True	switch to attach BCH_CORR_JET_FORCELL
StreamName		"/JetBadChanCorrTool/"	name of stream name
ProfileName		"JetBadChanCorrTool.root"	name of profile data
ProfileTag		""	tag to select profile,"" for all in file
UseCone		True	boundary of correction, cone or only associated cells
ConeDr		0.4	boundary of correction in case UseCone=True
UseCalibScale		False	scale for calculation of the contribution of bad cells
CellCalibrator			calibration tool for cell-level correction

Definition at line 51 of file JetBadChanCorrTool.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

◆ JetBadChanCorrTool()

JetBadChanCorrTool::JetBadChanCorrTool ( const std::string & name )

Definition at line 29 of file JetBadChanCorrTool.cxx.

                                                             :
   asg::AsgTool(name),
   m_thistSvc( "THistSvc", name )
 {
   declareInterface<IJetDecorator>(this);
 }

◆ ~JetBadChanCorrTool()

JetBadChanCorrTool::~JetBadChanCorrTool ( )

virtualdefault

Member Function Documentation

◆ correctionFromCellsInCone()

float JetBadChanCorrTool::correctionFromCellsInCone	(	const xAOD::Jet *	jet,
		const jet::CaloCellFastMap *	badCellMap
	)		const

protected

Definition at line 247 of file JetBadChanCorrTool.cxx.

                                                                                                                   {
  
   ATH_MSG_DEBUG( " Missing cells for cone search "<< badCellMap->size() << "  jet="<< jet->index() << "  R="
                  << jet->getSizeParameter() << "  input="<< jet->getInputType() << "  jet_eta="<<jet->eta() ) ;
  
   double corr_jet_cone=0;
  
   double rawPt = jet->jetP4(xAOD::JetEMScaleMomentum).Pt();
  
   double jeteta = jet->eta();
   double jetphi = jet->phi();
   std::vector<jet::CellPosition> closeCells = badCellMap->cellsInDeltaR(jeteta,jetphi, jet->getSizeParameter() );
   std::vector<jet::CellPosition>::iterator itr = closeCells.begin();
   std::vector<jet::CellPosition>::iterator itrE = closeCells.end();
  
   for(; itr!=itrE; ++itr){
  
     double cell_eta = itr->x();
     double cell_phi = itr->phi();
  
     CaloCell_ID::CaloSample sampling = itr->sampling();
  
     double dr = xAOD::P4Helpers::deltaR(jeteta, jetphi, cell_eta, cell_phi);
     double frac_cell = getProfile(rawPt, dr, sampling, cell_eta, cell_phi);
  
     corr_jet_cone += frac_cell;
   }
  
   return corr_jet_cone;
 }

◆ correctionFromCellsInJet()

StatusCode JetBadChanCorrTool::correctionFromCellsInJet	(	const xAOD::JetContainer &	jets,
		const jet::CaloCellFastMap *	badCellMap
	)		const

protected

Definition at line 165 of file JetBadChanCorrTool.cxx.

                                                                                                                                 {
  
   SG::WriteDecorHandle<xAOD::JetContainer, float> corrCellHandle(m_corrCellKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> corrDotxHandle(m_corrDotxKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> corrJetHandle(m_corrJetKey);
   SG::WriteDecorHandle<xAOD::JetContainer, float> corrJetForCellHandle(m_corrJetForCellKey);
  
   for(const xAOD::Jet* jet : jets){
  
     xAOD::JetFourMom_t p4 = jet->jetP4(xAOD::JetEMScaleMomentum);
     double rawPt = p4.Pt();
     double rawE  = p4.E();
  
     // jet moments, fraction
     double corr_jet_associate=0;
     double corr_jet_forcell=0;
     double corr_cell=0;
     double corr_dotx=0;
  
     jet::JetCellAccessor::const_iterator cellIt =  jet::JetCellAccessor::begin(jet);
     jet::JetCellAccessor::const_iterator cellItE = jet::JetCellAccessor::end(jet);
  
     for( ;cellIt!=cellItE; ++cellIt) {
  
       const CaloDetDescrElement * dde = (*cellIt)->caloDDE();
       const CaloCell *cell = *cellIt;
       double cellWeight = cellIt.weight();
  
       double cell_energy = cell->e() * cellWeight;
  
       CaloCell_ID::CaloSample sampling = dde->getSampling();
  
       bool considerBad = cell->badcell();
       // for bad channels in jet
       if(considerBad){
  
         // determine if this comes from a deadOTX
         bool isOTX = false;
         if(!(dde->is_tile()))
           if(cell->provenance() & 0x0200)
             isOTX = true;
  
         double dr = xAOD::P4Helpers::deltaR(jet->eta(),jet->phi(),dde->eta(), dde->phi());
         double frac_cell = getProfile(rawPt, dr, sampling, dde->eta(), dde->phi());
  
         double frac = frac_cell * cellWeight;
  
         corr_jet_associate += frac;
  
         // corrected in cell-level
         if(cell_energy!=0){
           // for cryo.
           if(isOTX)
             corr_dotx += cell_energy;
           else
             corr_cell += cell_energy;
  
           corr_jet_forcell += frac;
         }
       }
     } // loop over cells
  
     const double inv_rawE = 1. / rawE;
     corr_cell *= inv_rawE;
     corr_dotx *= inv_rawE;
     ATH_MSG( DEBUG ) << "pt=" << jet->pt()/GeV << " eta=" << jet->eta() << " phi=" << jet->phi()
                      << " BCH_CORR_CELL=" << corr_cell
                      << " BCH_CORR_DOTX=" << corr_dotx
                      << " BCH_CORR_JET=" << corr_jet_associate
                      << " BCH_CORR_JET_FORCELL=" << corr_jet_forcell << endmsg;
  
     corrCellHandle(*jet) = corr_cell;
     corrDotxHandle(*jet) = corr_dotx;
     corrJetForCellHandle(*jet) = corr_jet_forcell;
     if(m_useCone)
       corrJetHandle(*jet) = correctionFromCellsInCone(jet, badCellMap);
     else
       corrJetHandle(*jet) = corr_jet_associate;
   }
   return StatusCode::SUCCESS;
 }

◆ correctionFromClustersBadCells()

StatusCode JetBadChanCorrTool::correctionFromClustersBadCells ( const xAOD::JetContainer & jets ) const

protected

Definition at line 278 of file JetBadChanCorrTool.cxx.

                                                                                                 {
  
   SG::WriteDecorHandle<xAOD::JetContainer, float> corrCellHandle(m_corrCellKey);
  
   for(const xAOD::Jet* jet : jets){
  
     double corrCell=0;
  
     size_t nconstit=jet->numConstituents();
     for(size_t i=0; i<nconstit; i++) {
       // use the raw constituents since we're interested only in one moment :
       const xAOD::IParticle* constit = jet->rawConstituent(i);
       if( constit->type() != xAOD::Type::CaloCluster ) continue;
       double badE;
       bool v = static_cast<const xAOD::CaloCluster*>(constit)->retrieveMoment( xAOD::CaloCluster::ENG_BAD_CELLS, badE);
       if(v) corrCell += badE;
     }
  
     double rawE  = jet->jetP4(xAOD::JetEMScaleMomentum).E();
     if(rawE==0) corrCellHandle(*jet) = 0;
     else corrCellHandle(*jet) = corrCell / rawE;
   }
   return StatusCode::SUCCESS;
 }

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

◆ decorate()

StatusCode JetBadChanCorrTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 134 of file JetBadChanCorrTool.cxx.

 {
  
   if(m_useClusters) return correctionFromClustersBadCells(jets);
  
   auto handle = SG::makeHandle (m_badCellMap_key);
   if (!handle.isValid()){
     ATH_MSG_ERROR("Could not retieve bad cell map " << m_badCellMap_key.key());
     return StatusCode::FAILURE;
   }
  
   const auto *badCellMap = handle.cptr();
  
   // number of bad cells exceed the limit, set moments -1 and skip
   if((int) badCellMap->cells().size() >m_nBadCellLimit){
     SG::WriteDecorHandle<xAOD::JetContainer, float> corrCellHandle(m_corrCellKey);
     SG::WriteDecorHandle<xAOD::JetContainer, float> corrDotxHandle(m_corrDotxKey);
     SG::WriteDecorHandle<xAOD::JetContainer, float> corrJetHandle(m_corrJetKey);
     SG::WriteDecorHandle<xAOD::JetContainer, float> corrJetForCellHandle(m_corrJetForCellKey);
     for(const xAOD::Jet* jet : jets){
       corrCellHandle(*jet) = -1.;
       corrDotxHandle(*jet) = -1.;
       corrJetHandle(*jet) = -1.;
       corrJetForCellHandle(*jet) = -1.;
     }
     return StatusCode::SUCCESS;
   }
  
   return correctionFromCellsInJet(jets, badCellMap);
 }

◆ 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

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

◆ getProfile()

double JetBadChanCorrTool::getProfile	(	double	pt,
		double	dr,
		int	sample,
		double	eta,
		double	phi
	)		const

private

Definition at line 303 of file JetBadChanCorrTool.cxx.

                                                                                                     {
   std::vector<ProfileData>::const_iterator itr =m_profileDatas[sample].begin();
   std::vector<ProfileData>::const_iterator itrE =m_profileDatas[sample].end();
   for(; itr!=itrE; ++itr){
     if((*itr).match(pt/GeV,sample,eta,phi)){
       return (*itr).frac(dr);
     }
   }
   return 0;
 }

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode JetBadChanCorrTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 39 of file JetBadChanCorrTool.cxx.

 {
   ATH_MSG_DEBUG("initializing version with data handles");
  
   if(!m_useClusters){
     std::string fname = PathResolver::find_file(m_profileName, "DATAPATH");
  
     if(fname.empty()){
       ATH_MSG(ERROR) << "Could not get file " << m_profileName << endmsg;
       return StatusCode::FAILURE;
     }
     TFile tf(fname.c_str());
     if(!tf.IsOpen()){
       ATH_MSG( ERROR ) << "Could not open file " << fname << endmsg;
       return StatusCode::FAILURE;
     }
     // already registered hists
     std::vector<std::string> histsInSvc = m_thistSvc->getHists();
  
     TListIter next(tf.GetListOfKeys());
     TObject *obj;
     while((obj = next())) {
       std::string hname=obj->GetName();
       if(hname.find('_')==std::string::npos) continue;
       std::string tag = hname.substr(0,hname.find('_'));
       std::string para = hname.substr(hname.find('_')+1);
       std::string location = m_streamName+hname;
  
       if(m_profileTag=="" || m_profileTag==tag){
         // read in histo not registered yet
         if(find(histsInSvc.begin(),histsInSvc.end(),location)==histsInSvc.end()){
           StatusCode sc = m_thistSvc->regHist(location);
           if(sc.isFailure()){
             ATH_MSG( ERROR ) << "failed to read histo " << location << endmsg;
             return StatusCode::FAILURE;
           }
         }
         int sample=0;
         double ptMin=0;
         double ptMax=9999;
         double etaMin=0;
         double etaMax=5.0;
         double phiMin=-M_PI;
         double phiMax=M_PI;
         int ret = sscanf(para.c_str(),"sample%d_pt%lf_%lf_eta%lf_%lf_phi%lf_%lf",
                          &sample,&ptMin,&ptMax,&etaMin,&etaMax,&phiMin,&phiMax);
  
         if(ret<1 || sample<0 || sample>=CaloCell_ID::Unknown) {
           ATH_MSG( DEBUG ) << "Could not understand the name of hist " << obj->GetName() << endmsg;
           continue;
         }
  
         TH1* th=nullptr;
         StatusCode sc = m_thistSvc->getHist(location,th);
         if(sc.isFailure()){
           ATH_MSG( ERROR ) << "failed to get histo " << location << endmsg;
           return StatusCode::FAILURE;
         }
         m_profileDatas[sample].emplace_back((TH1D*)th,sample,ptMin,ptMax,etaMin,etaMax,phiMin,phiMax);
         ATH_MSG( DEBUG ) << "read hist=" << th->GetName() 
                          << " tag=" << tag << " sample=" << sample 
                          << " ptMin=" << ptMin << " ptMax=" << ptMax 
                          << " etaMin=" << etaMin << " etaMax=" << etaMax
                          << " phiMin=" << phiMin << " phiMax=" << phiMax << endmsg;
       }
     }
   }
  
   if(m_jetContainerName.empty()){
     ATH_MSG_ERROR("JetBadChanCorrTool needs to have its input jet container name configured!");
     return StatusCode::FAILURE;
   }
  
   ATH_CHECK(m_badCellMap_key.initialize());
  
   m_corrCellKey = m_jetContainerName + "." + m_corrCellKey.key();
   m_corrDotxKey       = m_jetContainerName + "." + m_corrDotxKey.key();
   m_corrJetKey        = m_jetContainerName + "." + m_corrJetKey.key();
   m_corrJetForCellKey = m_jetContainerName + "." + m_corrJetForCellKey.key();
  
   ATH_CHECK(m_corrCellKey.initialize());
   // These 3 aren't used if we're configured to use clusters
   ATH_CHECK(m_corrDotxKey.initialize(!m_useClusters));
   ATH_CHECK(m_corrJetKey.initialize(!m_useClusters));
   ATH_CHECK(m_corrJetForCellKey.initialize(!m_useClusters));
  
   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.

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32 {return decorate(jets);};

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

◆ setupEvent()

StatusCode JetBadChanCorrTool::setupEvent ( )

virtual

Definition at line 128 of file JetBadChanCorrTool.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_badCellMap_key

SG::ReadHandleKey<jet::CaloCellFastMap> JetBadChanCorrTool::m_badCellMap_key {this, "MissingCellMap", "MissingCaloCellsMap", "SG key for missing cell map"}

private

Definition at line 89 of file JetBadChanCorrTool.h.

◆ m_corrCellKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetBadChanCorrTool::m_corrCellKey {this, "CorrCellDecorKey", "BchCorrCell", "SG key for cell level decoration"}

private

Definition at line 90 of file JetBadChanCorrTool.h.

◆ m_corrDotxKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetBadChanCorrTool::m_corrDotxKey {this, "CorrDotxDecorKey", "BchCorrDotx", "SG key for DOTX decoration"}

private

Definition at line 91 of file JetBadChanCorrTool.h.

◆ m_corrJetForCellKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetBadChanCorrTool::m_corrJetForCellKey {this, "CorrJetForCellDecorKey", "BchCorrJetForCell", "SG key for JetForCell decoration"}

private

Definition at line 93 of file JetBadChanCorrTool.h.

◆ m_corrJetKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetBadChanCorrTool::m_corrJetKey {this, "CorrJetDecorKey", "BchCorrJet", "SG key for jet level decoration"}

private

Definition at line 92 of file JetBadChanCorrTool.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_jetContainerName

Gaudi::Property<std::string> JetBadChanCorrTool::m_jetContainerName {this, "JetContainer", "", "SG key for the input jet container"}

private

Definition at line 78 of file JetBadChanCorrTool.h.

◆ m_nBadCellLimit

Gaudi::Property<int> JetBadChanCorrTool::m_nBadCellLimit {this, "NBadCellLimit", 10000, "Limit to calculate moments"}

private

Definition at line 79 of file JetBadChanCorrTool.h.

◆ m_profileDatas

std::vector<ProfileData> JetBadChanCorrTool::m_profileDatas[CaloCell_ID::Unknown]

private

Definition at line 131 of file JetBadChanCorrTool.h.

◆ m_profileName

Gaudi::Property<std::string> JetBadChanCorrTool::m_profileName {this, "ProfileName", "JetBadChanCorrTool.root", "Profile name"}

private

Definition at line 83 of file JetBadChanCorrTool.h.

◆ m_profileTag

Gaudi::Property<std::string> JetBadChanCorrTool::m_profileTag {this, "ProfileTag", "", "Profile tag"}

private

Definition at line 84 of file JetBadChanCorrTool.h.

◆ m_streamName

Gaudi::Property<std::string> JetBadChanCorrTool::m_streamName {this, "StreamName", "/JetBadChanCorrTool/", "Stream name"}

private

Definition at line 82 of file JetBadChanCorrTool.h.

◆ m_thistSvc

ServiceHandle<ITHistSvc> JetBadChanCorrTool::m_thistSvc

private

Definition at line 76 of file JetBadChanCorrTool.h.

◆ m_useClusters

Gaudi::Property<bool> JetBadChanCorrTool::m_useClusters {this, "UseClusters", false, "Use clusters?"}

private

Definition at line 87 of file JetBadChanCorrTool.h.

◆ m_useCone

Gaudi::Property<bool> JetBadChanCorrTool::m_useCone {this, "UseCone", true, "Use cone?"}

private

Definition at line 86 of file JetBadChanCorrTool.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:

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetBadChanCorrTool()

◆ ~JetBadChanCorrTool()

Member Function Documentation

◆ correctionFromCellsInCone()

◆ correctionFromCellsInJet()

◆ correctionFromClustersBadCells()

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

◆ decorate()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProfile()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ setupEvent()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_badCellMap_key

◆ m_corrCellKey

◆ m_corrDotxKey

◆ m_corrJetForCellKey

◆ m_corrJetKey

◆ m_detStore

◆ m_evtStore

◆ m_jetContainerName

◆ m_nBadCellLimit

◆ m_profileDatas

◆ m_profileName

◆ m_profileTag

◆ m_streamName

◆ m_thistSvc

◆ m_useClusters

◆ m_useCone

◆ m_varHandleArraysDeclared

◆ m_vhka