MissingCellListTool.h Header file for class MissingCellListTool Author: P.A. More...

#include <MissingCellListTool.h>

Inheritance diagram for MissingCellListTool:

Collaboration diagram for MissingCellListTool:

Public Member Functions
	MissingCellListTool (const std::string &name)
	Default constructor: More...

virtual	~MissingCellListTool ()
	Destructor: More...

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

virtual StatusCode	finalize ()

virtual int	execute () const
	Method to be called for each event. 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

virtual int	inputContainerNames (std::vector< std::string > &connames)
	Method to return the list of input containers. More...

virtual int	outputContainerNames (std::vector< std::string > &connames)
	Method to return the list of output containers. More...

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 std::vector< unsigned int >	cellidvec_t

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
cellidvec_t	m_userRemovedCells

cellidvec_t	m_userAddedCells

double	m_rmax

bool	m_addBadCells

bool	m_addCellFromTool

unsigned int	m_larMaskBit

unsigned int	m_tileMaskBit

ServiceHandle< TileCablingSvc >	m_tileCabling

ToolHandle< ITileBadChanTool >	m_tileTool

SG::ReadCondHandleKey< LArBadChannelCont >	m_BCKey

SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloDetDescrMgrKey

SG::ReadHandleKey< CaloCellContainer >	m_cells_name

SG::WriteHandleKey< jet::CaloCellFastMap >	m_badCellMap_key

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

MissingCellListTool.h Header file for class MissingCellListTool Author: P.A.

Builds a missing/bad calo cell map to be used by JetBadChanCorrTool.

Delsart

Builds a missing/bad calo cell map to be used by JetBadChanCorrTool

MissingCellListTool is an IJetExecuteTool which builds and record a list of calo cell. This list is also a special geometrical map which allow to efficiently retrieve all cells around a given (eta,phi) direction.

Some options govern wich cells enter the list : typically permanently disconnected cells, "bad cells" in the sens of CaloCell::badcell(), or user given cells.

MissingCellListTool is an IJetExecuteTool which builds and record a list of calo cell. This list is also a special geometrical map which allow to efficiently retrieve all cells around a given (eta,phi) direction.

Some options govern wich cells enter the list : typically permanently disconnected cells, "bad cells" in the sens of CaloCell::badcell(), or user given cells.

Properties:

Name	Type	Default	Description
UpdateEvery		True	frequency of updating the bad cell list, once or event by event
AddBadCell		True	add cells of container in case badcell()=true
AddCellList		True	add cells given by property
RemoveCellList		True	remove cells given by property
AddCellFromTool		False	add bad cells from bad channel tools
LArMaskBit		( 1<< 0 \| 1<< 2 \| 1<<16 \| 1<<8 \| 1<<11 \| 1<<14 \| 1<<19 )	deadReadout \| deadPhys \| missingFEB \| highNoiseHG \| highNoiseMG \| highNoiseLG \| sporadicBurstNoise
TileMaskBit		( 1<< 0 )	dead
DeltaRmax		1.0	Max cone size in which cells will be searched

Definition at line 110 of file MissingCellListTool.h.

Member Typedef Documentation

◆ cellidvec_t

typedef std::vector<unsigned int> MissingCellListTool::cellidvec_t

private

Definition at line 161 of file MissingCellListTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MissingCellListTool()

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

Default constructor:

Definition at line 32 of file MissingCellListTool.cxx.

                                                               :
   asg::AsgTool  (  name   ),
   m_tileCabling("TileCablingSvc",name),
   m_tileTool("TileBadChanTool",this)
 {
  
   //declareInterface<IMissingCellListTool>( this );  
  
   declareProperty("AddCellList", m_userAddedCells);    
   declareProperty("RemoveCellList", m_userRemovedCells );
   declareProperty("AddBadCells", m_addBadCells=true );
   declareProperty("DeltaRmax", m_rmax=1.0);
   // ported from JetBadChanCorrTool
   declareProperty("AddCellFromTool", m_addCellFromTool = false);
   //608517, deadReadout | deadPhys | missingFEB | highNoiseHG | highNoiseMG | highNoiseLG | spor    adicBurstNoise
   declareProperty("LArMaskBit", m_larMaskBit = ( 1<< 0 | 1<< 2 | 1<<16 | 1<<8 | 1<<11 | 1<<14 | 1<<19 )); 
   declareProperty("TileMaskBit", m_tileMaskBit = ( 1<< 0 )); //1, dead
 }

◆ ~MissingCellListTool()

MissingCellListTool::~MissingCellListTool ( )

virtualdefault

Destructor:

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

◆ execute()

int MissingCellListTool::execute ( ) const

