Retrieves ROI objects, default mode uses HLT/Offline object LVL1_ROI::jets_type. More...

#include <JetROIRetriever.h>

Inheritance diagram for JiveXML::JetROIRetriever:

Collaboration diagram for JiveXML::JetROIRetriever:

Public Member Functions
	JetROIRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	Retrieve all the data.
virtual std::string	dataTypeName () const
	Return the name of the data type.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Return the interface identifier.

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
const std::string	m_typeName
	The data type that is generated by this retriever.
bool	m_readJEM
bool	m_maskLowerThresholds
std::string	m_sgKey
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

Retrieves ROI objects, default mode uses HLT/Offline object LVL1_ROI::jets_type.

Retrieves ROI objects, default mode uses HLT/Offline object LVL1_ROI::emtaus_type.

Properties
- readJEM: 'false' by default. If 'true' reads low-level ROI data from L1Calo hardware (for ACR when reading SFI)
Retrieved Data
- eta,phi: coordinates of ROI
- energy: energy in ROI
- roiWord, thrPattern: trigger bitpatterns, undecoded
Properties
- readCPM: 'false' by default. If 'true' reads low-level ROI data from L1Calo hardware (for ACR when reading SFI)
Retrieved Data
- eta,phi: coordinates of ROI
- energy: energy in ROI
- roiWord, thrPattern: trigger bitpatterns, undecoded

Definition at line 33 of file JetROIRetriever.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

◆ JetROIRetriever()

JiveXML::JetROIRetriever::JetROIRetriever	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard Constructor.

Definition at line 20 of file JetROIRetriever.cxx.

                                                                                                        :
    AthAlgTool(type, name, parent),
    m_typeName("JetROI")
  {
 
    declareInterface<IDataRetriever>(this);
    declareProperty("readJEM", m_readJEM=false,"If 'true' reads low-level ROI data from L1Calo hardware. False by default");
    // this could be used to mask the lower 4 of the possible 8 multiplicities
    // to be implemented if necessary
    declareProperty("maskLowerThresholds", m_maskLowerThresholds=false);
  }

Member Function Documentation

◆ dataTypeName()

virtual std::string JiveXML::JetROIRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 44 of file JetROIRetriever.h.

44{ return m_typeName; };

◆ declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

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

const InterfaceID & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

40{ return IID_IDataRetriever; }

JiveXML::IID_IDataRetriever

static const InterfaceID IID_IDataRetriever("JiveXML::IDataRetriever", 3, 0)

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

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

◆ retrieve()

StatusCode JiveXML::JetROIRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

virtual

Retrieve all the data.

Implements JiveXML::IDataRetriever.

