met::METTrackFilterTool Class Reference

#include <METTrackFilterTool.h>

Inheritance diagram for met::METTrackFilterTool:

Collaboration diagram for met::METTrackFilterTool:

Public Member Functions
	METTrackFilterTool (const std::string &name)
	~METTrackFilterTool ()
StatusCode	initialize ()
	Dummy implementation of the initialisation function. More...
StatusCode	finalize ()
virtual StatusCode	execute (xAOD::MissingET *metTerm, xAOD::MissingETComponentMap *metMap) const
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 Member Functions
StatusCode	executeTool (xAOD::MissingET *metTerm, xAOD::MissingETComponentMap *metMap) const
bool	isGoodEoverP (const xAOD::TrackParticle *trk, const std::vector< const xAOD::TrackParticle * > &trkList, const xAOD::CaloClusterContainer *clusters) 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...

Protected Attributes
std::string	m_output_met_key
bool	m_useRapidity

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	METTrackFilterTool ()
StatusCode	buildTrackMET (xAOD::MissingETComponentMap *const metMap, xAOD::MissingET *const metTerm, const xAOD::Vertex *const pv, const std::vector< const xAOD::Electron * > &selElectrons, const std::vector< const xAOD::Muon * > &selMuons, const std::vector< const xAOD::TrackParticle * > &softTracks) 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...

Static Private Member Functions
static bool	isElTrack (const xAOD::TrackParticle &trk, const std::vector< const xAOD::Electron * > &electrons, size_t &el_index)
static bool	isMuTrack (const xAOD::TrackParticle &trk, const std::vector< const xAOD::Muon * > &muons)
static void	selectElectrons (const xAOD::ElectronContainer &elCont, std::vector< const xAOD::Electron * > &electrons)
static void	selectMuons (const xAOD::MuonContainer &muCont, std::vector< const xAOD::Muon * > &muons)

Private Attributes
ToolHandle< InDet::IInDetTrackSelectionTool >	m_trkseltool {this,"TrackSelectorTool","",""}
ToolHandle< CP::ITrackVertexAssociationTool >	m_trkToVertexTool {this,"TrackVxAssocTool","",""}
ToolHandle< xAOD::ITrackIsolationTool >	m_trkIsolationTool {this,"TrackIsolationTool","",""}
ToolHandle< xAOD::ICaloTopoClusterIsolationTool >	m_caloIsolationTool {this,"CaloIsolationTool","",""}
bool	m_trk_doPVsel
SG::ReadHandleKey< xAOD::ElectronContainer >	m_el_inputkey {this,"InputElectronKey","Electrons",""}
SG::ReadHandleKey< xAOD::MuonContainer >	m_mu_inputkey {this,"InputMuonKey","Muons",""}
SG::ReadHandleKey< xAOD::VertexContainer >	m_pv_inputkey {this,"InputPVKey","PrimaryVertices",""}
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_cl_inputkey {this,"InputClusterKey","CaloCalTopoClusters",""}
bool	m_doVxSep
bool	m_doLepRecovery
bool	m_useIsolationTools
bool	m_trk_doEoverPsel
double	m_cenTrackPtThr
double	m_forTrackPtThr
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 47 of file METTrackFilterTool.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

METTrackFilterTool() [1/2]

met::METTrackFilterTool::METTrackFilterTool

(

const std::string &

name

)

Definition at line 55 of file METTrackFilterTool.cxx.

                                                              : 
    AsgTool(name),
    METRefinerTool(name)
  {
    declareProperty( "DoPVSel",            m_trk_doPVsel = true                 );
    declareProperty( "DoEoverPSel",        m_trk_doEoverPsel = false            );
    declareProperty( "DoVxSep",            m_doVxSep = false                    );
    declareProperty( "DoLepRecovery",      m_doLepRecovery=false                );
    declareProperty( "UseIsolationTools",  m_useIsolationTools=true             );
    declareProperty( "CentralTrackPtThr",  m_cenTrackPtThr = 200e+3             );
    declareProperty( "ForwardTrackPtThr",  m_forTrackPtThr = 120e+3             );
  }