virtual

Method to be called for each event.

Returns 0 for success.

Implements IJetExecuteTool.

Definition at line 83 of file MissingCellListTool.cxx.

                                        {
  
   //cellset_t missingCells;
   auto badandmissingCellsGeomMap = std::make_unique<jet::CaloCellFastMap>();
   jet::cellset_t & badandmissingCells = badandmissingCellsGeomMap->cells();
   badandmissingCellsGeomMap->init(m_rmax);
   
   // get permanently missing cells.
   const std::vector<Identifier> & tiledisconnected = m_tileCabling->disconnectedCells();
   badandmissingCells.insert(tiledisconnected.begin(), tiledisconnected.end());
  
   // from user given cells
   for(cellidvec_t::const_iterator it=m_userAddedCells.begin(); it != m_userAddedCells.end(); ++it){
     badandmissingCells.insert( Identifier(*it) ) ;
   }
   // remove user give cells.
   for(cellidvec_t::const_iterator it=m_userRemovedCells.begin(); it != m_userRemovedCells.end(); ++it){
     badandmissingCells.erase( Identifier(*it) );
   }
   // ---------------------------
  
   SG::ReadCondHandle<CaloDetDescrManager> caloDetDescrMgrHandle {m_caloDetDescrMgrKey};
   const CaloDetDescrManager* caloDDM = *caloDetDescrMgrHandle;
  
   if(m_addBadCells) {
     // (In run1 this part possibly added several times the same cell in the geometric map)
     SG::ReadHandle<CaloCellContainer> cc (m_cells_name);
     if ( !cc.isValid() ) {
       ATH_MSG_ERROR("Unable to retrieve CaloCellContainer AllCalo from event store.");
       return 1;
     }
     const CaloCellContainer * cells = cc.ptr();
     CaloCellContainer::const_iterator it= cells->begin();
     CaloCellContainer::const_iterator itE= cells->end();
     for(; it!=itE; ++it){
       if( (*it)->badcell() ) {
         const CaloCell * c= *it;
         badandmissingCells.insert( c->ID() );
       }
     }
   }
  
  
   if(m_addCellFromTool){
     const CaloCell_ID*  calo_id = caloDDM->getCaloCell_ID();    
     const TileBadChanTool* tileTool = dynamic_cast<const TileBadChanTool*>(m_tileTool.operator->()); 
     SG::ReadCondHandle<LArBadChannelCont> readHandle{m_BCKey};
     const LArBadChannelCont *bcCont {*readHandle};
     if(!bcCont) {
       ATH_MSG_ERROR( "Do not have Bad chan container !!!" );
       return 1;
     }
     std::vector<Identifier>::const_iterator idItr = calo_id->cell_begin();
     std::vector<Identifier>::const_iterator idItrE = calo_id->cell_end();
     for(; idItr!=idItrE; ++idItr){
  
       // check if needs insertion.
       bool insert = false;
       if(calo_id->is_tile(*idItr)){
         CaloBadChannel bc = tileTool->caloStatus(*idItr);
         insert =  (bc.packedData() & m_tileMaskBit) != 0 ;
       } else {
         LArBadChannel bc = bcCont->offlineStatus(*idItr);
         insert = (bc.packedData() & m_larMaskBit)  != 0 ;
       } 
  
       if(insert) {
         badandmissingCells.insert( *idItr );
       }
     }
   }
  
   // fill the geometric map : ------------------
   jet::cellset_t::iterator lit = badandmissingCells.begin();
   jet::cellset_t::iterator litE = badandmissingCells.end();
   for( ; lit != litE; ++lit){
     const CaloDetDescrElement * dde = caloDDM->get_element(*lit);
     jet::CellPosition p(dde->eta(), dde->phi(), *lit, dde->getSampling());
     badandmissingCellsGeomMap->insert( p );
   }  
   // ---------------------------
  
  
   ATH_MSG( DEBUG ) << " total bad and missing "<< badandmissingCells.size() << "  "<< badandmissingCellsGeomMap->size() << endmsg;
  
   SG::WriteHandle<jet::CaloCellFastMap> badCellMap(m_badCellMap_key);
   StatusCode sc = badCellMap.record(std::move(badandmissingCellsGeomMap));
   if (sc.isFailure()) {
     ATH_MSG_ERROR("Unable to record badandmissingCellsGeomMap in event store: "
                   << m_badCellMap_key);
     return 1;
   }
  
   return 0;
 }

◆ 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 MissingCellListTool::finalize ( )

virtual

Definition at line 75 of file MissingCellListTool.cxx.

 {
   ATH_MSG_INFO ("Finalizing " << name() << "...");
  
   return StatusCode::SUCCESS;
 }

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

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode MissingCellListTool::initialize ( )

