met::METCaloRegionsTool Class Reference

#include <METCaloRegionsTool.h>

Inheritance diagram for met::METCaloRegionsTool:

Collaboration diagram for met::METCaloRegionsTool:

Public Member Functions
	METCaloRegionsTool (const std::string &name)
	~METCaloRegionsTool ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...
virtual StatusCode	execute (xAOD::MissingET *metTerm, xAOD::MissingETComponentMap *metMap) const override
virtual void	print () const
	Print the state of the tool. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Types
enum	CaloRegions {   EMB = 0, EME, FCAL, HEC,   PEMB, PEME, TILE, REGIONS_TOTAL }

Protected Member Functions
bool	accept (const xAOD::IParticle *object) const
bool	resolveOverlap (const xAOD::IParticle *object, xAOD::MissingETComponentMap *metMap, std::vector< const xAOD::IParticle * > &acceptedSignals, MissingETBase::Types::weight_t &objWeight) const
StatusCode	fillCellMet (xAOD::MissingETContainer *metContainer, const CaloCellContainer *caloCellContainer) const
StatusCode	fillClusterMet (xAOD::MissingETContainer *metContainer, const xAOD::CaloClusterContainer *caloClusContainer) 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...

Static Protected Member Functions
static xAOD::MissingET *	findMetTerm (xAOD::MissingETContainer *metContainer, CaloSampling::CaloSample sample)

Protected Attributes
std::string	m_input_data_key
std::string	m_output_met_key
Gaudi::Property< bool >	m_calo_useCells {this, "UseCells", true, ""}
Gaudi::Property< bool >	m_calo_doTriggerMet {this, "DoTriggerMET", true, ""}

Static Protected Attributes
static const std::string	s_CaloRegionNames []

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	METCaloRegionsTool ()
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< CaloNoise >	m_noiseCDOKey {this,"CaloNoiseKey","totalNoise","SG Key of CaloNoise data object"}
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_caloClusterKey {this,"CaloClusterKey","","SG Key of Calo Cluster Collection"}
SG::ReadHandleKey< CaloCellContainer >	m_caloCellKey {this,"CaloCellKey","","SG Key of Calo Cell Container"}
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

Definition at line 51 of file METCaloRegionsTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

CaloRegions

enum met::METCaloRegionsTool::CaloRegions

protected

Enumerator
EMB
EME
FCAL
HEC
PEMB
PEME
TILE
REGIONS_TOTAL

Definition at line 100 of file METCaloRegionsTool.h.

                     {
      EMB = 0,
      EME,
      FCAL,
      HEC,
      PEMB,
      PEME,
      TILE,
      REGIONS_TOTAL
    };

Constructor & Destructor Documentation

METCaloRegionsTool() [1/2]

met::METCaloRegionsTool::METCaloRegionsTool

(

const std::string &

name

)

Definition at line 55 of file METCaloRegionsTool.cxx.

                                                              : 
    AsgTool(name)
  {
  }

~METCaloRegionsTool()

met::METCaloRegionsTool::~METCaloRegionsTool ( )

default

METCaloRegionsTool() [2/2]

met::METCaloRegionsTool::METCaloRegionsTool ( )

private

Member Function Documentation

accept()

bool met::METCaloRegionsTool::accept ( const xAOD::IParticle *  object ) const

