#include <EventQualityFilterAlg.h>

Inheritance diagram for EventQualityFilterAlg:

Collaboration diagram for EventQualityFilterAlg:

Public Member Functions
	EventQualityFilterAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
virtual	~EventQualityFilterAlg ()
	Destructor:
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	sysInitialize () override
	Initialization method invoked by the framework.
virtual void	setFilterPassed (bool state) const
	Set the filter passed flag to the specified state.
void	setFilterDescription (const std::string &descr)
	helper method to ease the setting of this filter's description in derived classes Note that this method should be called in the c-tor of derived classes
ServiceHandle< ICutFlowSvc > &	cutFlowSvc ()
	return a handle to an `ICutFlowSvc` instance
CutIdentifier	cutID ()
	return the `CutIdentifier` corresponding to the top-level cut of this filter algorithm
const SG::ReadHandleKey< xAOD::EventInfo > &	eventInfoKey () const
	EventInfo key for use in derived classes.
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< ICutFlowSvc >	ICutFlowSvc_t
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
BooleanProperty	m_useLArError { this, "VetoLArError", true, "Veto events with a LAr error" }
	Flag to turn on/off checking of LAr calorimeter error flag.
BooleanProperty	m_useTileError { this, "VetoTileError", true, "Veto events with a Tile error" }
	Flag to turn on/off checking of tile calorimter error flag.
BooleanProperty	m_useSCTError { this, "VetoSCTError", true, "Veto events with an SCT error" }
	Flag to turn on/off checking of SCT error flag.
BooleanProperty	m_useCoreError { this, "VetoCoreError", true, "Veto events with a Core error" }
	Flag to turn on/off checking of core error flag.
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfo", "EventInfo", "EventInfo key"}
	EventInfo read handle.
CutIdentifier	m_cutID
	The CutIdentifier for this filter algorithm.
ICutFlowSvc_t	m_cutFlowSvc
	handle to the service holding tables of cut-flows for filtering algs.
std::string	m_filterDescr
	filter description: describes what this filter does.
bool	m_resetSelfDescription
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey { this, "EventInfoKey", "EventInfo", "" }
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 24 of file EventQualityFilterAlg.h.

Member Typedef Documentation

◆ ICutFlowSvc_t

typedef ServiceHandle<ICutFlowSvc> AthFilterAlgorithm::ICutFlowSvc_t

privateinherited

Definition at line 84 of file AthFilterAlgorithm.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ EventQualityFilterAlg()

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

Constructor with parameters:

Definition at line 30 of file EventQualityFilterAlg.cxx.

                                                                         :
  ::AthFilterAlgorithm( name, pSvcLocator )
{
}

◆ ~EventQualityFilterAlg()

EventQualityFilterAlg::~EventQualityFilterAlg ( )

virtual

Destructor:

Definition at line 39 of file EventQualityFilterAlg.cxx.

40{}

Member Function Documentation

◆ cutFlowSvc()

ServiceHandle< ICutFlowSvc > & AthFilterAlgorithm::cutFlowSvc ( )

inlineinherited

return a handle to an ICutFlowSvc instance

Definition at line 108 of file AthFilterAlgorithm.h.

{
  return m_cutFlowSvc;
}

◆ cutID()

CutIdentifier AthFilterAlgorithm::cutID ( )

inlineinherited

return the CutIdentifier corresponding to the top-level cut of this filter algorithm

Definition at line 116 of file AthFilterAlgorithm.h.

{
  return m_cutID;
}

◆ 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

◆ doNotResetSelfDescription()

void AthFilterAlgorithm::doNotResetSelfDescription ( Gaudi::Details::PropertyBase & )

inlineprivateinherited

Definition at line 124 of file AthFilterAlgorithm.h.

{ 
  m_resetSelfDescription=false; 
}

◆ eventInfoKey()

const SG::ReadHandleKey< xAOD::EventInfo > & AthFilterAlgorithm::eventInfoKey ( ) const

inherited

EventInfo key for use in derived classes.

Definition at line 134 of file AthFilterAlgorithm.cxx.

{
  return m_eventInfoKey;
}

◆ 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 EventQualityFilterAlg::execute ( )

overridevirtual

Definition at line 58 of file EventQualityFilterAlg.cxx.

