#include <VertexRoiSelectionTool.h>

Inheritance diagram for IDTPM::VertexRoiSelectionTool:

Collaboration diagram for IDTPM::VertexRoiSelectionTool:

Public Member Functions
	ASG_TOOL_CLASS (VertexRoiSelectionTool, IAsgTool)
	VertexRoiSelectionTool (const std::string &name)
	Constructor.
virtual	~VertexRoiSelectionTool ()=default
	Destructor.
virtual StatusCode	initialize () override
	Initialize.
StatusCode	selectVerticesInRoI (TrackAnalysisCollections &trkAnaColls, const ElementLink< TrigRoiDescriptorCollection > &roiLink)
	Main Vertex selection method.
template<class V>
bool	accept (const V &v, const TrigRoiDescriptor *r) const
	geometric RoI filters - for non-trigger veritices (e.g. offline, truth, etc.)
template<class V>
std::vector< const V * >	getVertices (const std::vector< const V * > &vvec, const TrigRoiDescriptor *r) const
	vertex getter function (for offline tracks or truth particles)
std::vector< const xAOD::Vertex * >	getTrigVertices (const std::vector< const xAOD::Vertex * > &vvec, const ElementLink< TrigRoiDescriptorCollection > &roiLink) const
	TrigDecTool- and EventView-based getter function for trigger vertices.
virtual void	print () const =0
	Print the state of the tool.
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
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::VertexContainer >	m_triggerVertexContainerName
	Trigger vertex container's name.
PublicToolHandle< Trig::TrigDecisionTool >	m_trigDecTool
	TrigDecTool.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 32 of file VertexRoiSelectionTool.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

◆ VertexRoiSelectionTool()

IDTPM::VertexRoiSelectionTool::VertexRoiSelectionTool ( const std::string & name )

Constructor.

Athena include(s)

Gaudi includes Local include(s) STD includes

----— Parametrized constructor ----—

Definition at line 29 of file VertexRoiSelectionTool.cxx.

30 :

31 asg::AsgTool( name ) { }

◆ ~VertexRoiSelectionTool()

virtual IDTPM::VertexRoiSelectionTool::~VertexRoiSelectionTool ( )

virtualdefault

Destructor.

Member Function Documentation

◆ accept()

template<class V>

template bool IDTPM::VertexRoiSelectionTool::accept	(	const V &	v,
		const TrigRoiDescriptor *	r ) const

geometric RoI filters - for non-trigger veritices (e.g. offline, truth, etc.)

accept method for truth vertices

accept method for offline vertices

----— accept -----—

Definition at line 56 of file VertexRoiSelectionTool.cxx.

{
  if( r==0 ) {
    ATH_MSG_ERROR( "Called with null RoiDescriptor" );
    return true;
  }
 
  if( r->composite() ) {
    for( unsigned i=r->size() ; i-- ; )
      if( accept( v, (const TrigRoiDescriptor*)r->at(i) ) ) {
        return true;
      }
 
  } else {
    if( r->isFullscan() ) return true;
 
    bool contained_zed = posZ(v) >= r->zedMinus() and 
                         posZ(v) <= r->zedPlus();
 
    if( contained_zed ) return true;
  }
 
  return false;
}

◆ ASG_TOOL_CLASS()

IDTPM::VertexRoiSelectionTool::ASG_TOOL_CLASS	(	VertexRoiSelectionTool	,
		IAsgTool	)

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

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

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

◆ getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

◆ getTrigVertices()

std::vector< const xAOD::Vertex * > IDTPM::VertexRoiSelectionTool::getTrigVertices	(	const std::vector< const xAOD::Vertex * > &	vvec,
		const ElementLink< TrigRoiDescriptorCollection > &	roiLink ) const

TrigDecTool- and EventView-based getter function for trigger vertices.

--— getTrigVertices --—

Getting trigger vertex collection handle

Retrieving ALL trigger vertices within the RoI

Getting SELECTED trigger vertices within the RoI

Check if in-RoI vertex is also in the selected (full-scan) trigger vertex vector i.e. if it passes the quality selection (if any)

Definition at line 127 of file VertexRoiSelectionTool.cxx.

{
  SG::ReadHandle< xAOD::VertexContainer > handle( m_triggerVertexContainerName );
  std::pair< xAOD::VertexContainer::const_iterator,
             xAOD::VertexContainer::const_iterator > trigVtxItrPair =
                 m_trigDecTool->associateToEventView( handle, roiLink );
  std::vector< const xAOD::Vertex* > selectedTrigVertices;
  xAOD::VertexContainer::const_iterator vtxItr;
  for( vtxItr = trigVtxItrPair.first ; vtxItr != trigVtxItrPair.second ; ++vtxItr ) {
    if( std::find( vvec.begin(), vvec.end(), *vtxItr ) == vvec.end() ) {
      ATH_MSG_DEBUG( "Trigger vertex does not pass quality selection. Skipping." );
      continue;
    }
    selectedTrigVertices.push_back( *vtxItr );
  }
 
  return selectedTrigVertices;
}