Definition at line 34 of file JetROIRetriever.cxx.

                                                                          {
 
  if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << " retrieving" <<
    ( m_readJEM ? " from JEMRoIs (ACR) " : " JetROI (LVL1_ROI) ") << endmsg;
 
  DataVect phi;
  DataVect eta;
  DataVect energy;
  DataVect roiWord;
  DataVect thrPattern;
 
  if (!m_readJEM){ // 'normal' mode: Use Offline EmTauROI object
 
    const LVL1_ROI * roi;
 
    // L1JetObject -not- available
    m_sgKey = "LVL1_ROI";
    if ( evtStore()->retrieve(roi,m_sgKey).isFailure() ) {
      if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) <<  "No LVL1_ROI found in SG for Level-1 JetROI" << endmsg;
      return StatusCode::SUCCESS;
    } 
 
    // Access as in: PhysicsAnalysis/AnalysisCommon/AnalysisTest/ReadTrigg
    // Tested with: AODTriggerRead_topOptions.py
 
    LVL1_ROI::jets_type::const_iterator itJET  = (roi->getJetROIs()).begin();
    LVL1_ROI::jets_type::const_iterator itJETe = (roi->getJetROIs()).end();
 
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "JetROIs from LVL1_ROI retrieved from StoreGate with size: "<< (roi->getJetROIs()).size() <<endmsg;
 
    for (; itJET != itJETe; ++itJET)
        {
        phi.push_back(DataType( itJET->getPhi()));
    eta.push_back(DataType( itJET->getEta()));
 
// info from Alan Watson: pT is getET8x8();
//        energy.push_back(DataType(  itJET->pt()/1000. ));
        energy.push_back(DataType( itJET->getET4x4()/1000. )); 
 
        roiWord.push_back(DataType( itJET->getROIWord()));
    thrPattern.push_back(DataType( itJET->getThrPattern()));
      }
 
  }else{ // readJEM mode: decode bits from JEM into eta,phi, for ACR data from SFI  
 
    const DataVector<LVL1::JEMRoI>* jemRoICollection = 0;
    LVL1::JEPRoIDecoder decoder;
    // L1JetObject -not- available
    m_sgKey = "JEMRoIs";
    if ( evtStore()->retrieve(jemRoICollection, m_sgKey).isFailure() ) {
      if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "No DataVector<LVL1::JEMRoI> found with key JEMRoIs" << endmsg;
      return StatusCode::SUCCESS;
    } 
      if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << "DataVector<LVL1::JEMRoI> retrieved from StoreGate with size: "<< jemRoICollection->size() <<endmsg;
 
      DataVector<LVL1::JEMRoI>::const_iterator roi_it = jemRoICollection->begin();
      DataVector<LVL1::JEMRoI>::const_iterator roi_end = jemRoICollection->end();
    
      for(;roi_it!=roi_end;++roi_it) {
        const LVL1::JEMRoI* roi = (*roi_it);
 
        // different coordinates in phi, correct for this:
        auto fixphi = [] (double phi)
        {
          if (phi > M_PI) return phi - 2*M_PI;
          return phi;
        };
 
    const LVL1::CoordinateRange coord(decoder.coordinate(roi->roiWord()));
    const double roiEta = coord.eta();
    const double roiPhi = fixphi (coord.phi());
 
    phi.push_back(DataType( roiPhi ));
    eta.push_back(DataType( roiEta ));
 
         // info from Alan Watson: energy would need to be decoded
     // with jet elements. This will only be implemented if necessary
     //    jpt 19Mar09
     energy.push_back(DataType( 1 ) ); //placeholder
 
     roiWord.push_back(DataType( roi->roiWord() )); 
     thrPattern.push_back(DataType( roi->hits() )); 
        }
   }//end if readJEM
 
    DataMap myDataMap;
    const auto nPhi = phi.size() ;
    myDataMap["energy"] = energy;
    myDataMap["phi"] = std::move(phi);
    myDataMap["eta"] = std::move(eta);
    myDataMap["energy"] = std::move(energy);
    myDataMap["roiWord"] = std::move(roiWord);
    myDataMap["thrPattern"] = std::move(thrPattern);
  
    if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << dataTypeName() << ": "<< nPhi 
           << " from: " << m_sgKey << endmsg;
 
    //forward data to formating tool
    return FormatTool->AddToEvent(dataTypeName(), m_sgKey, &myDataMap);
  }

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

◆ sysStart()

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

overridevirtualinherited

Handle START transition.

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

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_maskLowerThresholds

bool JiveXML::JetROIRetriever::m_maskLowerThresholds

private

Definition at line 52 of file JetROIRetriever.h.

◆ m_readJEM

bool JiveXML::JetROIRetriever::m_readJEM

private

Definition at line 51 of file JetROIRetriever.h.

◆ m_sgKey

std::string JiveXML::JetROIRetriever::m_sgKey

private

Definition at line 53 of file JetROIRetriever.h.

◆ m_typeName

const std::string JiveXML::JetROIRetriever::m_typeName

private

The data type that is generated by this retriever.

Definition at line 49 of file JetROIRetriever.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

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetROIRetriever()

Member Function Documentation

◆ dataTypeName()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieve()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_maskLowerThresholds

◆ m_readJEM

◆ m_sgKey

◆ m_typeName

◆ m_varHandleArraysDeclared

◆ m_vhka