protected

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                 {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode met::METCaloRegionsTool::execute ( xAOD::MissingET *  metTerm, xAOD::MissingETComponentMap *  metMap  ) const

overridevirtual

Implements IMETToolBase.

Definition at line 80 of file METCaloRegionsTool.cxx.

  {
 
    ATH_MSG_DEBUG ("In execute: " << name() << "...");
 
    // Create the container and push back the new MET terms 
    MissingETBase::Types::bitmask_t source = MissingETBase::Source::Category::Calo | MissingETBase::Source::clusterEM();
    MissingETContainer* metCont = static_cast<MissingETContainer*>( metTerm_EMB->container() );
 
    // Push region terms to the container
    for( int i=0; i < REGIONS_TOTAL; ++i) {
      // Create the new terms 
      if( i > 0 ) { 
        metCont->push_back( new MissingET(0.,0.,0.) ); 
      }
      // Set Name and Source
      metCont->at(i)->setName( s_CaloRegionNames[i] );      
      metCont->at(i)->setSource( source );      
    }
    // The last term is Trigger MET if asked for by the user
    if( m_calo_useCells && m_calo_doTriggerMet ) {
      std::string termName = "";
      for( int i=0; i<3; ++i) {
        switch(i) {
          case 0: termName = "AllCells"; break;
          case 1: termName = "Cells_Abs2S"; break;
          case 2: termName = "Cells_Abs2S_m5S"; break;
        }
        metCont->push_back( new MissingET(0.,0.,0.) ); 
        metCont->at(REGIONS_TOTAL+i)->setName( termName );      
        metCont->at(REGIONS_TOTAL+i)->setSource( static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Category::Calo) );
      }
    }
      
    StatusCode sc = StatusCode::SUCCESS;
 
    // Either Cells or Clusters
    if(m_calo_useCells) {
      // Retrieve the cell container
      SG::ReadHandle<CaloCellContainer> caloCellCont(m_caloCellKey);
 
      #if defined(XAOD_STANDALONE) || defined(XAOD_ANALYSIS)
      #else
      if (!caloCellCont.isValid()) {
        ATH_MSG_WARNING("Couldn't set up ReadHandle for Calo Cell Container "<<m_caloCellKey.key());
        ATH_MSG_WARNING("Unable to retrieve input cell cluster container");
          return StatusCode::SUCCESS;
 
      }
      #endif
      // Fill MET
      sc = fillCellMet(metCont,caloCellCont.cptr());
    } else {
      // Retrieve the calo container
      SG::ReadHandle<CaloClusterContainer> caloClusCont(m_caloClusterKey);
      if (!caloClusCont.isValid()) {
        ATH_MSG_WARNING("Unable to retrieve input calo cluster container"<<m_caloClusterKey.key());
          return StatusCode::SUCCESS;
 
      }
      // Fill MET
      sc=fillClusterMet(metCont,caloClusCont.cptr());
    } // end if use clusters if/else
 
    // Debug information
    for( int i=0; i < REGIONS_TOTAL; ++i) {
      MissingET* currentTerm = (MissingET*) metCont->at(i);
      if(!currentTerm) continue;
      ATH_MSG_DEBUG ( "MET Calo term name " << currentTerm->name()   << 
                      ", source "           << currentTerm->source() <<
                      ", mpx "              << currentTerm->mpx()    <<
                      ", mpy "              << currentTerm->mpy()    <<
                      ", met "              << currentTerm->met()    <<
                      ", sumet "            << currentTerm->sumet() 
                    );      
    } // end debug information
 
    if(sc.isFailure()) { 
      ATH_MSG_WARNING("Unable to fill cell/cluster MET"); 
    } 
    
    return StatusCode::SUCCESS;
  }

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

fillCellMet()

StatusCode met::METCaloRegionsTool::fillCellMet ( xAOD::MissingETContainer *  metContainer, const CaloCellContainer *  caloCellContainer  ) const

protected

