met::METRegionsTool Class Reference

#include <METRegionsTool.h>

Inheritance diagram for met::METRegionsTool:

Collaboration diagram for met::METRegionsTool:

Public Member Functions
virtual StatusCode	execute (xAOD::MissingET *metTerm, xAOD::MissingETComponentMap *metMap) const
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
StatusCode	executeTool (xAOD::MissingET *metTerm, xAOD::MissingETComponentMap *metMap) const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
std::string	m_output_met_key
bool	m_useRapidity

Private Member Functions
	METRegionsTool (const std::string &name)
	~METRegionsTool ()
StatusCode	initialize ()
	Dummy implementation of the initialisation function.
StatusCode	finalize ()
	METRegionsTool ()

Private Attributes
std::string	m_base_met_containerKey
std::string	m_base_met_mapKey
std::string	m_base_met_inputKey
std::vector< float >	m_region_values
std::vector< std::string >	m_region_names
std::vector< std::pair< float, float > >	m_region_eta_values

Detailed Description

Definition at line 25 of file METRegionsTool.h.

Constructor & Destructor Documentation

METRegionsTool() [1/2]

met::METRegionsTool::METRegionsTool ( const std::string & name )

private

Definition at line 45 of file METRegionsTool.cxx.

                                                      :
    AsgTool(name),
    METRefinerTool(name)
  {
    declareProperty( "InputMETContainer" , m_base_met_containerKey = ""  );
    declareProperty( "InputMETMap"       , m_base_met_mapKey       = ""  );
    declareProperty( "InputMETKey"       , m_base_met_inputKey     = ""  ); 
    declareProperty( "RegionValues"      , m_region_values               );
  }

~METRegionsTool()

met::METRegionsTool::~METRegionsTool ( )

privatedefault

METRegionsTool() [2/2]

met::METRegionsTool::METRegionsTool ( )

private

Member Function Documentation

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

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

virtualinherited

Implements IMETToolBase.

Definition at line 59 of file METRefinerTool.cxx.

  {
    ATH_MSG_DEBUG ("In execute: " << name() << "...");
 
    if( metTerm==nullptr ) {
      ATH_MSG_ERROR("Invalid input MissingET pointer provided!");
      return StatusCode::FAILURE;
    }
    if( metMap==nullptr ) {
      ATH_MSG_ERROR("Invalid input MissingETComponentMap pointer provided!");
      return StatusCode::FAILURE;
    }
 
    metTerm->setName(m_output_met_key);
    return this->executeTool(metTerm,metMap);
  }

executeTool()

StatusCode met::METRegionsTool::executeTool ( xAOD::MissingET * metTerm, xAOD::MissingETComponentMap * metMap ) const

protectedvirtual

Implements met::METRefinerTool.