~METTrackFilterTool()

met::METTrackFilterTool::~METTrackFilterTool ( )

default

METTrackFilterTool() [2/2]

met::METTrackFilterTool::METTrackFilterTool ( )

private

Member Function Documentation

buildTrackMET()

StatusCode met::METTrackFilterTool::buildTrackMET ( xAOD::MissingETComponentMap *const  metMap, xAOD::MissingET *const  metTerm, const xAOD::Vertex *const  pv, const std::vector< const xAOD::Electron * > &  selElectrons, const std::vector< const xAOD::Muon * > &  selMuons, const std::vector< const xAOD::TrackParticle * > &  softTracks  ) const

private

Definition at line 310 of file METTrackFilterTool.cxx.

                                                                                        {
 
    vector<const IParticle*> dummyList;
    MissingETBase::Types::weight_t unitWeight(1.,1.,1.);
 
    const MissingETComponent* metComp = MissingETComposition::getComponent(metMap,metTerm);
    if(!metComp) {
      ATH_MSG_WARNING("Failed to find MissingETComponent for MET term " << metTerm->name());
      return StatusCode::FAILURE;
    }
    // Loop over the tracks and select only good ones
    for( const auto& trk : softTracks ) {
      // Could/should use common implementation of addToMET here -- derive builder and refiner from a common base tool?
      bool passFilters = true;
      SG::ReadHandle<xAOD::CaloClusterContainer> tcCont(m_cl_inputkey);
      if (!tcCont.isValid()) {
      ATH_MSG_WARNING("Unable to retrieve topocluster container " << m_cl_inputkey << " for overlap removal");
      }
      if(m_trk_doEoverPsel && !isGoodEoverP(trk,softTracks,tcCont.cptr())) passFilters = false;
      if(m_trk_doPVsel) {
    if(!(m_trkseltool->accept( *trk, pv ))) passFilters=false;
      } else {
    if(!(m_trkseltool->accept( trk ))) passFilters=false;
      }
 
      bool isMuon=false;
      bool isElectron=false;
      size_t el_index=-1;
 
      if(m_doLepRecovery) {
        isMuon=isMuTrack(*trk,selMuons);
        isElectron=isElTrack(*trk,selElectrons, el_index);
      }
 
      bool isLepton=(isMuon||isElectron);
 
      if(passFilters || (m_doLepRecovery && isLepton)) {
        if(!passFilters && isElectron && m_doLepRecovery) {
      //electron track fails, replace with electron pt
          const Electron* el = selElectrons[el_index];
 
          metTerm->add(el->pt()*cos(trk->phi()),
              el->pt()*sin(trk->phi()),
              el->pt());
          MissingETComposition::insert(metMap,metTerm,el,dummyList,unitWeight);
        } else {
      metTerm->add(trk->pt()*cos(trk->phi()),trk->pt()*sin(trk->phi()),trk->pt());
      MissingETComposition::insert(metMap,metTerm,trk,dummyList,unitWeight);
      ATH_MSG_VERBOSE("METTerm " << metTerm->name() <<" sumpt: " << metTerm->sumet());
        }
      }
    }
    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());
  }

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::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::METTrackFilterTool::executeTool ( xAOD::MissingET *  metTerm, xAOD::MissingETComponentMap *  metMap  ) const

protectedvirtual

Implements met::METRefinerTool.