Definition at line 211 of file METCaloRegionsTool.cxx.

  {
    #if defined (XAOD_STANDALONE) || defined(XAOD_ANALYSIS)
    ATH_MSG_WARNING("Cell information is only available in athena framework");
    #else
    SG::ReadCondHandle<CaloNoise> noiseHdl{m_noiseCDOKey};
    const CaloNoise* noiseCDO=*noiseHdl;
    // Loop over all cells
    for (const CaloCell* cell : *caloCellContainer) {
 
      // Retrieve the sampling 
      CaloSampling::CaloSample sample = (CaloSampling::CaloSample) cell->caloDDE()->getSampling();
 
      // Calculate Et/phi
      double e_cell   = cell->energy();
      double et_cell  = e_cell/cosh(cell->eta());
      double phi_cell = cell->phi();
     
      // Find the associated MET 
      MissingET* metTerm  = findMetTerm(metContainer, sample); 
      if(!metTerm) {
        ATH_MSG_WARNING("Invalid calo sample MET pointer");
        continue;
      }
 
      // Add to MET for the Calo regions
      metTerm->add(et_cell*cos(phi_cell),
                   et_cell*sin(phi_cell),
                   et_cell);
 
      // Trigger MET
      if(m_calo_doTriggerMet) {
        #if defined(XAOD_STANDALONE) || defined(XAOD_ANALYSIS)
        double noise_cell = 0;
        #else
        double noise_cell = noiseCDO->getNoise(cell->ID(),cell->gain());
        #endif
        // All cells
        metContainer->at(REGIONS_TOTAL)->add(et_cell*cos(phi_cell),
                                             et_cell*sin(phi_cell),
                                             et_cell);
        // |E| > 2*sigma
        if( fabs(e_cell) <  2.0*noise_cell ) continue;
        metContainer->at(REGIONS_TOTAL+1)->add(et_cell*cos(phi_cell),
                                               et_cell*sin(phi_cell),
                                               et_cell);
        // E > -5*sigma
        if( e_cell       < -5.0*noise_cell ) continue;
        metContainer->at(REGIONS_TOTAL+2)->add(et_cell*cos(phi_cell),
                                               et_cell*sin(phi_cell),
                                               et_cell);
      }
    } // end of loop overall cells
    #endif
    return StatusCode::SUCCESS;
  } // end of fillCellMet

fillClusterMet()

StatusCode met::METCaloRegionsTool::fillClusterMet ( xAOD::MissingETContainer *  metContainer, const xAOD::CaloClusterContainer *  caloClusContainer  ) const

protected

Definition at line 270 of file METCaloRegionsTool.cxx.

  {
 
    // Loop over all clusters
    for(const auto *iClus : *caloClusContainer) {
      // Loop over all samplings
      for(int iSample=CaloSampling::PreSamplerB;
              iSample<=CaloSampling::FCAL2; ++iSample) {
 
        CaloSampling::CaloSample sample = (CaloSampling::CaloSample) iSample;
 
        // Eta is only defined if Energy != 0
        if(fabs(iClus->eSample(sample))>0) {
 
          // Calculate Et/phi
          double et_sample  = iClus->eSample(sample)/cosh(iClus->etaSample(sample));
          double phi_sample = iClus->phiSample(sample);
 
          // Find the associated MET 
          MissingET* metTerm  = findMetTerm(metContainer, sample); 
          if(!metTerm) {
            ATH_MSG_WARNING("Invalid calo sample MET pointer");
            continue;
          }
 
          // Add to MET
          metTerm->add(et_sample*cos(phi_sample),
                       et_sample*sin(phi_sample),
                       et_sample);
        } // end of energy>0 if
      } // end of loop over samplings
    } // end of loop over clusters
    return StatusCode::SUCCESS;
  } // end of fillClusterMet

findMetTerm()

MissingET * met::METCaloRegionsTool::findMetTerm ( xAOD::MissingETContainer *  metContainer, CaloSampling::CaloSample  sample  )

staticprotected