◆ getVertices()

template<class V>

std::vector< const V * > IDTPM::VertexRoiSelectionTool::getVertices	(	const std::vector< const V * > &	vvec,
		const TrigRoiDescriptor *	r ) const

vertex getter function (for offline tracks or truth particles)

--— getVertices --—

Definition at line 95 of file VertexRoiSelectionTool.cxx.

                                       {
 
  std::vector< const V* > selectedVertices;
 
  for( const V* thisVertex : vvec ) {
    if( accept<V>( *thisVertex, r ) ) {
      selectedVertices.push_back( thisVertex );
    }
  }
 
  return selectedVertices;
}

◆ initialize()

StatusCode IDTPM::VertexRoiSelectionTool::initialize ( void )

overridevirtual

Initialize.

----— Initialize ----—

Reimplemented from asg::AsgTool.

Definition at line 37 of file VertexRoiSelectionTool.cxx.

                                                   {
 
  ATH_CHECK( asg::AsgTool::initialize() );
 
  ATH_MSG_DEBUG( "Initializing " << name() );
 
  ATH_CHECK( m_triggerVertexContainerName.initialize( 
      not m_triggerVertexContainerName.key().empty() ) );
 
  ATH_CHECK( m_trigDecTool.retrieve() );
 
  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() [1/2]

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

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

Implemented in asg::AsgTool, 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.

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

◆ selectVerticesInRoI()

StatusCode IDTPM::VertexRoiSelectionTool::selectVerticesInRoI	(	TrackAnalysisCollections &	trkAnaColls,
		const ElementLink< TrigRoiDescriptorCollection > &	roiLink )

Main Vertex selection method.

— selectVerticesInRoI —

retrieving TrkAnaDefSvc

Trigger vertices RoI selection Filled only if trigger vertex collection is not empty

Offline vertices RoI selection

Truth vertices RoI selection

Debug printout

Definition at line 159 of file VertexRoiSelectionTool.cxx.

                                                                {
 
  ATH_MSG_DEBUG( "Selecting vertices in RoI" );
  ISvcLocator* svcLoc = Gaudi::svcLocator();
  SmartIF< ITrackAnalysisDefinitionSvc > trkAnaDefSvc(
      svcLoc->service( "TrkAnaDefSvc"+trkAnaColls.anaTag() ) );
  ATH_CHECK( trkAnaDefSvc.isValid() );
 
  const TrigRoiDescriptor* const* roi = roiLink.cptr();
  if( not m_triggerVertexContainerName.key().empty() ) {
    ATH_CHECK( trkAnaColls.fillTrigVertexVec(
        getTrigVertices(
            trkAnaColls.trigVertexVec( TrackAnalysisCollections::FS ),
            roiLink ),
        TrackAnalysisCollections::InRoI ) );
  }
  if( trkAnaDefSvc->useOffline() ) {
    ATH_CHECK( trkAnaColls.fillOfflVertexVec(
        getVertices(
            trkAnaColls.offlVertexVec( TrackAnalysisCollections::FS ),
            *roi ),
        TrackAnalysisCollections::InRoI ) );
  }
  if( trkAnaDefSvc->useTruth() ) {
    ATH_CHECK( trkAnaColls.fillTruthVertexVec(
        getVertices(
            trkAnaColls.truthVertexVec( TrackAnalysisCollections::FS ),
            *roi ),
        TrackAnalysisCollections::InRoI ) );
  }
  ATH_MSG_DEBUG( "Vertices after RoI selection: " << 
      trkAnaColls.printVertexInfo( TrackAnalysisCollections::InRoI ) );
 
  return StatusCode::SUCCESS;
}

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

Reimplemented in 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_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_trigDecTool

PublicToolHandle< Trig::TrigDecisionTool > IDTPM::VertexRoiSelectionTool::m_trigDecTool

private

Initial value:

{

this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool", "" }

TrigDecTool.

Definition at line 76 of file VertexRoiSelectionTool.h.

76 {

77 this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool", "" };

◆ m_triggerVertexContainerName

SG::ReadHandleKey< xAOD::VertexContainer > IDTPM::VertexRoiSelectionTool::m_triggerVertexContainerName

private

Initial value:

{

this, "TriggerVertexContainerName", "", "Name of container of trigger vertices" }

Trigger vertex container's name.

Definition at line 72 of file VertexRoiSelectionTool.h.

72 {

73 this, "TriggerVertexContainerName", "", "Name of container of trigger vertices" };

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ VertexRoiSelectionTool()

----— Parametrized constructor ----—

◆ ~VertexRoiSelectionTool()

Member Function Documentation

◆ accept()

----— accept -----—

◆ ASG_TOOL_CLASS()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ getTrigVertices()

--— getTrigVertices --—

◆ getVertices()

--— getVertices --—

◆ initialize()

----— Initialize ----—

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ selectVerticesInRoI()

— selectVerticesInRoI —

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_trigDecTool

◆ m_triggerVertexContainerName

◆ m_varHandleArraysDeclared

◆ m_vhka