{
  ATH_MSG_DEBUG ("Executing " << name() << "...");
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  // Get the EventInfo object
  SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo, ctx);
  if (!eventInfo.isValid()) {
    ATH_MSG_ERROR("Could not retrieve EventInfo!");
    return StatusCode::FAILURE;
  }
 
 
 
  // Only do the event vetoing on data
  const bool isSim = eventInfo->eventType(xAOD::EventInfo::EventType::IS_SIMULATION);
  if ( isSim ) {
    ATH_MSG_DEBUG ("It is an MC event... not vetoing...");
    this->setFilterPassed(true);
    return StatusCode::SUCCESS;
  }
 
 
  // Now make the event decision
  bool passEvent(true);
  if ( m_useLArError.value()  && eventInfo->errorState(xAOD::EventInfo::LAr)  == xAOD::EventInfo::Error ){ passEvent = false; }
  if ( m_useTileError.value() && eventInfo->errorState(xAOD::EventInfo::Tile) == xAOD::EventInfo::Error ){ passEvent = false; }
  if ( m_useSCTError.value()  && eventInfo->errorState(xAOD::EventInfo::SCT) == xAOD::EventInfo::Error ){ passEvent = false; }
  if ( m_useCoreError.value() && eventInfo->isEventFlagBitSet(xAOD::EventInfo::Core, 18)  ){ passEvent = false; }
 
  // Set the final decision
  this->setFilterPassed(passEvent);
 
  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();
}

◆ initialize()

StatusCode EventQualityFilterAlg::initialize ( )

overridevirtual

Definition at line 45 of file EventQualityFilterAlg.cxx.

{
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
  ATH_MSG_DEBUG( "Using: " << m_useLArError );
  ATH_MSG_DEBUG( "Using: " << m_useTileError );
  ATH_MSG_DEBUG( "Using: " << m_useSCTError );
  ATH_MSG_DEBUG( "Using: " << m_useCoreError );
  // ATH_MSG_DEBUG( "Using: " << m_useTileTripReader );
  ATH_CHECK(m_eventInfo.initialize());
  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();
  }

◆ setFilterDescription()

void AthFilterAlgorithm::setFilterDescription ( const std::string & descr )

inherited

helper method to ease the setting of this filter's description in derived classes Note that this method should be called in the c-tor of derived classes

helper function to ease the setting of this filter's description in derived classes

Definition at line 118 of file AthFilterAlgorithm.cxx.

{
  if( cutFlowSvc()==0 ){
    m_filterDescr = descr;
  }
  else if( m_resetSelfDescription and cutID() ){
    cutFlowSvc()->setFilterDescription(cutID(),descr);
  }
  else{
    ATH_MSG_INFO("problem setting filter description with cutflow-svc");
  }
 
  return;
}

◆ setFilterPassed()

void AthFilterAlgorithm::setFilterPassed ( bool state ) const

virtualinherited

Set the filter passed flag to the specified state.

Definition at line 99 of file AthFilterAlgorithm.cxx.

{
  AthAlgorithm::setFilterPassed(state);
 
  if (state) {
    const EventContext& ctx = Gaudi::Hive::currentContext();
    SG::ReadHandle<xAOD::EventInfo> evtInfo (m_eventInfoKey, ctx);
    // Only try to access the mcEventWeight if we are running on Monte Carlo, duhhh!
    if ( evtInfo->eventType(xAOD::EventInfo::IS_SIMULATION) ) {
      m_cutFlowSvc->addEvent(m_cutID, evtInfo->mcEventWeights());
    } else {
      m_cutFlowSvc->addEvent(m_cutID, 1.0);
    }
  }
}

◆ sysInitialize()

StatusCode AthFilterAlgorithm::sysInitialize ( )

overridevirtualinherited

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Reimplemented from AthAlgorithm.

Definition at line 65 of file AthFilterAlgorithm.cxx.

