HLT::MET::CellFex Class Reference

#include <CellFex.h>

Inheritance diagram for HLT::MET::CellFex:

Collaboration diagram for HLT::MET::CellFex:

Public Member Functions
	CellFex (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor. More...
virtual StatusCode	initialize () override
	Initialize the fex. More...
virtual StatusCode	execute (const EventContext &context) const override
	Run the algorithm. More...
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
StatusCode	initializeBase (const std::vector< std::string > &componentNames)
	Initialize the base class. More...
virtual StatusCode	monitor (const xAOD::TrigMissingET &met, MonGroupBuilder &monitors) const
	Add monitor variables from an xAOD::TrigMissingET object. More...
virtual StatusCode	flagMET (xAOD::TrigMissingET &met) const
	Flag suspicious values in the output MET. 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
std::vector< std::string >	m_componentNames
	The names of the output MET components. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual StatusCode	fillMET (xAOD::TrigMissingET &met, const EventContext &context, MonGroupBuilder &monitors) const override
	Calculate and fill the output MET value. More...
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
SG::ReadHandleKey< CaloCellContainer >	m_cellsKey
	Input cells. More...
SG::ReadCondHandleKey< CaloNoise >	m_noiseCDOKey
	Calorimeter noise CDO (conditions data object) More...
Gaudi::Property< float >	m_absNoiseThreshold
	The threshold on the magnitude of the cell energy. More...
Gaudi::Property< float >	m_negNoiseThreshold
	The maximum negative cell energy. More...
Gaudi::Property< bool >	m_doTwoGaussianNoise
	Use the 'two-gaussian' noise calculation for the TileCal. More...
const CaloCell_ID *	m_caloCellID {nullptr}
	Fallback option for calo cells which don't have a detector description. More...
SG::WriteHandleKey< xAOD::TrigMissingETContainer >	m_metContainerKey
	The output MET object. More...
ToolHandle< GenericMonitoringTool >	m_monTool
	The monitoring tool. More...
Gaudi::Property< float >	m_maxComponentMETSumEtRatio
Gaudi::Property< float >	m_maxGlobalMETSumEtRatio
bool	m_baseInitialised {false}
	Whether or not this class has been correctly initialised. More...
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 45 of file CellFex.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CellFex()

HLT::MET::CellFex::CellFex	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor.

Definition at line 37 of file CellFex.cxx.

                                                                  :
    FexBase(name, pSvcLocator)
  {}

Member Function Documentation

cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode HLT::MET::FexBase::execute ( const EventContext &  context ) const

overridevirtualinherited

Run the algorithm.

Definition at line 60 of file FexBase.cxx.

  {
    if (!m_baseInitialised) {
      ATH_MSG_ERROR("Base class was not initialised! This means that the "
          << "derived class was not correctly written!");
      return StatusCode::FAILURE;
    }
    ATH_MSG_DEBUG("Executing " << name() << "...");
    Monitored::Timer totalTimer("TIME_Total");
    // Create the output
    auto metCont = std::make_unique<xAOD::TrigMissingETContainer>();
    auto metContAux = std::make_unique<xAOD::TrigMissingETAuxContainer>();
    metCont->setStore(metContAux.get() );
 
    // Create the actual output object
    metCont->push_back(std::make_unique<xAOD::TrigMissingET>());
    xAOD::TrigMissingET* met = metCont->back();
 
    // Initialise the components
    met->defineComponents(m_componentNames);
    // We also need to initialise all of the values. This is not done by the EDM
    // class so you can easily get missing aux element errors if you don't do
    // this
    met->setEx(0);
    met->setEy(0);
    met->setEz(0);
    met->setSumEt(0);
    met->setSumE(0);
    met->setFlag(0);
    met->setRoiWord(0);
 
    MonGroupBuilder monitors;
    CHECK( fillMET(*met, context, monitors) );
    // Add flags
    CHECK( flagMET(*met) );
    // Add extra monitors
    CHECK( monitor(*met, monitors) );
    // Create the actual group and trigger the monitoring
    monitors.build(m_monTool);
 
    // Output REGTEST information
    if (msgLvl(MSG::DEBUG) ) {
      ATH_MSG_DEBUG( "REGTEST " << METComponent(*met) );
      ATH_MSG_DEBUG( "REGTEST flag = " << met->flag() );
      ATH_MSG_DEBUG( "REGTEST Name, status, values: ");
      for (std::size_t ii = 0; ii < met->getNumberOfComponents(); ++ii)
        ATH_MSG_DEBUG( "REGTEST "
            << met->nameOfComponent(ii) << ", "
            << met->statusComponent(ii) << ", "
            << METComponent(ii, *met) );
    }
 
    // Push this output to the store
    auto handle = SG::makeHandle(m_metContainerKey, context);
    CHECK( handle.record( std::move(metCont), std::move(metContAux) ) );
    return StatusCode::SUCCESS;
  }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 79 of file AthReentrantAlgorithm.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();
}

