Tool implementing the GRL selection. More...

#include <GoodRunsListSelectionTool.h>

Inheritance diagram for GoodRunsListSelectionTool:

Collaboration diagram for GoodRunsListSelectionTool:

Public Member Functions
	GoodRunsListSelectionTool (const std::string &name="GoodRunsListsSelectionTool")

virtual StatusCode	initialize ()
	Initialize AlgTool. More...

virtual void	print () const =0
	Print the state of the tool. More...

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Interface inherited from IGoodRunsListSelectionTool
virtual bool	passRunLB (const std::vector< std::string > &grlnameVec=std::vector< std::string >(), const std::vector< std::string > &brlnameVec=std::vector< std::string >()) const
	Check if the current event passes the selection. More...

virtual bool	passRunLB (const xAOD::EventInfo &event, const std::vector< std::string > &grlnameVec=std::vector< std::string >(), const std::vector< std::string > &brlnameVec=std::vector< std::string >()) const
	Check if the event specified passes the selection. More...

virtual bool	passRunLB (int runNumber, int lumiBlockNr, const std::vector< std::string > &grlnameVec=std::vector< std::string >(), const std::vector< std::string > &brlnameVec=std::vector< std::string >()) const
	Check if the event specified passes the selection. More...

virtual const Root::TGRLCollection &	getGRLCollection () const
	Get the good runs list used by the tool. More...

virtual const Root::TGRLCollection &	getBRLCollection () const
	Get the bad runs list used by the tool. More...

virtual bool	eventPassesFilter () const
	ISkimmingTool method: will retrieve eventInfo from storegate and use that with above methods. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods. More...

Protected Member Functions
StatusCode	readXMLs (Root::TGRLCollection &grl, const std::vector< std::string > &files)
	Helper function reading in the specified files into a GRL object. More...

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
Gaudi::Property< std::vector< std::string > >	m_goodrunslistVec {this, "GoodRunsListVec", {}}

Gaudi::Property< std::vector< std::string > >	m_blackrunslistVec {this, "BlackRunsListVec", {}}

Root::TGRLCollection	m_grlcollection

Root::TGRLCollection	m_brlcollection

Gaudi::Property< int >	m_boolop {this, "BoolOperation", 0}

Gaudi::Property< bool >	m_passthrough {this, "PassThrough", true}

Gaudi::Property< bool >	m_rejectanybrl {this, "RejectBlackRunsInEventSelector", false}