{
  // ---- stolen from GaudiKernel/Algorithm::sysInitialize -------
  // Bypass the initialization if the algorithm
  // has already been initialized.
  if ( Gaudi::StateMachine::INITIALIZED <= FSMState() ) return StatusCode::SUCCESS;
 
  // Set the Algorithm's properties
  bindPropertiesTo( serviceLocator()->getOptsSvc() );
 
  // Bypass the initialization if the algorithm is disabled.
  // Need to do this after bindPropertiesTo.
  if ( !isEnabled( ) ) return StatusCode::SUCCESS;
 
  // ---- stolen from GaudiKernel/Algorithm::sysInitialize ------- END ---
 
  // register ourselves with the cutFlowSvc
  if ( cutFlowSvc().retrieve().isSuccess()) {
    m_cutID = cutFlowSvc()->registerFilter(this->name(), m_filterDescr, false);
    if (0 == m_cutID) {
      ATH_MSG_INFO("problem registering myself with cutflow-svc");
    } else {
      ATH_MSG_VERBOSE("registered with cutflow-svc");
    }
  }
 
  ATH_CHECK( m_eventInfoKey.initialize() );
 
  // re-direct to base class...
  return AthAlgorithm::sysInitialize();
}

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

ICutFlowSvc_t AthFilterAlgorithm::m_cutFlowSvc

privateinherited

handle to the service holding tables of cut-flows for filtering algs.

Definition at line 86 of file AthFilterAlgorithm.h.

◆ m_cutID

CutIdentifier AthFilterAlgorithm::m_cutID

privateinherited

The CutIdentifier for this filter algorithm.

Definition at line 82 of file AthFilterAlgorithm.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_eventInfo

SG::ReadHandleKey<xAOD::EventInfo> EventQualityFilterAlg::m_eventInfo {this, "EventInfo", "EventInfo", "EventInfo key"}

private

EventInfo read handle.

Definition at line 66 of file EventQualityFilterAlg.h.

66{this, "EventInfo", "EventInfo", "EventInfo key"};

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> AthFilterAlgorithm::m_eventInfoKey { this, "EventInfoKey", "EventInfo", "" }

privateinherited

Definition at line 96 of file AthFilterAlgorithm.h.

97{ this, "EventInfoKey", "EventInfo", "" };

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

std::string AthFilterAlgorithm::m_filterDescr

privateinherited

filter description: describes what this filter does.

this is usually pushed to the ICutFlowSvc

Definition at line 90 of file AthFilterAlgorithm.h.

◆ m_resetSelfDescription

bool AthFilterAlgorithm::m_resetSelfDescription

privateinherited

Definition at line 93 of file AthFilterAlgorithm.h.

◆ m_useCoreError

BooleanProperty EventQualityFilterAlg::m_useCoreError { this, "VetoCoreError", true, "Veto events with a Core error" }

private

Flag to turn on/off checking of core error flag.

Definition at line 59 of file EventQualityFilterAlg.h.

59{ this, "VetoCoreError", true, "Veto events with a Core error" };

◆ m_useLArError

BooleanProperty EventQualityFilterAlg::m_useLArError { this, "VetoLArError", true, "Veto events with a LAr error" }

private

Flag to turn on/off checking of LAr calorimeter error flag.

Definition at line 50 of file EventQualityFilterAlg.h.

50{ this, "VetoLArError", true, "Veto events with a LAr error" };

◆ m_useSCTError

BooleanProperty EventQualityFilterAlg::m_useSCTError { this, "VetoSCTError", true, "Veto events with an SCT error" }

private

Flag to turn on/off checking of SCT error flag.

Definition at line 56 of file EventQualityFilterAlg.h.

56{ this, "VetoSCTError", true, "Veto events with an SCT error" };

◆ m_useTileError

BooleanProperty EventQualityFilterAlg::m_useTileError { this, "VetoTileError", true, "Veto events with a Tile error" }

private

Flag to turn on/off checking of tile calorimter error flag.

Definition at line 53 of file EventQualityFilterAlg.h.

53{ this, "VetoTileError", true, "Veto events with a Tile error" };

◆ 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

◆ ICutFlowSvc_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ EventQualityFilterAlg()

◆ ~EventQualityFilterAlg()

Member Function Documentation

◆ cutFlowSvc()

◆ cutID()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ doNotResetSelfDescription()

◆ eventInfoKey()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterDescription()

◆ setFilterPassed()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cutFlowSvc

◆ m_cutID

◆ m_detStore

◆ m_eventInfo

◆ m_eventInfoKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_filterDescr

◆ m_resetSelfDescription

◆ m_useCoreError

◆ m_useLArError

◆ m_useSCTError

◆ m_useTileError

◆ m_varHandleArraysDeclared

◆ m_vhka