fillMET()

StatusCode HLT::MET::CellFex::fillMET ( xAOD::TrigMissingET &  met, const EventContext &  context, MonGroupBuilder &  monitors  ) const

overrideprivatevirtual

Calculate and fill the output MET value.

Parameters

met	The object to fill
context	The event context
monitors[out]	Any extra monitors to fill

Implements HLT::MET::FexBase.

Definition at line 54 of file CellFex.cxx.

  {
    // Retrieve the inputs
    auto cells = SG::makeHandle(m_cellsKey, context);
      if (!cells.isValid())
      {
        ATH_MSG_ERROR("Failed to retrieve " << m_cellsKey);
        return StatusCode::FAILURE;
      }
    // NB - there's no makeHandle overload for ReadCondHandle
    SG::ReadCondHandle noiseCDO(m_noiseCDOKey, context);
      if (!noiseCDO.isValid())
      {
        ATH_MSG_ERROR("Failed to retrieve " << m_noiseCDOKey);
        return StatusCode::FAILURE;
      }
 
    // Prepare the individual components
    std::array<METComponent, N_SAMPLINGS> sums;
    // Iterate over the calorimeter cells
    for (const CaloCell* icell : *cells) {
      // Get the noise. The two different calls are equivalent for LAr cells,
      // but do differ for the TileCal. As far as I can see, the 'two Gaussian'
      // approach is the more recommended one.
      float noise = m_doTwoGaussianNoise ? 
        noiseCDO->getEffectiveSigma(icell->ID(), icell->gain(), icell->energy() ) :
        noiseCDO->getNoise(icell->ID(), icell->gain() );
      // Noise selections, first |E| < T1*S
      if (m_absNoiseThreshold > 0 &&
          std::abs(icell->energy() ) < m_absNoiseThreshold*noise)
        continue;
      // Then E > -T2*S
      if (m_negNoiseThreshold > 0 &&
          icell->energy() < -m_negNoiseThreshold*noise)
        continue;
      // What about bad cells?
      if (const CaloDetDescrElement* dde = icell->caloDDE() ) {
        // Get the right component
        METComponent& sum = sums.at(dde->getSampling() );
        sum += SignedKinematics::fromEnergyEtaPhi(
            icell->energy(), dde->eta(), dde->phi() );
      }
      else {
        auto id = icell->ID();
        METComponent& sum = sums.at(m_caloCellID->sampling(id) );
        sum += SignedKinematics::fromEnergyEtaPhi(
            icell->energy(), m_caloCellID->eta(id), m_caloCellID->phi(id) );
      }
    }
    // Save the full sum
    std::accumulate(sums.begin(), sums.end(), METComponent{}).fillMET(met);
    // Save each component
    for (std::size_t ii = 0; ii < N_SAMPLINGS; ++ii)
      sums.at(ii).fillMETComponent(ii, met);
 
    return StatusCode::SUCCESS;
  }

filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext &  ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

flagMET()

StatusCode HLT::MET::FexBase::flagMET ( xAOD::TrigMissingET &  met ) const

protectedvirtualinherited

Flag suspicious values in the output MET.

Parameters

met	The xAOD::TrigMissingET object to flag