Definition at line 126 of file METRegionsTool.cxx.

  {
    ATH_MSG_DEBUG ("In execute: " << name() << "...");
 
    // First retrieve the BaseMET
    SG::ReadHandle<xAOD::MissingETContainer> base_met_container(m_base_met_containerKey);
    if (!base_met_container.isValid()) {
      ATH_MSG_WARNING("Could not retrieve base MET container!");
      return StatusCode::SUCCESS;
    }
 
 
    // First retrieve the BaseMET
    SG::ReadHandle<xAOD::MissingETComponentMap> base_met_map(m_base_met_mapKey);
    if (!base_met_map.isValid()) {
      ATH_MSG_WARNING("Could not retrieve base MET map!");
      return StatusCode::SUCCESS;
    }
 
 
    // Add to the Container 
    MissingETContainer* metCont = static_cast<MissingETContainer*>( metTerm_central->container() );
    if(!metCont) {
      ATH_MSG_DEBUG("METRegionsTool expecting a MissingETContainer given an inconsistent type.");
      return StatusCode::SUCCESS;
    }
 
    // Get the components of the base MET
    MissingETContainer::const_iterator iterBaseCont = base_met_container->find( m_base_met_inputKey );
    MissingETComponentMap::const_iterator iterBaseConstit = MissingETComposition::find( base_met_map.cptr(), (*iterBaseCont) );
 
    if( iterBaseCont == base_met_container->end() ) {
      ATH_MSG_WARNING("Could not find base MET object " << m_base_met_inputKey << " in MET container!");
      return StatusCode::SUCCESS;
    }
 
    if( iterBaseConstit == base_met_map->end() ) {
      ATH_MSG_WARNING("Could not find base METComponent in MET Map!");
      return StatusCode::SUCCESS;
    }
 
    std::map< std::pair<float,float>, xAOD::MissingET* > mapRangeToMET;
 
    // Create MET term, push to container and maps
    for(unsigned int index=0; index<m_region_values.size(); ++index) {
      MissingET* currentMetTerm;
      if(index == 0) { 
        currentMetTerm = metTerm_central; 
        currentMetTerm->setName( m_base_met_inputKey + "_" + m_region_names.at(index) );
      } else { 
        currentMetTerm = new MissingET(0.,0.,0.);
        ATH_MSG_DEBUG("Adding MET Term " << currentMetTerm->name() << " to MET container" );
        metCont->push_back( currentMetTerm );
    // Should also set the source
        currentMetTerm->setName( m_base_met_inputKey + "_" + m_region_names.at(index) );
        ATH_MSG_DEBUG("Adding MET Term " << currentMetTerm->name() << " to MET map" );
        MissingETComposition::add( metMap, metCont->back() );
      }
      mapRangeToMET.insert(std::pair<std::pair<float,float>,MissingET*>(m_region_eta_values.at(index),metCont->back()));
    }
 
    // Fill the MET terms and maps
    if(!(*iterBaseConstit)->empty()) {
      vector<const IParticle*> objectList = (*iterBaseConstit)->objects();
      vector<const IParticle*> dummyList;
 
      for(const auto *iObj : objectList) {
    MissingETBase::Types::weight_t objWeight = (*iterBaseConstit)->weight(iObj);
        for(auto & it : mapRangeToMET) {
            if( fabs(iObj->eta()) > it.first.first && fabs(iObj->eta()) < it.first.second ) {
              it.second->add(iObj->pt()*cos(iObj->phi())*objWeight.wpx(),
                              iObj->pt()*sin(iObj->phi())*objWeight.wpy(),
                              iObj->pt()*objWeight.wet());
          MissingETComposition::insert( metMap, it.second, iObj, dummyList, objWeight );
            }
        } // end of loop over met terms
      } // end of loop over constituents
    }
 
    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

finalize()

StatusCode met::METRegionsTool::finalize ( )

privatevirtual

Reimplemented from met::METRefinerTool.

Definition at line 115 of file METRegionsTool.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 met::METRegionsTool::initialize ( void )

privatevirtual

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 met::METRefinerTool.

Definition at line 62 of file METRegionsTool.cxx.

  {
    ATH_CHECK( METRefinerTool::initialize() );
    ATH_MSG_VERBOSE ("Initializing " << name() << "...");
 
    ATH_MSG_INFO("Base MET container: " << m_base_met_containerKey);
    ATH_MSG_INFO("Base MET key: " << m_base_met_inputKey);
 
    if( m_base_met_containerKey.empty() || m_base_met_inputKey.empty() ) {
      ATH_MSG_FATAL("Both InputMETContainer and InputMETKey must be provided.");
      return StatusCode::FAILURE;
    }
 
    if( m_region_values.empty()) {
      ATH_MSG_WARNING("Setting up default regions");
      m_region_values.push_back( 1.5);
      m_region_values.push_back( 3.2);
      m_region_values.push_back(10.0);
    } else {
      std::sort(m_region_values.begin(), m_region_values.end()); // Default should be good enough
    } 
 
    // Set the names and eta ranges
    float eta_min = 0., eta_max = 0.;
    for(unsigned int index=0; index<m_region_values.size(); ++index) {
      if(index == 0) { 
        eta_min = 0.; 
        eta_max = m_region_values.at(index);
      } else {
        eta_min = m_region_values.at(index-1);
        eta_max = m_region_values.at(index);
      }
 
      // A few nice formatting
      std::string lowerName = std::to_string(eta_min), higherName = std::to_string(eta_max);
      lowerName.erase(lowerName.find_last_not_of('0') + 1, std::string::npos);
      higherName.erase(higherName.find_last_not_of('0') + 1, std::string::npos);
      if(lowerName[lowerName.size()-1] == '.') lowerName.append("0");
      if(higherName[higherName.size()-1] == '.') higherName.append("0");
      std::replace(lowerName.begin(),lowerName.end(),'.','p'); 
      std::replace(higherName.begin(),higherName.end(),'.','p'); 
 
      // Names
      m_region_names.push_back(lowerName + "_" + higherName);
 
      // Regions
      std::pair<float, float> currentPair(eta_min,eta_max);
      m_region_eta_values.push_back(currentPair);
    }
 
    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()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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 AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

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

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

m_base_met_containerKey

std::string met::METRegionsTool::m_base_met_containerKey

private

Definition at line 51 of file METRegionsTool.h.

m_base_met_inputKey

std::string met::METRegionsTool::m_base_met_inputKey

private

Definition at line 53 of file METRegionsTool.h.

m_base_met_mapKey

std::string met::METRegionsTool::m_base_met_mapKey

private

Definition at line 52 of file METRegionsTool.h.

m_output_met_key

std::string met::METRefinerTool::m_output_met_key

protectedinherited

Definition at line 63 of file METRefinerTool.h.

m_region_eta_values

std::vector<std::pair<float,float> > met::METRegionsTool::m_region_eta_values

private

Definition at line 57 of file METRegionsTool.h.

m_region_names

std::vector<std::string> met::METRegionsTool::m_region_names

private

Definition at line 56 of file METRegionsTool.h.

m_region_values

std::vector<float> met::METRegionsTool::m_region_values

private

Definition at line 55 of file METRegionsTool.h.

m_useRapidity

bool met::METRefinerTool::m_useRapidity

protectedinherited

Definition at line 64 of file METRefinerTool.h.

---

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

• METRegionsTool.h
• METRegionsTool.cxx