Gaudi::Property< bool >	m_useRandomRunNumber {this, "UseRandomRunNumber", false}

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_randomRunNumberKey {this, "RandomRunNumber", "EventInfo.RandomRunNumber"}

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_randomLumiBlockKey {this, "RandomLumiBlock", "EventInfo.RandomLumiBlockNumber"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
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

Tool implementing the GRL selection.

This tool needs to be used to select good lumiblocks for a physics or performance analysis.

$Revision$ $Date$

Definition at line 35 of file GoodRunsListSelectionTool.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

◆ GoodRunsListSelectionTool()

GoodRunsListSelectionTool::GoodRunsListSelectionTool ( const std::string & name = "GoodRunsListsSelectionTool" )

Definition at line 16 of file GoodRunsListSelectionTool.cxx.

17 : asg::AsgTool( name ) {}

Member Function Documentation

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

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

inlineprivateinherited

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

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 245 of file AthCommonDataStore.h.

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

◆ declareProperty() [2/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 221 of file AthCommonDataStore.h.

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

◆ declareProperty() [3/6]

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

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

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

◆ declareProperty() [4/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 333 of file AthCommonDataStore.h.

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

◆ declareProperty() [5/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 352 of file AthCommonDataStore.h.

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

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ eventPassesFilter()

bool GoodRunsListSelectionTool::eventPassesFilter ( ) const

virtual

ISkimmingTool method: will retrieve eventInfo from storegate and use that with above methods.

Implements DerivationFramework::ISkimmingTool.

Definition at line 193 of file GoodRunsListSelectionTool.cxx.

                                                         {
   const xAOD::EventInfo* ei = 0;
   if( evtStore()->retrieve( ei , "EventInfo" ).isFailure() ) {
     ATH_MSG_ERROR("Unable to retrieve EventInfo, returning false");
     return false;
   }
   return passRunLB( *ei );
 }

◆ evtStore() [1/2]

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ 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

◆ getBRLCollection()

virtual const Root::TGRLCollection& GoodRunsListSelectionTool::getBRLCollection ( ) const

inlinevirtual

Get the bad runs list used by the tool.

Implements IGoodRunsListSelectionTool.

Definition at line 80 of file GoodRunsListSelectionTool.h.

                                                               {
       return m_brlcollection;
    }

◆ getGRLCollection()

virtual const Root::TGRLCollection& GoodRunsListSelectionTool::getGRLCollection ( ) const

inlinevirtual

Get the good runs list used by the tool.

Implements IGoodRunsListSelectionTool.

Definition at line 75 of file GoodRunsListSelectionTool.h.

                                                               {
       return m_grlcollection;
    }

◆ 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 GoodRunsListSelectionTool::initialize ( )

virtual

Initialize AlgTool.

Reimplemented from asg::AsgTool.

Definition at line 19 of file GoodRunsListSelectionTool.cxx.

                                                  {
  
    // Tell the user what's happening:
    ATH_MSG_DEBUG( "Initialising tool" );
  
    // Set the output level of the underlying code:
    const Root::TMsgLevel level =
          static_cast< Root::TMsgLevel >( msg().level() );
    Root::TMsgLogger::SetMinLevel( level );
  
    // Reset the pass-through mode setting:
    if( m_goodrunslistVec.size() || m_blackrunslistVec.size() ) {
       m_passthrough = false;
    }
  
    // Warn about pass-through mode:
    if( m_passthrough ) {
       ATH_MSG_WARNING( "Set to pass-through mode." );
    }
  
    // Read in the XML files:
    ATH_CHECK( readXMLs( m_grlcollection, m_goodrunslistVec ) );
    ATH_CHECK( readXMLs( m_brlcollection, m_blackrunslistVec ) );
  
    ATH_CHECK(m_randomRunNumberKey.initialize(m_useRandomRunNumber));
    ATH_CHECK(m_randomLumiBlockKey.initialize(m_useRandomRunNumber));
  
    // Return gracefully:
    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.

◆ interfaceID()

static const InterfaceID& DerivationFramework::ISkimmingTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 32 of file ISkimmingTool.h.

32 { return IID_ISkimmingTool; }

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

◆ passRunLB() [1/3]

bool GoodRunsListSelectionTool::passRunLB	(	const std::vector< std::string > &	grlnameVec = `std::vector< std::string >()`,
		const std::vector< std::string > &	brlnameVec = `std::vector< std::string >()`
	)		const

virtual

Check if the current event passes the selection.

Implements IGoodRunsListSelectionTool.

Definition at line 50 of file GoodRunsListSelectionTool.cxx.

                                                             {
  
    // Retrieve the xAOD::EventInfo object:
    const xAOD::EventInfo* ei = 0;
    if( ! evtStore()->retrieve( ei, "EventInfo" ).isSuccess() ) {
       ATH_MSG_WARNING( "Couldn't access xAOD::EventInfo object. Using "
                        "pass-through mode..." );
       return true;
    }
  
    // MC events should not be filtered by this tool:
    if( ei->eventType( xAOD::EventInfo::IS_SIMULATION ) ) {
       ATH_MSG_VERBOSE( "MC event is accepted by the tool" );
       return true;
    }
  
    // Use this object:
    return passRunLB( *ei, grlnameVec, brlnameVec );
 }

◆ passRunLB() [2/3]

bool GoodRunsListSelectionTool::passRunLB	(	const xAOD::EventInfo &	event,
		const std::vector< std::string > &	grlnameVec = `std::vector< std::string >()`,
		const std::vector< std::string > &	brlnameVec = `std::vector< std::string >()`
	)		const

virtual

Check if the event specified passes the selection.

Implements IGoodRunsListSelectionTool.

Definition at line 72 of file GoodRunsListSelectionTool.cxx.

                                                             {
  
    int runNumber = event.runNumber();
    int lumiBlock = event.lumiBlock();
    if(m_useRandomRunNumber){
      SG::ReadDecorHandle<xAOD::EventInfo, unsigned int> randomRunNumber(m_randomRunNumberKey);
      SG::ReadDecorHandle<xAOD::EventInfo, unsigned int> randomLumiBlock(m_randomLumiBlockKey);
      runNumber = randomRunNumber(event);
      lumiBlock = randomLumiBlock(event);
    }
  
    return passRunLB( runNumber, lumiBlock, grlnameVec, brlnameVec );
 }

◆ passRunLB() [3/3]

bool GoodRunsListSelectionTool::passRunLB	(	int	runNumber,
		int	lumiBlockNr,
		const std::vector< std::string > &	grlnameVec = `std::vector< std::string >()`,
		const std::vector< std::string > &	brlnameVec = `std::vector< std::string >()`
	)		const

virtual

Check if the event specified passes the selection.

Implements IGoodRunsListSelectionTool.

Definition at line 90 of file GoodRunsListSelectionTool.cxx.

                                                             {
  
    ATH_MSG_VERBOSE( "passRunLB()" );
  
    // pass through
    if( m_passthrough ) {
       ATH_MSG_VERBOSE( "passRunLB() :: Pass through mode." );
       return true;
    }
  
    // decision based on merged blackrunslist
    if( m_rejectanybrl &&
        m_brlcollection.HasRunLumiBlock( runNumber, lumiBlockNr ) ) {
       ATH_MSG_VERBOSE( "passRunLB() :: Event rejected by (_any_ of) merged "
                        "black runs list." );
       return false;
    }
  
    // decision based on specific blackrunlists
    if( ( ! m_rejectanybrl ) && brlnameVec.size() ) {
       for( const std::string& brlname : brlnameVec ) {
          auto brl_itr = m_brlcollection.find( brlname );
          if( brl_itr == m_brlcollection.end() ) {
             continue;
          }
          if( brl_itr->HasRunLumiBlock( runNumber, lumiBlockNr ) ) {
             ATH_MSG_VERBOSE( "passRunLB() :: Event rejected by specific ("
                              << brlname << ") black runs list." );
             return false;
          }
       }
    }
  
    // decision based on specific goodrunlists
    for( const std::string& grlname : grlnameVec ) {
       auto grl_itr = m_grlcollection.find( grlname );
       if( grl_itr == m_grlcollection.end() ) {
          continue;
       }
       if( grl_itr->HasRunLumiBlock( runNumber, lumiBlockNr ) ) {
          ATH_MSG_VERBOSE( "passRunLB() :: Event accepted by specific ("
                           << grlname << ") good runs list." );
          return true;
       }
    }
  
    // If we got this far, the decision needs to be made based on the combined
    // GRL:
    return m_grlcollection.HasRunLumiBlock( runNumber, lumiBlockNr );
 }

◆ print() [1/2]

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

◆ print() [2/2]

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

pure virtualinherited

Print the state of the tool.

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

◆ readXMLs()

StatusCode GoodRunsListSelectionTool::readXMLs	(	Root::TGRLCollection &	grl,
		const std::vector< std::string > &	files
	)

protected

Helper function reading in the specified files into a GRL object.

Definition at line 145 of file GoodRunsListSelectionTool.cxx.

                                                                            {
  
    // If there are no files specified, then let's just clean the GRL object,
    // and return:
    if( files.empty() ) {
       grl.clear();
       return StatusCode::SUCCESS;
    }
  
    // The reader object used:
    Root::TGoodRunsListReader reader;
  
    // Set up the files:
    for( const std::string& fname : files ) {
  
       // Find the file:
       std::string fileName = PathResolverFindXMLFile( fname );
       if( fileName == "" ) {
     //try with CalibArea
     fileName = PathResolverFindCalibFile( fname );
     if(fileName=="") {
          ATH_MSG_FATAL( "Couldn't find file: " << fname );
          return StatusCode::FAILURE;
     }
       }
       ATH_MSG_DEBUG( "Reading file: " << fileName << " (" << fname << ")" );
  
       // Add it to the reader:
       reader.AddXMLFile( fileName );
    }
  
    // (Try to) Interpret all the XML files:
    if( ! reader.Interpret() ) {
       ATH_MSG_ERROR( "There was an error parsing the GRL XML file(s)" );
       return StatusCode::FAILURE;
    }
  
    // Merge the GRLs into one:
    const Root::BoolOperation op =
      static_cast< Root::BoolOperation >( m_boolop.value() );
    grl = reader.GetMergedGRLCollection( op );
  
    // Return gracefully:
    return StatusCode::SUCCESS;
 }

◆ renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_blackrunslistVec

Gaudi::Property<std::vector<std::string> > GoodRunsListSelectionTool::m_blackrunslistVec {this, "BlackRunsListVec", {}}

protected

Definition at line 98 of file GoodRunsListSelectionTool.h.

◆ m_boolop

Gaudi::Property<int> GoodRunsListSelectionTool::m_boolop {this, "BoolOperation", 0}

protected

Definition at line 103 of file GoodRunsListSelectionTool.h.

◆ m_brlcollection

Root::TGRLCollection GoodRunsListSelectionTool::m_brlcollection

protected

Definition at line 101 of file GoodRunsListSelectionTool.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_goodrunslistVec

Gaudi::Property<std::vector<std::string> > GoodRunsListSelectionTool::m_goodrunslistVec {this, "GoodRunsListVec", {}}

protected

Definition at line 97 of file GoodRunsListSelectionTool.h.

◆ m_grlcollection

Root::TGRLCollection GoodRunsListSelectionTool::m_grlcollection

protected

Definition at line 100 of file GoodRunsListSelectionTool.h.

◆ m_passthrough

Gaudi::Property<bool> GoodRunsListSelectionTool::m_passthrough {this, "PassThrough", true}

protected

Definition at line 104 of file GoodRunsListSelectionTool.h.

◆ m_randomLumiBlockKey

SG::ReadDecorHandleKey<xAOD::EventInfo> GoodRunsListSelectionTool::m_randomLumiBlockKey {this, "RandomLumiBlock", "EventInfo.RandomLumiBlockNumber"}

protected

Definition at line 110 of file GoodRunsListSelectionTool.h.

◆ m_randomRunNumberKey

SG::ReadDecorHandleKey<xAOD::EventInfo> GoodRunsListSelectionTool::m_randomRunNumberKey {this, "RandomRunNumber", "EventInfo.RandomRunNumber"}

protected

Definition at line 108 of file GoodRunsListSelectionTool.h.

◆ m_rejectanybrl

Gaudi::Property<bool> GoodRunsListSelectionTool::m_rejectanybrl {this, "RejectBlackRunsInEventSelector", false}

protected

Definition at line 105 of file GoodRunsListSelectionTool.h.

◆ m_useRandomRunNumber

Gaudi::Property<bool> GoodRunsListSelectionTool::m_useRandomRunNumber {this, "UseRandomRunNumber", false}

protected

Definition at line 106 of file GoodRunsListSelectionTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ GoodRunsListSelectionTool()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ eventPassesFilter()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getBRLCollection()

◆ getGRLCollection()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ passRunLB() [1/3]

◆ passRunLB() [2/3]

◆ passRunLB() [3/3]

◆ print() [1/2]

◆ print() [2/2]

◆ readXMLs()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_blackrunslistVec

◆ m_boolop

◆ m_brlcollection

◆ m_detStore

◆ m_evtStore

◆ m_goodrunslistVec

◆ m_grlcollection

◆ m_passthrough

◆ m_randomLumiBlockKey

◆ m_randomRunNumberKey

◆ m_rejectanybrl

◆ m_useRandomRunNumber

◆ m_varHandleArraysDeclared

◆ m_vhka