Definition at line 165 of file METCaloRegionsTool.cxx.

  { 
    switch(sample) {
      case CaloSampling::EMB1:
      case CaloSampling::EMB2:
      case CaloSampling::EMB3:
        return metContainer->at(EMB); 
        //
      case CaloSampling::EME1:
      case CaloSampling::EME2:
      case CaloSampling::EME3:
        return metContainer->at(EME); 
        //
      case CaloSampling::FCAL0:
      case CaloSampling::FCAL1:
      case CaloSampling::FCAL2:
        return metContainer->at(FCAL); 
        //
      case CaloSampling::HEC0:
      case CaloSampling::HEC1:
      case CaloSampling::HEC2:
      case CaloSampling::HEC3:
        return metContainer->at(HEC); 
        //
      case CaloSampling::PreSamplerB:
        return metContainer->at(PEMB); 
        //
      case CaloSampling::PreSamplerE:
        return metContainer->at(PEME); 
        //
      case CaloSampling::TileBar0:
      case CaloSampling::TileBar1:
      case CaloSampling::TileBar2:
      case CaloSampling::TileExt0:
      case CaloSampling::TileExt1:
      case CaloSampling::TileExt2:
      case CaloSampling::TileGap1:
      case CaloSampling::TileGap2:
      case CaloSampling::TileGap3:
        return metContainer->at(TILE); 
        //
      default: return nullptr;
    }
  }

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 met::METCaloRegionsTool::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 62 of file METCaloRegionsTool.cxx.

  {
    ATH_MSG_DEBUG("Initializing " << name() << "...");
 
  #if !defined(XAOD_STANDALONE) && !defined(XAOD_ANALYSIS)
    ATH_CHECK( m_noiseCDOKey.initialize() );
  #endif
    // Either Cells or Clusters
    ATH_CHECK( m_caloCellKey.initialize(m_calo_useCells) );
    ATH_CHECK( m_caloClusterKey.initialize(!m_calo_useCells) );
 
    return StatusCode::SUCCESS;
  }

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, top::TopObjectSelection, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

resolveOverlap()

bool met::METCaloRegionsTool::resolveOverlap ( const xAOD::IParticle *  object, xAOD::MissingETComponentMap *  metMap, std::vector< const xAOD::IParticle * > &  acceptedSignals, MissingETBase::Types::weight_t &  objWeight  ) const

protected

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_calo_doTriggerMet

Gaudi::Property<bool> met::METCaloRegionsTool::m_calo_doTriggerMet {this, "DoTriggerMET", true, ""}

protected

Definition at line 82 of file METCaloRegionsTool.h.

m_calo_useCells

Gaudi::Property<bool> met::METCaloRegionsTool::m_calo_useCells {this, "UseCells", true, ""}

protected

Definition at line 81 of file METCaloRegionsTool.h.

m_caloCellKey

SG::ReadHandleKey<CaloCellContainer> met::METCaloRegionsTool::m_caloCellKey {this,"CaloCellKey","","SG Key of Calo Cell Container"}

private

Definition at line 122 of file METCaloRegionsTool.h.

m_caloClusterKey

SG::ReadHandleKey<xAOD::CaloClusterContainer> met::METCaloRegionsTool::m_caloClusterKey {this,"CaloClusterKey","","SG Key of Calo Cluster Collection"}

private

Definition at line 121 of file METCaloRegionsTool.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_input_data_key

std::string met::METCaloRegionsTool::m_input_data_key

protected

Definition at line 79 of file METCaloRegionsTool.h.

m_noiseCDOKey

SG::ReadCondHandleKey<CaloNoise> met::METCaloRegionsTool::m_noiseCDOKey {this,"CaloNoiseKey","totalNoise","SG Key of CaloNoise data object"}

private

Definition at line 119 of file METCaloRegionsTool.h.

m_output_met_key

std::string met::METCaloRegionsTool::m_output_met_key

protected

Definition at line 80 of file METCaloRegionsTool.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.

s_CaloRegionNames

const std::string met::METCaloRegionsTool::s_CaloRegionNames

staticprotected

Initial value:

= 
  {
    "EMB",
    "EME",
    "FCAL",
    "HEC",
    "PEMB",
    "PEME",
    "TILE"
  }

Definition at line 111 of file METCaloRegionsTool.h.

---

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

• METCaloRegionsTool.h
• METCaloRegionsTool.cxx