Definition at line 198 of file METTrackFilterTool.cxx.

  {
 
    ATH_MSG_DEBUG ("In execute: " << name() << "...");
 
    std::vector<const xAOD::Electron*> selElectrons;
    std::vector<const xAOD::Muon*> selMuons;
 
    if(m_doLepRecovery)
      {
        SG::ReadHandle<xAOD::ElectronContainer> elCont(m_el_inputkey);
        if (!elCont.isValid()) {
          ATH_MSG_WARNING("Unable to retrieve electron container " << m_el_inputkey.key());
          return StatusCode::SUCCESS;
        } else { 
      selectElectrons(*elCont, selElectrons); 
    } 
        SG::ReadHandle<xAOD::MuonContainer> muCont(m_mu_inputkey);
        if (!muCont.isValid()) {
          ATH_MSG_WARNING("Unable to retrieve muon container " << m_mu_inputkey.key());
          return StatusCode::SUCCESS;
        } else { 
      selectMuons(*muCont, selMuons); 
    } 
 
      }     
 
    MissingETComponentMap::iterator iter = MissingETComposition::find(metMap,metTerm);
    if(iter==metMap->end()) {
      ATH_MSG_WARNING("Could not find current METComponent in MET Map!");
      return StatusCode::FAILURE;
    }
    MissingETComponent* newComp = *iter;
    newComp->setStatusWord(MissingETBase::Status::Tags::correctedTerm(MissingETBase::Status::Vertex::Nominal,
                                                                      MissingETBase::Status::Correction::PileupTrack));
 
    // Extract the component corresponding to the Track SoftTerms
    MissingETBase::Types::bitmask_t src_ST_idTrk = MissingETBase::Source::Type::SoftEvent | MissingETBase::Source::idTrack();
    MissingETBase::Types::bitmask_t src_ST_refTrk = MissingETBase::Source::softEvent() | MissingETBase::Source::track();
    metTerm->setSource(src_ST_refTrk);
 
    MissingETComponentMap::const_iterator citer = MissingETComposition::find(metMap,src_ST_idTrk);
    if(citer==metMap->end()) {
      ATH_MSG_WARNING("Could not find Soft ID Track component in MET Map!");
      return StatusCode::FAILURE;
    }
    vector<const TrackParticle*> softTracks;
    softTracks.reserve((*citer)->size());
    for(const auto& obj : (*citer)->objects()) {
      const TrackParticle* trk = dynamic_cast<const TrackParticle*>(obj);
      if(trk) {softTracks.push_back(trk);}
      else {ATH_MSG_WARNING("Track filter given an object of type " << obj->type());}
    }
 
    const Vertex* pv=nullptr;
    SG::ReadHandle<xAOD::VertexContainer> vxCont(m_pv_inputkey);
    if (!vxCont.isValid()) {
      ATH_MSG_WARNING("Unable to retrieve input primary vertex container");
    }
    vector<const Vertex*> vertices;
 
    if(m_trk_doPVsel) {
      if(!vxCont->empty()) {
    vertices.reserve(vxCont->size());
    for(const auto *const vx : *vxCont) {
      if(vx->vertexType()==VxType::PriVtx) {pv = vx;}
      vertices.push_back(vx);
    }
      } else{
    ATH_MSG_WARNING("Event has no primary vertices");
    return StatusCode::FAILURE;
      }
      if(pv) { ATH_MSG_DEBUG("Main primary vertex has z = " << pv->z()); }
      else {
    ATH_MSG_DEBUG("Did not find a primary vertex in the container. Reject all tracks.");
    return StatusCode::SUCCESS;
      }
    }
 
    if(m_doVxSep) {
      xAOD::TrackVertexAssociationMap trktovxmap=m_trkToVertexTool->getUniqueMatchMap(softTracks, vertices);
 
      // initialize metContainer and metTerm
      MissingETContainer* metCont = static_cast<MissingETContainer*>( metTerm->container() );
 
      bool firstVx(true);
      std::string basename = metTerm->name()+"_vx";
      for(const auto *const vx : *vxCont){
    if(vx->vertexType()==VxType::PriVtx || vx->vertexType()==VxType::PileUp) {
      MissingET *met_vx = metTerm;
      if(!firstVx) {
        met_vx = new MissingET(0. ,0. ,0. );
        metCont->push_back(met_vx);
        met_vx->setSource(metTerm->source());
        MissingETComposition::add(metMap, met_vx);
      }
      met_vx->setName(basename+std::to_string(vx->index()));
      ATH_MSG_VERBOSE("Building " << met_vx->name());
 
      ATH_MSG_VERBOSE("Number of tracks associated to vertex " << vx->index() << ": "<< (trktovxmap[vx]).size());
      
      ATH_CHECK( buildTrackMET(metMap,met_vx,vx,selElectrons,selMuons,trktovxmap[vx]) );
      firstVx = false;
    }
      }
    } else {
      ATH_CHECK( buildTrackMET(metMap,metTerm,pv,selElectrons,selMuons,softTracks) );
    }
 
    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::METTrackFilterTool::finalize ( )

virtual

Reimplemented from met::METRefinerTool.

Definition at line 96 of file METTrackFilterTool.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::METTrackFilterTool::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 met::METRefinerTool.

Definition at line 75 of file METTrackFilterTool.cxx.

  {
    ATH_CHECK( METRefinerTool::initialize() );
    ATH_MSG_INFO ("Initializing " << name() << "...");
    ATH_CHECK(m_trkseltool.retrieve());
    ATH_CHECK(m_trkToVertexTool.retrieve());
    ATH_CHECK(m_trkIsolationTool.retrieve());
    ATH_CHECK(m_caloIsolationTool.retrieve());
 
    if(m_doVxSep) ATH_MSG_INFO("Building TrackMET for each vertex");
 
    ATH_CHECK( m_cl_inputkey.initialize());
    ATH_CHECK( m_pv_inputkey.initialize());
    if(m_doLepRecovery){
      ATH_CHECK( m_el_inputkey.initialize());
      ATH_CHECK( m_mu_inputkey.initialize());
    }
 
    return StatusCode::SUCCESS;
  }

inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

isElTrack()

bool met::METTrackFilterTool::isElTrack ( const xAOD::TrackParticle &  trk, const std::vector< const xAOD::Electron * > &  electrons, size_t &  el_index  )

staticprivate

Definition at line 370 of file METTrackFilterTool.cxx.

  {
    for(unsigned int eli=0; eli<electrons.size(); ++eli) {
      const xAOD::Electron *el=electrons.at(eli);
      if(&trk==xAOD::EgammaHelpers::getOriginalTrackParticleFromGSF(el->trackParticle())) {
    el_index=eli;
    return true;
      }
    }
    return false;
  }

isGoodEoverP()

bool met::METTrackFilterTool::isGoodEoverP ( const xAOD::TrackParticle *  trk, const std::vector< const xAOD::TrackParticle * > &  trkList, const xAOD::CaloClusterContainer *  clusters  ) const

protected

Definition at line 117 of file METTrackFilterTool.cxx.

                                                                    {
 
    if( (fabs(trk->eta())<1.5 && trk->pt()>m_cenTrackPtThr) ||
        (fabs(trk->eta())>=1.5 && trk->pt()>m_forTrackPtThr) ) {
 
      // Get relative error on qoverp
      float Rerr = Amg::error(trk->definingParametersCovMatrix(),4)/fabs(trk->qOverP());
      ATH_MSG_VERBOSE( "Track momentum error (%): " << Rerr*100 );
 
      // first compute track and calo isolation variables
      float ptcone20 = 0., isolfrac = 0., etcone10 = 0., EoverP = 0.;
      if(!m_useIsolationTools) {
        ATH_MSG_VERBOSE( "Using OLD track isolation setup");
        // ptcone
        for(const auto& obj : trkList) {
          if(obj->type() == xAOD::Type::TrackParticle) {
            const TrackParticle* testtrk = static_cast<const TrackParticle*>(obj);
            if(testtrk==trk) continue;
            if (xAOD::P4Helpers::isInDeltaR(*testtrk,*trk,0.2,m_useRapidity)) {
              ptcone20 += testtrk->pt();
            } 
          }
          else {ATH_MSG_WARNING("METTrackFilterTool::isGoodEoveP given an object of type " << obj->type());}
        }
        isolfrac = ptcone20 / trk->pt();
        // etcone
        for(const auto *const clus : *clusters) {
          if (xAOD::P4Helpers::isInDeltaR(*clus,*trk,0.1,m_useRapidity)) {
            etcone10 += clus->pt();
          }
        }
        EoverP = etcone10/trk->pt();
      } 
      else {
        ATH_MSG_VERBOSE( "Using NEW track isolation setup");
        // ptcone
        TrackIsolation trkIsoResult;
        std::vector<Iso::IsolationType> trkIsoCones; 
        trkIsoCones.push_back(xAOD::Iso::IsolationType::ptcone20);
        xAOD::TrackCorrection trkIsoCorr;
        trkIsoCorr.trackbitset.set(xAOD::Iso::IsolationTrackCorrection::coreTrackPtr); 
        m_trkIsolationTool->trackIsolation(trkIsoResult,
                                           *trk,
                                           trkIsoCones,
                                           trkIsoCorr);
        ptcone20 = !trkIsoResult.ptcones.empty() ? trkIsoResult.ptcones[0] : 0;
        isolfrac = ptcone20/trk->pt();
        // etcone
        CaloIsolation caloIsoResult_coreCone;
        std::vector<Iso::IsolationType> caloIsoCones_coreCone; 
        caloIsoCones_coreCone.push_back(xAOD::Iso::IsolationType::etcone20); 
        xAOD::CaloCorrection caloIsoCorr_coreCone;
        caloIsoCorr_coreCone.calobitset.set(xAOD::Iso::IsolationCaloCorrection::coreCone); 
        m_caloIsolationTool->caloTopoClusterIsolation(caloIsoResult_coreCone,
                                                      *trk,
                                                      caloIsoCones_coreCone,
                                                      caloIsoCorr_coreCone);
        etcone10 =  !caloIsoResult_coreCone.etcones.empty() ? 
                    caloIsoResult_coreCone.coreCorrections[xAOD::Iso::IsolationCaloCorrection::coreCone][xAOD::Iso::IsolationCorrectionParameter::coreEnergy] : 0.;
        EoverP   =  etcone10/trk->pt(); 
      }
      ATH_MSG_VERBOSE( "Track isolation fraction: " << isolfrac );
      ATH_MSG_VERBOSE( "Track E/P = " << EoverP );
 
      if(isolfrac<0.1) {
        // isolated track cuts
        if(Rerr>0.4) return false;
        else if (EoverP<0.65 && ((EoverP>0.1 && Rerr>0.05) || Rerr>0.1)) return false;
          } else {
        // non-isolated track cuts
        float trkptsum = ptcone20+trk->pt();
        if(etcone10/trkptsum<0.6 && trk->pt()/trkptsum>0.6) return false;
      }
    }
 
    return true;
  }

isMuTrack()

bool met::METTrackFilterTool::isMuTrack ( const xAOD::TrackParticle &  trk, const std::vector< const xAOD::Muon * > &  muons  )

staticprivate

Definition at line 382 of file METTrackFilterTool.cxx.

  {
    for(const auto *muon : muons) {
      //        if(((muon_list.at(mui))->trackParticle(xAOD::Muon::InnerDetectorTrackParticle))->pt()==trk->pt())
      if((muon->trackParticle(xAOD::Muon::InnerDetectorTrackParticle))==&trk) {
    return true;
      }
    }
    return false;
  }

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

selectElectrons()

void met::METTrackFilterTool::selectElectrons ( const xAOD::ElectronContainer &  elCont, std::vector< const xAOD::Electron * > &  electrons  )

staticprivate

Definition at line 393 of file METTrackFilterTool.cxx.

  {
    for(const auto *el : elCont) {
      if( (el)->author()&0x1  //electron author
      && (el)->pt()>10000   // electron pt
      && fabs(el->eta())<2.47  // electron eta
          ) {
    if((fabs((el)->eta())<=1.37) || (fabs((el)->eta())>=1.52) ) {
      // crack region
      electrons.push_back(el);
    }
      }
    }
  }

selectMuons()

void met::METTrackFilterTool::selectMuons ( const xAOD::MuonContainer &  muCont, std::vector< const xAOD::Muon * > &  muons  )

staticprivate

Definition at line 409 of file METTrackFilterTool.cxx.

  {
    for(const auto *mu : muCont) {
      if( (mu->muonType()==xAOD::Muon::Combined)
      && (mu->pt()>6000.)
      && fabs(mu->eta())<2.5
      ) {
    muons.push_back(mu);
      }
    }
  }

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_caloIsolationTool

ToolHandle<xAOD::ICaloTopoClusterIsolationTool> met::METTrackFilterTool::m_caloIsolationTool {this,"CaloIsolationTool","",""}

private

Definition at line 96 of file METTrackFilterTool.h.

m_cenTrackPtThr

double met::METTrackFilterTool::m_cenTrackPtThr

private

Definition at line 114 of file METTrackFilterTool.h.

m_cl_inputkey

SG::ReadHandleKey<xAOD::CaloClusterContainer> met::METTrackFilterTool::m_cl_inputkey {this,"InputClusterKey","CaloCalTopoClusters",""}

private

Definition at line 106 of file METTrackFilterTool.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_doLepRecovery

bool met::METTrackFilterTool::m_doLepRecovery

private

Definition at line 109 of file METTrackFilterTool.h.

m_doVxSep

bool met::METTrackFilterTool::m_doVxSep

private

Definition at line 108 of file METTrackFilterTool.h.

m_el_inputkey

SG::ReadHandleKey<xAOD::ElectronContainer> met::METTrackFilterTool::m_el_inputkey {this,"InputElectronKey","Electrons",""}

private

Definition at line 103 of file METTrackFilterTool.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_forTrackPtThr

double met::METTrackFilterTool::m_forTrackPtThr

private

Definition at line 115 of file METTrackFilterTool.h.

m_mu_inputkey

SG::ReadHandleKey<xAOD::MuonContainer> met::METTrackFilterTool::m_mu_inputkey {this,"InputMuonKey","Muons",""}

private

Definition at line 104 of file METTrackFilterTool.h.

m_output_met_key

std::string met::METRefinerTool::m_output_met_key

protectedinherited

Definition at line 63 of file METRefinerTool.h.

m_pv_inputkey

SG::ReadHandleKey<xAOD::VertexContainer> met::METTrackFilterTool::m_pv_inputkey {this,"InputPVKey","PrimaryVertices",""}

private

Definition at line 105 of file METTrackFilterTool.h.

m_trk_doEoverPsel

bool met::METTrackFilterTool::m_trk_doEoverPsel

private

Definition at line 112 of file METTrackFilterTool.h.

m_trk_doPVsel

bool met::METTrackFilterTool::m_trk_doPVsel

private

Definition at line 101 of file METTrackFilterTool.h.

m_trkIsolationTool

ToolHandle<xAOD::ITrackIsolationTool> met::METTrackFilterTool::m_trkIsolationTool {this,"TrackIsolationTool","",""}

private

Definition at line 95 of file METTrackFilterTool.h.

m_trkseltool

ToolHandle<InDet::IInDetTrackSelectionTool> met::METTrackFilterTool::m_trkseltool {this,"TrackSelectorTool","",""}

private

Definition at line 93 of file METTrackFilterTool.h.

m_trkToVertexTool

ToolHandle<CP::ITrackVertexAssociationTool> met::METTrackFilterTool::m_trkToVertexTool {this,"TrackVxAssocTool","",""}

private

Definition at line 94 of file METTrackFilterTool.h.

m_useIsolationTools

bool met::METTrackFilterTool::m_useIsolationTools

private

Definition at line 110 of file METTrackFilterTool.h.

m_useRapidity

bool met::METRefinerTool::m_useRapidity

protectedinherited

Definition at line 64 of file METRefinerTool.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:

• METTrackFilterTool.h
• METTrackFilterTool.cxx