#include <GoodRunsListFilterAlgorithm.h>

Inheritance diagram for DerivationFramework::GoodRunsListFilterAlgorithm:

Collaboration diagram for DerivationFramework::GoodRunsListFilterAlgorithm:

Public Member Functions
	GoodRunsListFilterAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~GoodRunsListFilterAlgorithm ()
virtual StatusCode	initialize ()
	uncomment and implement methods as required
virtual StatusCode	execute ()
virtual StatusCode	finalize ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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

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
ToolHandle< IGoodRunsListSelectionTool >	m_grlTool
ToolHandle< IGoodRunsListSelectionTool >	m_brlTool
std::vector< std::string >	m_goodRunsListVec
std::vector< std::string >	m_blackRunsListVec
uint	m_maxGRLRunNumber =0
DataObjIDColl	m_extendedExtraObjects
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 10 of file GoodRunsListFilterAlgorithm.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ GoodRunsListFilterAlgorithm()

DerivationFramework::GoodRunsListFilterAlgorithm::GoodRunsListFilterAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 12 of file GoodRunsListFilterAlgorithm.cxx.

                                                                                                          : 
  AthAlgorithm( name, pSvcLocator ), 
  m_grlTool("GoodRunsListSelectionTool/grlTool",this), 
  m_brlTool("GoodRunsListSelectionTool/brlTool",this)
{
 
  declareProperty( "GoodRunsListVec", m_goodRunsListVec, "Good Runs Lists files ... will pass events" );
  declareProperty( "BlackRunsListVec", m_blackRunsListVec, "Black Runs Lists files ... will veto events" );
 
}

◆ ~GoodRunsListFilterAlgorithm()

DerivationFramework::GoodRunsListFilterAlgorithm::~GoodRunsListFilterAlgorithm ( )

virtual

Definition at line 24 of file GoodRunsListFilterAlgorithm.cxx.

24{}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode DerivationFramework::GoodRunsListFilterAlgorithm::execute ( )

virtual

Definition at line 68 of file GoodRunsListFilterAlgorithm.cxx.

                                                {  
  //This algorithm decorates EventInfo with passDFGRL to indicate if
  //GRL&&!BRL requirement has passed or failed
  //The algorithm is also marked as not passing if it failed
  //
  //Any event that has a runNumber > the biggest runNumber in the GRLs
  //will be passed (unless it fails the BRL requirement)
 
 
  const xAOD::EventInfo* ei = nullptr;
  CHECK( evtStore()->retrieve( ei, "EventInfo" ) );
 
  bool decision(true);
  if( ei->eventType( xAOD::EventInfo::IS_SIMULATION ) ) {
    decision=true; //pass for MC
  } else if( !m_blackRunsListVec.empty() && m_brlTool->passRunLB( *ei ) ) {
    decision=false; //fail because in black list
  } else if(ei->runNumber() > m_maxGRLRunNumber) {
    decision=true; //pass because run number is past end of GRL
  } else if( m_goodRunsListVec.empty() || m_grlTool->passRunLB( *ei ) ) {
    decision=true; //pass: either there is no GRL given, or the event is in the GRL
  } else {
    decision=false; //event is not in the GRL
  }
 
  setFilterPassed(decision);
 
  static const SG::AuxElement::Decorator< char > decEventInfo_passDFGRL("passDFGRL");
  decEventInfo_passDFGRL( *ei ) = decision;
 
  ATH_MSG_VERBOSE("passDFGRL = " << decision);
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode DerivationFramework::GoodRunsListFilterAlgorithm::finalize ( )

virtual

Definition at line 61 of file GoodRunsListFilterAlgorithm.cxx.

                                                 {
  
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode DerivationFramework::GoodRunsListFilterAlgorithm::initialize ( )

virtual

uncomment and implement methods as required

Definition at line 27 of file GoodRunsListFilterAlgorithm.cxx.

                                                   {
  
  //configure the tools
  CHECK( AAH::setProperty( m_grlTool , "GoodRunsListVec", m_goodRunsListVec ) );
  CHECK( AAH::setProperty( m_brlTool , "GoodRunsListVec", m_blackRunsListVec ) );
 
  //determine the maxGRLRunNumber ...
  if(!m_goodRunsListVec.empty()) {
    CHECK( m_grlTool.retrieve() ); //will check the files are ok ..
 
    Root::TGoodRunsListReader reader;
    for(auto& f : m_goodRunsListVec) {
      std::string path = PathResolverFindXMLFile( f );
      if(path.empty()) path = PathResolverFindCalibFile( f );
      if(path.empty()) continue; //skip this file .. should never happen
      reader.AddXMLFile( path );
    }
 
    if(!reader.Interpret()) {
      ATH_MSG_ERROR("Failed to interpret GRLs ... this should never happen");
      return StatusCode::FAILURE;
    }
 
    std::vector<int> runs = reader.GetMergedGoodRunsList().GetRunlist();
    m_maxGRLRunNumber = *max_element( runs.begin(), runs.end() );
 
    ATH_MSG_INFO("Max GRL RunNumber = " << m_maxGRLRunNumber << ". Data in later runs will pass GRL check");
 
  }
 
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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.

◆ 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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

std::vector<std::string> DerivationFramework::GoodRunsListFilterAlgorithm::m_blackRunsListVec

private

Definition at line 27 of file GoodRunsListFilterAlgorithm.h.

◆ m_brlTool

ToolHandle<IGoodRunsListSelectionTool> DerivationFramework::GoodRunsListFilterAlgorithm::m_brlTool

private

Definition at line 24 of file GoodRunsListFilterAlgorithm.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_goodRunsListVec

std::vector<std::string> DerivationFramework::GoodRunsListFilterAlgorithm::m_goodRunsListVec

private

Definition at line 26 of file GoodRunsListFilterAlgorithm.h.

◆ m_grlTool

ToolHandle<IGoodRunsListSelectionTool> DerivationFramework::GoodRunsListFilterAlgorithm::m_grlTool

private

Definition at line 24 of file GoodRunsListFilterAlgorithm.h.

◆ m_maxGRLRunNumber

uint DerivationFramework::GoodRunsListFilterAlgorithm::m_maxGRLRunNumber =0

private

Definition at line 29 of file GoodRunsListFilterAlgorithm.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ GoodRunsListFilterAlgorithm()

◆ ~GoodRunsListFilterAlgorithm()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_blackRunsListVec

◆ m_brlTool

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_goodRunsListVec

◆ m_grlTool

◆ m_maxGRLRunNumber

◆ m_varHandleArraysDeclared

◆ m_vhka