Definition at line 118 of file FexBase.cxx.

  {
    // Start with the components
    // Keep a flag to OR into the main value
    int overall = 0;
    for (std::size_t ii = 0; ii < met.getNumberOfComponents(); ++ii) {
      METComponent component(ii, met);
      if (component.sumEt > 0 &&
          component.met() / component.sumEt > m_maxComponentMETSumEtRatio) {
        component.status |= StatusFlag::ComponentBigMEtSEtRatio;
        overall |= StatusFlag::ComponentBigMEtSEtRatio;
      }
      met.setStatusComponent(ii, component.status);
    }
    METComponent total(met);
    total.status |= overall;
    if (total.sumEt > 0 &&
        total.met() / total.sumEt > m_maxGlobalMETSumEtRatio)
      total.status |= StatusFlag::GlobalBigMEtSEtRatio;
    met.setFlag(total.status);
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode HLT::MET::CellFex::initialize ( )

overridevirtual

Initialize the fex.

Definition at line 41 of file CellFex.cxx.

  {
    CHECK( m_cellsKey.initialize() );
    CHECK( m_noiseCDOKey.initialize() );
    CHECK( detStore()->retrieve(m_caloCellID, "CaloCell_ID") );
    // Build up the list of component names
    std::vector<std::string> componentNames;
    componentNames.reserve(N_SAMPLINGS);
    for (std::size_t ii = 0; ii < N_SAMPLINGS; ++ii)
      componentNames.push_back(CaloSampling::getSamplingName(ii) );
    return initializeBase(componentNames);
  }

initializeBase()

StatusCode HLT::MET::FexBase::initializeBase ( const std::vector< std::string > &  componentNames )

protectedinherited

Initialize the base class.

Parameters

componentNames

The names of any components in the output MET object.

The xAOD::TrigMissingET writes out a main 'met' value but can also write out extra MET components - either for debugging, monitoring or further use offline. The object has to be initialized with this names, they cannot be extended after this, so this information must be available for the base class to use.

Definition at line 48 of file FexBase.cxx.

  {
    ATH_MSG_DEBUG("Initialising FexBase base class");
    m_baseInitialised = true;
    m_componentNames = componentNames;
    CHECK( m_metContainerKey.initialize() );
    if (!m_monTool.empty())
      CHECK( m_monTool.retrieve() );
    return StatusCode::SUCCESS;
  }

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::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.

isClonable()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, InDet::SiSPGNNTrackMaker, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, ITkStripCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.

Definition at line 44 of file AthReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

monitor()

StatusCode HLT::MET::FexBase::monitor ( const xAOD::TrigMissingET &  met, MonGroupBuilder &  monitors  ) const

protectedvirtualinherited

Add monitor variables from an xAOD::TrigMissingET object.

Parameters

met	The object to fill from
monitors	Extra variables to be monitored

Definition at line 141 of file FexBase.cxx.

  {
    METComponent metComponent(met);
    // Increase the capacity of the vector
    monitors.increaseCapacity(16, true);
    // Add the standard variables
    monitors.add(Monitored::Scalar("EF_MEx_log", toLog10GeV(metComponent.mpx) ) );
    monitors.add(Monitored::Scalar("EF_MEy_log", toLog10GeV(metComponent.mpy) ) );
    monitors.add(Monitored::Scalar("EF_MEz_log", toLog10GeV(metComponent.mpz) ) );
    monitors.add(Monitored::Scalar("EF_MET_log", toLog10GeV(metComponent.met() ) ) );
    monitors.add(Monitored::Scalar("EF_ME_log", toLog10GeV(metComponent.magnitude() ) ) );
    monitors.add(Monitored::Scalar("EF_SumEt_log", toLog10GeV(metComponent.sumEt) ) );
    monitors.add(Monitored::Scalar("EF_SumE_log", toLog10GeV(metComponent.sumE, -9e9) ) );
    monitors.add(Monitored::Scalar("EF_MEx_lin", toLinGeV(metComponent.mpx) ) );
    monitors.add(Monitored::Scalar("EF_MEy_lin", toLinGeV(metComponent.mpy) ) );
    monitors.add(Monitored::Scalar("EF_MEz_lin", toLinGeV(metComponent.mpz) ) );
    monitors.add(Monitored::Scalar("EF_MET_lin", toLinGeV(metComponent.met() ) ) );
    monitors.add(Monitored::Scalar("EF_ME_lin", toLinGeV(metComponent.magnitude() ) ) );
    monitors.add(Monitored::Scalar("EF_SumEt_lin", toLinGeV(metComponent.sumEt) ) );
    monitors.add(Monitored::Scalar("EF_SumE_lin", toLinGeV(metComponent.sumE) ) );
    monitors.add(Monitored::Scalar(
          "EF_XS", toLinGeV(metComponent.met() ) / toLinGeV(metComponent.sumEt, 1) ) );
    monitors.add(Monitored::Scalar("EF_MET_phi", metComponent.phi() ) );
    return StatusCode::SUCCESS;
  }

msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed ( bool  state, const EventContext &  ctx  ) const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext &  ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

{
  return Gaudi::Algorithm::sysExecute (ctx);
}

sysInitialize()

StatusCode AthReentrantAlgorithm::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< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::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< Gaudi::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< Gaudi::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_absNoiseThreshold

Gaudi::Property<float> HLT::MET::CellFex::m_absNoiseThreshold

private

Initial value:

{
        this, "AbsoluteNoiseThreshold", 2, "Threshold on the magnitude of the "
          "cell energy (as a multiple of the cell noise level). Selection "
          "will not be applied if value is negative"}

The threshold on the magnitude of the cell energy.

Definition at line 79 of file CellFex.h.

m_baseInitialised

bool HLT::MET::FexBase::m_baseInitialised {false}

privateinherited

Whether or not this class has been correctly initialised.

Definition at line 143 of file FexBase.h.

m_caloCellID

const CaloCell_ID* HLT::MET::CellFex::m_caloCellID {nullptr}

private

Fallback option for calo cells which don't have a detector description.

• we can read the information from this object

Definition at line 111 of file CellFex.h.

m_cellsKey

SG::ReadHandleKey<CaloCellContainer> HLT::MET::CellFex::m_cellsKey

private

Initial value:

{
        this, "CellName", "CaloCells", "Collection containing all input cells"}

Input cells.

Definition at line 73 of file CellFex.h.

m_componentNames

std::vector<std::string> HLT::MET::FexBase::m_componentNames

protectedinherited

The names of the output MET components.

Definition at line 72 of file FexBase.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doTwoGaussianNoise

Gaudi::Property<bool> HLT::MET::CellFex::m_doTwoGaussianNoise

private

Initial value:

{
        this, "TwoGaussianNoise", true,
          "Whether to use the 'two-Gaussian' noise calculation for the TileCal"}

Use the 'two-gaussian' noise calculation for the TileCal.

Definition at line 88 of file CellFex.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

m_maxComponentMETSumEtRatio

Gaudi::Property<float> HLT::MET::FexBase::m_maxComponentMETSumEtRatio

privateinherited

Initial value:

{
        "MaxComponentMETSumEtRatio", 1.,
        "The maximum MET/SumEt ratio per component"}

Definition at line 132 of file FexBase.h.

m_maxGlobalMETSumEtRatio

Gaudi::Property<float> HLT::MET::FexBase::m_maxGlobalMETSumEtRatio

privateinherited

Initial value:

{
        "MaxGlobalMETSumEtRatio", 1.,
        "The maximum MET/SumEt ratio for the total value"}

Definition at line 135 of file FexBase.h.

m_metContainerKey

SG::WriteHandleKey<xAOD::TrigMissingETContainer> HLT::MET::FexBase::m_metContainerKey

privateinherited

Initial value:

{
        this, "METContainerKey", "HLT_MET", "Name of the output MET object"}

The output MET object.

Definition at line 127 of file FexBase.h.

m_monTool

ToolHandle<GenericMonitoringTool> HLT::MET::FexBase::m_monTool

privateinherited

Initial value:

{
        this, "MonTool", "", "Monitoring tool"}

The monitoring tool.

Definition at line 130 of file FexBase.h.

m_negNoiseThreshold

Gaudi::Property<float> HLT::MET::CellFex::m_negNoiseThreshold

private

Initial value:

{
        this, "NegativeNoiseThreshold", 5, "The maximum negative cell energy. "
          "Selection will not be applied if value is negative"}

The maximum negative cell energy.

Definition at line 84 of file CellFex.h.

m_noiseCDOKey

SG::ReadCondHandleKey<CaloNoise> HLT::MET::CellFex::m_noiseCDOKey

private

Initial value:

{
        this, "CaloNoiseName","totalNoise","SG Key of CaloNoise data object"}

Calorimeter noise CDO (conditions data object)

Definition at line 76 of file CellFex.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• CellFex.h
• CellFex.cxx