virtual

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 58 of file MissingCellListTool.cxx.

 {
   ATH_MSG_INFO ("Initializing " << name() << "...");
   CHECK( m_tileCabling.retrieve() );
   //
   ATH_CHECK(m_badCellMap_key.initialize());
   ATH_CHECK(m_caloDetDescrMgrKey.initialize());
   ATH_CHECK(m_cells_name.initialize(m_addBadCells));
   ATH_CHECK(m_BCKey.initialize(m_addCellFromTool));
   if (m_addCellFromTool) {
     ATH_CHECK( m_tileTool.retrieve() );
   } else {
     m_tileTool.disable();
   }
   return StatusCode::SUCCESS;
 }

◆ inputContainerNames()

int IJetExecuteTool::inputContainerNames ( std::vector< std::string > & connames )

virtualinherited

Method to return the list of input containers.

The names of required input containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 11 of file IJetExecuteTool.cxx.

                                                               {
   return 0;
 }

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

◆ outputContainerNames()

int IJetExecuteTool::outputContainerNames ( std::vector< std::string > & connames )

virtualinherited

Method to return the list of output containers.

The names of produced output containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 17 of file IJetExecuteTool.cxx.

                                                                {
   return 0;
 }

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

bool MissingCellListTool::m_addBadCells

private

Definition at line 168 of file MissingCellListTool.h.

◆ m_addCellFromTool

bool MissingCellListTool::m_addCellFromTool

private

Definition at line 169 of file MissingCellListTool.h.

◆ m_badCellMap_key

SG::WriteHandleKey<jet::CaloCellFastMap> MissingCellListTool::m_badCellMap_key

private

Initial value:

{
    this,
    "MissingCellMapName",
    "MissingCaloCellsMap",
    "SG key for missing cell map"
  }

Definition at line 191 of file MissingCellListTool.h.

◆ m_BCKey

SG::ReadCondHandleKey<LArBadChannelCont> MissingCellListTool::m_BCKey

private

Initial value:

{ this,
                                                    "BadChanKey",
                                                    "LArBadChannel",
                                                    "SG bad channels key" }

Definition at line 175 of file MissingCellListTool.h.

◆ m_caloDetDescrMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> MissingCellListTool::m_caloDetDescrMgrKey

private

Initial value:

{
    this,
    "CaloDetDescrManager",
    "CaloDetDescrManager",
    "SG Key for CaloDetDescrManager in the Condition Store"
  }

Definition at line 179 of file MissingCellListTool.h.

◆ m_cells_name

SG::ReadHandleKey<CaloCellContainer> MissingCellListTool::m_cells_name

private

Initial value:

{ this,
                                                     "cells_name",
                                                     "AllCalo",
                                                     "" }

Definition at line 186 of file MissingCellListTool.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_larMaskBit

unsigned int MissingCellListTool::m_larMaskBit

private

Definition at line 170 of file MissingCellListTool.h.

◆ m_rmax

double MissingCellListTool::m_rmax

private

Definition at line 166 of file MissingCellListTool.h.

◆ m_tileCabling

ServiceHandle<TileCablingSvc> MissingCellListTool::m_tileCabling

private

Definition at line 173 of file MissingCellListTool.h.

◆ m_tileMaskBit

unsigned int MissingCellListTool::m_tileMaskBit

private

Definition at line 171 of file MissingCellListTool.h.

◆ m_tileTool

ToolHandle<ITileBadChanTool> MissingCellListTool::m_tileTool

private

Definition at line 174 of file MissingCellListTool.h.

◆ m_userAddedCells

cellidvec_t MissingCellListTool::m_userAddedCells

private

Definition at line 163 of file MissingCellListTool.h.

◆ m_userRemovedCells

cellidvec_t MissingCellListTool::m_userRemovedCells

private

Definition at line 162 of file MissingCellListTool.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

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ cellidvec_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MissingCellListTool()

◆ ~MissingCellListTool()

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]

◆ execute()

◆ extraDeps_update_handler()

◆ finalize()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputContainerNames()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputContainerNames()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_addBadCells

◆ m_addCellFromTool

◆ m_badCellMap_key

◆ m_BCKey

◆ m_caloDetDescrMgrKey

◆ m_cells_name

◆ m_detStore

◆ m_evtStore

◆ m_larMaskBit

◆ m_rmax

◆ m_tileCabling

◆ m_tileMaskBit

◆ m_tileTool

◆ m_userAddedCells

◆ m_userRemovedCells

◆ m_varHandleArraysDeclared

◆ m_vhka